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