src/Cockpit/navcom.hxx

   1 // navcom.hxx -- class to manage a navcom 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_NAVCOM_HXX
  25 #define _FG_NAVCOM_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 FGNavCom : 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 *com_serviceable, *nav_serviceable;
  51     SGPropertyNode *cdi_serviceable, *gs_serviceable, *tofrom_serviceable;
  52
  53     string last_nav_id;
  54     bool last_nav_vor;
  55     int nav_play_count;
  56     time_t nav_last_time;
  57
  58     int index;                  // used for property binding
  59     char nav_fx_name[256];
  60     char dme_fx_name[256];
  61
  62     bool need_update;
  63
  64     bool power_btn;
  65     bool audio_btn;
  66
  67     bool comm_valid;
  68     bool comm_inrange;
  69     double comm_freq;
  70     double comm_alt_freq;
  71     double comm_vol_btn;
  72     bool comm_ident_btn;
  73     double comm_x;
  74     double comm_y;
  75     double comm_z;
  76     double comm_dist;
  77     double comm_elev;
  78     double comm_range;
  79     double comm_effective_range;
  80
  81     string nav_id;
  82     string nav_trans_ident;
  83     bool nav_valid;
  84     bool nav_inrange;
  85     bool nav_has_dme;
  86     bool nav_has_gs;
  87     bool nav_loc;
  88     double nav_freq;
  89     double nav_alt_freq;
  90     double nav_heading;         // true heading to nav station
  91     double nav_radial;          // current radial we are on (taking
  92                                 // into consideration the vor station
  93                                 // alignment which likely doesn't
  94                                 // match the magnetic alignment
  95                                 // exactly.)
  96     double nav_sel_radial;
  97     double nav_target_radial;
  98     double nav_target_radial_true;
  99     double nav_target_auto_hdg;
 100     double nav_loclon;
 101     double nav_loclat;
 102     double nav_x;
 103     double nav_y;
 104     double nav_z;
 105     double nav_loc_dist;
 106     double nav_gslon;
 107     double nav_gslat;
 108     double nav_elev;            // use gs elev if available
 109     double nav_gs_x;
 110     double nav_gs_y;
 111     double nav_gs_z;
 112     sgdVec3 gs_base_vec;
 113     double nav_gs_dist;
 114     double nav_gs_dist_signed;
 115     double nav_gs_rate_of_climb;
 116     SGTimeStamp prev_time;
 117     SGTimeStamp curr_time;
 118     double nav_range;
 119     double nav_effective_range;
 120     double nav_target_gs;
 121     double nav_twist;
 122     double nav_vol_btn;
 123     bool nav_ident_btn;
 124     double horiz_vel;
 125     double last_x;
 126
 127     // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 128     double adjustNavRange( double stationElev, double aircraftElev,
 129                            double nominalRange );
 130
 131     // model standard ILS service volumes as per AIM 1-1-9
 132     double adjustILSRange( double stationElev, double aircraftElev,
 133                            double offsetDegrees, double distance );
 134
 135 public:
 136
 137     FGNavCom();
 138     ~FGNavCom();
 139
 140     void init ();
 141     void bind ();
 142     void unbind ();
 143     void update (double dt);
 144
 145     // Update nav/adf radios based on current postition
 146     void search ();
 147
 148     inline void set_bind_index( int i ) {
 149         index = i;
 150         sprintf( nav_fx_name, "nav%d-vor-ident", index );
 151         sprintf( dme_fx_name, "dme%d-vor-ident", index );
 152     }
 153
 154     // NavCom Setters
 155     inline void set_power_btn( bool val ) { power_btn = val; }
 156     inline void set_audio_btn( bool val ) { audio_btn = val; }
 157
 158     // COMM Setters
 159     inline void set_comm_freq( double freq ) {
 160         comm_freq = freq; need_update = true;
 161     }
 162     inline void set_comm_alt_freq( double freq ) { comm_alt_freq = freq; }
 163     inline void set_comm_vol_btn( double val ) {
 164         if ( val < 0.0 ) val = 0.0;
 165         if ( val > 1.0 ) val = 1.0;
 166         comm_vol_btn = val;
 167     }
 168     inline void set_comm_ident_btn( bool val ) { comm_ident_btn = val; }
 169
 170     // NAV Setters
 171     inline void set_nav_freq( double freq ) {
 172         nav_freq = freq; need_update = true;
 173     }
 174     inline void set_nav_alt_freq( double freq ) { nav_alt_freq = freq; }
 175     inline void set_nav_sel_radial( double radial ) {
 176         nav_sel_radial = radial; need_update = true;
 177     }
 178     inline void set_nav_vol_btn( double val ) {
 179         if ( val < 0.0 ) val = 0.0;
 180         if ( val > 1.0 ) val = 1.0;
 181         nav_vol_btn = val;
 182     }
 183     inline void set_nav_ident_btn( bool val ) { nav_ident_btn = val; }
 184
 185     // NavCom Accessors
 186     inline bool has_power() const {
 187         return power_btn && (bus_power->getDoubleValue() > 1.0);
 188     }
 189     inline bool get_power_btn() const { return power_btn; }
 190     inline bool get_audio_btn() const { return audio_btn; }
 191
 192     // COMM Accessors
 193     inline double get_comm_freq () const { return comm_freq; }
 194     inline double get_comm_alt_freq () const { return comm_alt_freq; }
 195
 196     // NAV Accessors
 197     inline double get_nav_freq () const { return nav_freq; }
 198     inline double get_nav_alt_freq () const { return nav_alt_freq; }
 199     inline double get_nav_sel_radial() const { return nav_sel_radial; }
 200     inline double get_nav_target_radial() const { return nav_target_radial; }
 201     inline double get_nav_target_radial_true() const {
 202         return nav_target_radial_true;
 203     }
 204     inline double get_nav_target_auto_hdg() const {
 205         return nav_target_auto_hdg;
 206     }
 207
 208     // Calculated values.
 209     inline bool get_comm_inrange() const { return comm_inrange; }
 210     inline double get_comm_vol_btn() const { return comm_vol_btn; }
 211     inline bool get_comm_ident_btn() const { return comm_ident_btn; }
 212
 213     inline bool get_nav_inrange() const { return nav_inrange; }
 214     bool get_nav_to_flag () const;
 215     bool get_nav_from_flag () const;
 216     inline bool get_nav_has_dme() const { return nav_has_dme; }
 217     inline bool get_nav_dme_inrange () const {
 218         return nav_inrange && nav_has_dme;
 219     }
 220     inline bool get_nav_has_gs() const { return nav_has_gs; }
 221     inline bool get_nav_loc() const { return nav_loc; }
 222     inline double get_nav_loclon() const { return nav_loclon; }
 223     inline double get_nav_loclat() const { return nav_loclat; }
 224     inline double get_nav_loc_dist() const { return nav_loc_dist; }
 225     inline double get_nav_gslon() const { return nav_gslon; }
 226     inline double get_nav_gslat() const { return nav_gslat; }
 227     inline double get_nav_gs_dist() const { return nav_gs_dist; }
 228     inline double get_nav_gs_dist_signed() const { return nav_gs_dist_signed; }
 229     inline double get_nav_gs_rate_of_climb() const {
 230         return nav_gs_rate_of_climb;
 231     }
 232     inline double get_nav_elev() const { return nav_elev; }
 233     double get_nav_heading() const;
 234     double get_nav_radial() const;
 235     double get_nav_reciprocal_radial() const;
 236     inline double get_nav_target_gs() const { return nav_target_gs; }
 237     inline double get_nav_twist() const { return nav_twist; }
 238     double get_nav_cdi_deflection() const;
 239     double get_nav_cdi_xtrack_error() const;
 240     double get_nav_gs_deflection() const;
 241     inline double get_nav_vol_btn() const { return nav_vol_btn; }
 242     inline bool get_nav_ident_btn() const { return nav_ident_btn; }
 243     inline const char * get_nav_id() const { return nav_id.c_str(); }
 244     inline int get_nav_id_c1() const { return nav_id.c_str()[0]; }
 245     inline int get_nav_id_c2() const { return nav_id.c_str()[1]; }
 246     inline int get_nav_id_c3() const { return nav_id.c_str()[2]; }
 247     inline int get_nav_id_c4() const { return nav_id.c_str()[3]; }
 248 };
 249
 250
 251 #endif // _FG_NAVCOM_HXX