src/Instrumentation/navradio.hxx

   1 // navradio.hxx -- class to manage a nav radio instance
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 //
   5 // Copyright (C) 2000 - 2002  Curtis L. Olson - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _FG_NAVRADIO_HXX
  25 #define _FG_NAVRADIO_HXX
  26
  27
  28 #include <Main/fg_props.hxx>
  29
  30 #include <simgear/compiler.h>
  31 #include <simgear/structure/subsystem_mgr.hxx>
  32 #include <simgear/math/interpolater.hxx>
  33 #include <simgear/timing/timestamp.hxx>
  34
  35 #include <Navaids/navlist.hxx>
  36 #include <Sound/morse.hxx>
  37
  38 class FGNavRadio : public SGSubsystem
  39 {
  40     FGMorse morse;
  41
  42     SGInterpTable *term_tbl;
  43     SGInterpTable *low_tbl;
  44     SGInterpTable *high_tbl;
  45
  46     SGPropertyNode *lon_node;
  47     SGPropertyNode *lat_node;
  48     SGPropertyNode *alt_node;
  49     SGPropertyNode *bus_power;
  50     SGPropertyNode *nav_serviceable;
  51     SGPropertyNode *cdi_serviceable, *gs_serviceable, *tofrom_serviceable;
  52     SGPropertyNode *nav_slaved_to_gps;
  53     SGPropertyNode *gps_cdi_deflection, *gps_to_flag;
  54
  55     string last_nav_id;
  56     bool last_nav_vor;
  57     int nav_play_count;
  58     time_t nav_last_time;
  59
  60     int index;                  // used for property binding
  61     string nav_fx_name;
  62     string dme_fx_name;
  63
  64     bool need_update;
  65
  66     bool power_btn;
  67     bool audio_btn;
  68
  69     string nav_id;
  70     string nav_trans_ident;
  71     bool nav_valid;
  72     bool nav_inrange;
  73     bool nav_has_dme;
  74     bool nav_has_gs;
  75     bool nav_loc;
  76     double nav_freq;
  77     double nav_alt_freq;
  78     string fmt_freq;            // formated frequency
  79     string fmt_alt_freq;        // formated alternate frequency
  80     double nav_heading;         // true heading to nav station
  81     double nav_radial;          // current radial we are on (taking
  82                                 // into consideration the vor station
  83                                 // alignment which likely doesn't
  84                                 // match the magnetic alignment
  85                                 // exactly.)
  86     double nav_sel_radial;
  87     double nav_target_radial;
  88     double nav_target_radial_true;
  89     double nav_target_auto_hdg;
  90     double nav_loclon;
  91     double nav_loclat;
  92     double nav_x;
  93     double nav_y;
  94     double nav_z;
  95     double nav_loc_dist;
  96     double nav_gslon;
  97     double nav_gslat;
  98     double nav_elev;            // use gs elev if available
  99     double nav_gs_x;
 100     double nav_gs_y;
 101     double nav_gs_z;
 102     sgdVec3 gs_base_vec;
 103     double nav_gs_dist;
 104     double nav_gs_dist_signed;
 105     double nav_gs_rate_of_climb;
 106     SGTimeStamp prev_time;
 107     SGTimeStamp curr_time;
 108     double nav_range;
 109     double nav_effective_range;
 110     double nav_target_gs;
 111     double nav_twist;
 112     double nav_vol_btn;
 113     bool nav_ident_btn;
 114     double horiz_vel;
 115     double last_x;
 116
 117     string name;
 118     int num;
 119
 120     // internal periodic station search timer
 121     double _time_before_search_sec;
 122
 123     // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 124     double adjustNavRange( double stationElev, double aircraftElev,
 125                            double nominalRange );
 126
 127     // model standard ILS service volumes as per AIM 1-1-9
 128     double adjustILSRange( double stationElev, double aircraftElev,
 129                            double offsetDegrees, double distance );
 130
 131 public:
 132
 133     FGNavRadio(SGPropertyNode *node);
 134     ~FGNavRadio();
 135
 136     void init ();
 137     void bind ();
 138     void unbind ();
 139     void update (double dt);
 140
 141     // Update nav/adf radios based on current postition
 142     void search ();
 143 /*
 144     inline void set_bind_index( int i ) {
 145         index = i;
 146         sprintf( nav_fx_name, "nav%d-vor-ident", index );
 147         sprintf( dme_fx_name, "dme%d-vor-ident", index );
 148     }
 149 */
 150
 151     // NavCom Setters
 152     inline void set_power_btn( bool val ) { power_btn = val; }
 153     inline void set_audio_btn( bool val ) { audio_btn = val; }
 154
 155     // NAV Setters
 156     inline void set_nav_freq( double freq ) {
 157         nav_freq = freq; need_update = true;
 158     }
 159     inline void set_fmt_freq( const char *freq ) { fmt_freq = freq; }
 160     inline void set_nav_alt_freq( double freq ) { nav_alt_freq = freq; }
 161     inline void set_fmt_alt_freq( const char *freq ) { fmt_alt_freq = freq; }
 162     inline void set_nav_sel_radial( double radial ) {
 163         nav_sel_radial = radial; need_update = true;
 164     }
 165     inline void set_nav_vol_btn( double val ) {
 166         if ( val < 0.0 ) val = 0.0;
 167         if ( val > 1.0 ) val = 1.0;
 168         nav_vol_btn = val;
 169     }
 170     inline void set_nav_ident_btn( bool val ) { nav_ident_btn = val; }
 171
 172     // NavCom Accessors
 173     inline bool has_power() const {
 174         return power_btn && (bus_power->getDoubleValue() > 1.0);
 175     }
 176     inline bool get_power_btn() const { return power_btn; }
 177     inline bool get_audio_btn() const { return audio_btn; }
 178
 179     // NAV Accessors
 180     inline double get_nav_freq () const { return nav_freq; }
 181     inline const char *get_fmt_freq () const { return fmt_freq.c_str(); }
 182     inline double get_nav_alt_freq () const { return nav_alt_freq; }
 183     inline const char *get_fmt_alt_freq () const {
 184         return fmt_alt_freq.c_str();
 185     }
 186     inline double get_nav_sel_radial() const { return nav_sel_radial; }
 187     inline double get_nav_target_radial() const { return nav_target_radial; }
 188     inline double get_nav_target_radial_true() const {
 189         return nav_target_radial_true;
 190     }
 191     inline double get_nav_target_auto_hdg() const {
 192         return nav_target_auto_hdg;
 193     }
 194
 195     // Calculated values.
 196     inline bool get_nav_inrange() const { return nav_inrange; }
 197     bool get_nav_to_flag () const;
 198     bool get_nav_from_flag () const;
 199     inline bool get_nav_has_dme() const { return nav_has_dme; }
 200     inline bool get_nav_dme_inrange () const {
 201         return nav_inrange && nav_has_dme;
 202     }
 203     inline bool get_nav_has_gs() const { return nav_has_gs; }
 204     inline bool get_nav_loc() const { return nav_loc; }
 205     inline double get_nav_loclon() const { return nav_loclon; }
 206     inline double get_nav_loclat() const { return nav_loclat; }
 207     inline double get_nav_loc_dist() const { return nav_loc_dist; }
 208     inline double get_nav_gslon() const { return nav_gslon; }
 209     inline double get_nav_gslat() const { return nav_gslat; }
 210     inline double get_nav_gs_dist() const { return nav_gs_dist; }
 211     inline double get_nav_gs_dist_signed() const { return nav_gs_dist_signed; }
 212     inline double get_nav_gs_rate_of_climb() const {
 213         return nav_gs_rate_of_climb;
 214     }
 215     inline double get_nav_elev() const { return nav_elev; }
 216     double get_nav_heading() const;
 217     double get_nav_radial() const;
 218     double get_nav_reciprocal_radial() const;
 219     inline double get_nav_target_gs() const { return nav_target_gs; }
 220     inline double get_nav_twist() const { return nav_twist; }
 221     double get_nav_cdi_deflection() const;
 222     double get_nav_cdi_xtrack_error() const;
 223     double get_nav_gs_deflection() const;
 224     inline double get_nav_vol_btn() const { return nav_vol_btn; }
 225     inline bool get_nav_ident_btn() const { return nav_ident_btn; }
 226     inline const char * get_nav_id() const { return nav_id.c_str(); }
 227     inline int get_nav_id_c1() const { return nav_id.c_str()[0]; }
 228     inline int get_nav_id_c2() const { return nav_id.c_str()[1]; }
 229     inline int get_nav_id_c3() const { return nav_id.c_str()[2]; }
 230     inline int get_nav_id_c4() const { return nav_id.c_str()[3]; }
 231 };
 232
 233
 234 #endif // _FG_NAVRADIO_HXX