src/Radio/antenna.hxx

   1 // antenna.hxx -- FGRadioAntenna: class to represent antenna properties
   2 //
   3 // Written by Adrian Musceac YO8RZZ, started December 2011.
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18
  19 #ifndef __cplusplus
  20 # error This library requires C++
  21 #endif
  22
  23 #include <simgear/compiler.h>
  24 #include <simgear/structure/subsystem_mgr.hxx>
  25 #include <Main/fg_props.hxx>
  26
  27 #include <simgear/math/sg_geodesy.hxx>
  28 #include <simgear/debug/logstream.hxx>
  29
  30 using std::string;
  31
  32 class FGRadioAntenna
  33 {
  34 private:
  35
  36 /*** load external plot file generated by NEC2. needs to have a txt extension
  37 *       when naming plots, use the following scheme: type_frequencyMHz.txt
  38 *       eg: yagi_110.txt or LPDA_333.txt
  39 *       @param: name of file
  40 *       @return: none
  41 ***/
  42         void load_NEC_antenna_pattern(string type);
  43
  44         int _mirror_y;
  45         int _mirror_z;
  46         int _invert_ground;
  47         double _heading_deg;
  48         double _elevation_angle_deg;
  49         struct AntennaGain {
  50                 double azimuth;
  51                 double elevation;
  52                 double gain;
  53         };
  54         SGPath _pattern_file;
  55         typedef std::vector<AntennaGain*> AntennaPattern;
  56         AntennaPattern _pattern;
  57
  58 public:
  59
  60         FGRadioAntenna(string type);
  61     ~FGRadioAntenna();
  62
  63 /*** calculate far-field antenna gain on a 3D volume around it
  64 *       @param: bearing to the other station, vertical angle (some call it theta)
  65 *       @return: gain relative to maximum normalized gain. will be negative in all cases
  66 ***/
  67         double calculate_gain(double bearing, double angle);
  68
  69         /// some convenience setters and getters (unused for now)
  70         inline void set_heading(double heading_deg) {_heading_deg = heading_deg ;};
  71         inline void set_elevation_angle(double elevation_angle_deg) {_elevation_angle_deg = elevation_angle_deg ;};
  72 };