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