Merge branch 'next' into navaids-radio

[flightgear.git] / src / Radio / antenna.hxx

diff --git a/src/Radio/antenna.hxx b/src/Radio/antenna.hxx
index 0421a7f0cccb0c0220025390685b55685adb6277..55247e61e94b895abac0ef077f0f3d8cd7d60a1c 100644 (file)
--- a/src/Radio/antenna.hxx
+++ b/src/Radio/antenna.hxx
@@ -1,6 +1,6 @@
 // antenna.hxx -- FGRadioAntenna: class to represent antenna properties
 //
-// Written by Adrian Musceac, started December 2011.
+// Written by Adrian Musceac YO8RZZ, started December 2011.
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
@@ -32,8 +32,16 @@ using std::string;
 class FGRadioAntenna
 {
 private:
-       void load_antenna_pattern(string type);
-       int _mirror_y;
+       
+/*** load external plot file generated by NEC2. needs to have a txt extension
+*      when naming plots, use the following scheme: type_frequencyMHz.txt
+*      eg: yagi_110.txt or LPDA_333.txt
+*      @param: name of file
+*      @return: none
+***/
+       void load_NEC_antenna_pattern(string type);
+       
+       int _mirror_y;  
        int _mirror_z;
        int _invert_ground;
        double _heading_deg;
@@ -51,7 +59,14 @@ public:
        
        FGRadioAntenna(string type);
     ~FGRadioAntenna();
+
+/*** calculate far-field antenna gain on a 3D volume around it
+*      @param: bearing to the other station, vertical angle (some call it theta)
+*      @return: gain relative to maximum normalized gain. will be negative in all cases
+***/
        double calculate_gain(double bearing, double angle);
-       void set_heading(double heading_deg) {_heading_deg = heading_deg ;};
-       void set_elevation_angle(double elevation_angle_deg) {_elevation_angle_deg = elevation_angle_deg ;};
+       
+       /// some convenience setters and getters (unused for now)
+       inline void set_heading(double heading_deg) {_heading_deg = heading_deg ;};
+       inline void set_elevation_angle(double elevation_angle_deg) {_elevation_angle_deg = elevation_angle_deg ;};
 };