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/fgfs.hxx>
  29 #include <Main/fg_props.hxx>
  30
  31 #include <simgear/compiler.h>
  32
  33 #include <simgear/math/interpolater.hxx>
  34 #include <simgear/timing/timestamp.hxx>
  35
  36 #include <Navaids/ilslist.hxx>
  37 #include <Navaids/navlist.hxx>
  38 #include <Sound/beacon.hxx>
  39 #include <Sound/morse.hxx>
  40
  41 class FGNavCom : public FGSubsystem
  42 {
  43     FGBeacon beacon;
  44     FGMorse morse;
  45
  46     SGInterpTable *term_tbl;
  47     SGInterpTable *low_tbl;
  48     SGInterpTable *high_tbl;
  49
  50     SGPropertyNode *lon_node;
  51     SGPropertyNode *lat_node;
  52     SGPropertyNode *alt_node;
  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
  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_radial;
  91     double nav_sel_radial;
  92     double nav_loclon;
  93     double nav_loclat;
  94     double nav_x;
  95     double nav_y;
  96     double nav_z;
  97     double nav_loc_dist;
  98     double nav_gslon;
  99     double nav_gslat;
 100     double nav_gs_x;
 101     double nav_gs_y;
 102     double nav_gs_z;
 103     double nav_gs_dist;
 104     SGTimeStamp prev_time;
 105     SGTimeStamp curr_time;
 106     double nav_elev;
 107     double nav_range;
 108     double nav_effective_range;
 109     double nav_heading;
 110     double nav_target_gs;
 111     double nav_magvar;
 112     double nav_vol_btn;
 113     bool nav_ident_btn;
 114
 115     // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 116     double adjustNavRange( double stationElev, double aircraftElev,
 117                            double nominalRange );
 118
 119     // model standard ILS service volumes as per AIM 1-1-9
 120     double adjustILSRange( double stationElev, double aircraftElev,
 121                            double offsetDegrees, double distance );
 122
 123 public:
 124
 125     FGNavCom();
 126     ~FGNavCom();
 127
 128     void init ();
 129     void bind ();
 130     void unbind ();
 131     void update (double dt);
 132
 133     // Update nav/adf radios based on current postition
 134     void search ();
 135
 136     inline void set_bind_index( int i ) {
 137         index = i;
 138         sprintf( nav_fx_name, "nav%d-vor-ident", index );
 139         sprintf( dme_fx_name, "dme%d-vor-ident", index );
 140     }
 141
 142     // NavCom Setters
 143     inline void set_power_btn( bool val ) {
 144         power_btn = val;
 145
 146     }
 147
 148     // COMM Setters
 149     inline void set_comm_freq( double freq ) {
 150         comm_freq = freq; need_update = true;
 151     }
 152     inline void set_comm_alt_freq( double freq ) { comm_alt_freq = freq; }
 153     inline void set_comm_vol_btn( double val ) {
 154         if ( val < 0.0 ) val = 0.0;
 155         if ( val > 1.0 ) val = 1.0;
 156         comm_vol_btn = val;
 157     }
 158     inline void set_comm_ident_btn( bool val ) { comm_ident_btn = val; }
 159
 160     // NAV Setters
 161     inline void set_nav_freq( double freq ) {
 162         nav_freq = freq; need_update = true;
 163     }
 164     inline void set_nav_alt_freq( double freq ) { nav_alt_freq = freq; }
 165     inline void set_nav_sel_radial( double radial ) {
 166         nav_sel_radial = radial; need_update = true;
 167     }
 168     inline void set_nav_vol_btn( double val ) {
 169         if ( val < 0.0 ) val = 0.0;
 170         if ( val > 1.0 ) val = 1.0;
 171         nav_vol_btn = val;
 172     }
 173     inline void set_nav_ident_btn( bool val ) { nav_ident_btn = val; }
 174
 175     // NavCom Accessors
 176     inline bool get_power_btn() const { return power_btn; }
 177
 178     // COMM Accessors
 179     inline double get_comm_freq () const { return comm_freq; }
 180     inline double get_comm_alt_freq () const { return comm_alt_freq; }
 181
 182     // NAV Accessors
 183     inline double get_nav_freq () const { return nav_freq; }
 184     inline double get_nav_alt_freq () const { return nav_alt_freq; }
 185     inline double get_nav_sel_radial() const { return nav_sel_radial; }
 186
 187     // Calculated values.
 188     inline bool get_comm_inrange() const { return comm_inrange; }
 189     inline double get_comm_vol_btn() const { return comm_vol_btn; }
 190     inline bool get_comm_ident_btn() const { return comm_ident_btn; }
 191
 192     inline bool get_nav_inrange() const { return nav_inrange; }
 193     bool get_nav_to_flag () const;
 194     bool get_nav_from_flag () const;
 195     inline bool get_nav_has_dme() const { return nav_has_dme; }
 196     inline bool get_nav_dme_inrange () const {
 197         return nav_inrange && nav_has_dme;
 198     }
 199     inline bool get_nav_has_gs() const { return nav_has_gs; }
 200     inline bool get_nav_loc() const { return nav_loc; }
 201     inline double get_nav_loclon() const { return nav_loclon; }
 202     inline double get_nav_loclat() const { return nav_loclat; }
 203     inline double get_nav_loc_dist() const { return nav_loc_dist; }
 204     inline double get_nav_gslon() const { return nav_gslon; }
 205     inline double get_nav_gslat() const { return nav_gslat; }
 206     inline double get_nav_gs_dist() const { return nav_gs_dist; }
 207     inline double get_nav_elev() const { return nav_elev; }
 208     inline double get_nav_heading() const { return nav_heading; }
 209     inline double get_nav_radial() const { return nav_radial; }
 210     inline double get_nav_target_gs() const { return nav_target_gs; }
 211     inline double get_nav_magvar() const { return nav_magvar; }
 212     double get_nav_heading_needle_deflection() const;
 213     double get_nav_gs_needle_deflection() const;
 214     inline double get_nav_vol_btn() const { return nav_vol_btn; }
 215     inline bool get_nav_ident_btn() const { return nav_ident_btn; }
 216 };
 217
 218
 219 #endif // _FG_NAVCOM_HXX