src/Cockpit/radiostack.hxx

   1 // radiostack.hxx -- class to manage an instance of the radio stack
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 //
   5 // Copyright (C) 2000  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_RADIOSTACK_HXX
  25 #define _FG_RADIOSTACK_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
  42 class FGRadioStack : public FGSubsystem
  43 {
  44     FGBeacon beacon;
  45     FGMorse morse;
  46
  47     SGInterpTable *term_tbl;
  48     SGInterpTable *low_tbl;
  49     SGInterpTable *high_tbl;
  50
  51     SGPropertyNode *lon_node;
  52     SGPropertyNode *lat_node;
  53     SGPropertyNode *alt_node;
  54
  55     bool need_update;
  56
  57     string nav1_ident;
  58     string nav1_trans_ident;
  59     bool nav1_valid;
  60     bool nav1_inrange;
  61     bool nav1_has_dme;
  62     bool nav1_has_gs;
  63     bool nav1_loc;
  64     double nav1_freq;
  65     double nav1_alt_freq;
  66     double nav1_radial;
  67     double nav1_sel_radial;
  68     double nav1_loclon;
  69     double nav1_loclat;
  70     double nav1_x;
  71     double nav1_y;
  72     double nav1_z;
  73     double nav1_loc_dist;
  74     double nav1_gslon;
  75     double nav1_gslat;
  76     double nav1_gs_x;
  77     double nav1_gs_y;
  78     double nav1_gs_z;
  79     double nav1_gs_dist;
  80     SGTimeStamp prev_time;
  81     SGTimeStamp curr_time;
  82     double nav1_elev;
  83     double nav1_range;
  84     double nav1_effective_range;
  85     double nav1_heading;
  86     double nav1_target_gs;
  87     double nav1_magvar;
  88     double nav1_vol_btn;
  89     bool nav1_ident_btn;
  90
  91     string nav2_ident;
  92     string nav2_trans_ident;
  93     bool nav2_valid;
  94     bool nav2_inrange;
  95     bool nav2_has_dme;
  96     bool nav2_has_gs;
  97     bool nav2_loc;
  98     double nav2_freq;
  99     double nav2_alt_freq;
 100     double nav2_radial;
 101     double nav2_sel_radial;
 102     double nav2_loclon;
 103     double nav2_loclat;
 104     double nav2_x;
 105     double nav2_y;
 106     double nav2_z;
 107     double nav2_loc_dist;
 108     double nav2_gslon;
 109     double nav2_gslat;
 110     double nav2_gs_x;
 111     double nav2_gs_y;
 112     double nav2_gs_z;
 113     double nav2_gs_dist;
 114     double nav2_elev;
 115     double nav2_range;
 116     double nav2_effective_range;
 117     double nav2_heading;
 118     double nav2_target_gs;
 119     double nav2_magvar;
 120     double nav2_vol_btn;
 121     bool nav2_ident_btn;
 122
 123     bool dme_valid;
 124     bool dme_inrange;
 125     double dme_freq;
 126     double dme_lon;
 127     double dme_lat;
 128     double dme_elev;
 129     double dme_range;
 130     double dme_effective_range;
 131     double dme_x;
 132     double dme_y;
 133     double dme_z;
 134     double dme_dist;
 135     double dme_prev_dist;
 136     double dme_spd;
 137     double dme_ete;
 138     SGTimeStamp dme_last_time;
 139
 140     bool outer_marker;
 141     bool middle_marker;
 142     bool inner_marker;
 143
 144     SGTimeStamp blink;
 145     bool outer_blink;
 146     bool middle_blink;
 147     bool inner_blink;
 148
 149     string adf_ident;
 150     string adf_trans_ident;
 151     bool adf_valid;
 152     bool adf_inrange;
 153     double adf_freq;
 154     double adf_alt_freq;
 155     double adf_rotation;
 156     double adf_lon;
 157     double adf_lat;
 158     double adf_elev;
 159     double adf_range;
 160     double adf_effective_range;
 161     double adf_dist;
 162     double adf_heading;
 163     double adf_x;
 164     double adf_y;
 165     double adf_z;
 166     double adf_vol_btn;
 167     bool adf_ident_btn;
 168
 169     // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 170     double adjustNavRange( double stationElev, double aircraftElev,
 171                            double nominalRange );
 172
 173     // model standard ILS service volumes as per AIM 1-1-9
 174     double adjustILSRange( double stationElev, double aircraftElev,
 175                            double offsetDegrees, double distance );
 176
 177 public:
 178
 179     FGRadioStack();
 180     ~FGRadioStack();
 181
 182     void init ();
 183     void bind ();
 184     void unbind ();
 185     void update ();
 186
 187     // Update nav/adf radios based on current postition
 188     void search ();
 189
 190     // NAV1 Setters
 191     inline void set_nav1_freq( double freq ) {
 192         nav1_freq = freq; need_update = true;
 193     }
 194     inline void set_nav1_alt_freq( double freq ) { nav1_alt_freq = freq; }
 195     inline void set_nav1_sel_radial( double radial ) {
 196         nav1_sel_radial = radial; need_update = true;
 197     }
 198     inline void set_nav1_vol_btn( double val ) {
 199         if ( val < 0.0 ) val = 0.0;
 200         if ( val > 1.0 ) val = 1.0;
 201         nav1_vol_btn = val;
 202     }
 203     inline void set_nav1_ident_btn( bool val ) { nav1_ident_btn = val; }
 204
 205     // NAV2 Setters
 206     inline void set_nav2_freq( double freq ) {
 207         nav2_freq = freq; need_update = true;
 208     }
 209     inline void set_nav2_alt_freq( double freq ) { nav2_alt_freq = freq; }
 210     inline void set_nav2_sel_radial( double radial ) {
 211         nav2_sel_radial = radial; need_update = true;
 212     }
 213     inline void set_nav2_vol_btn( double val ) {
 214         if ( val < 0.0 ) val = 0.0;
 215         if ( val > 1.0 ) val = 1.0;
 216         nav2_vol_btn = val;
 217     }
 218     inline void set_nav2_ident_btn( bool val ) { nav2_ident_btn = val; }
 219
 220     // DME Setters
 221     inline void set_dme_freq (double freq) {
 222         dme_freq = freq; need_update = true;
 223     }
 224
 225     // ADF Setters
 226     inline void set_adf_freq( double freq ) {
 227         adf_freq = freq; need_update = true;
 228     }
 229     inline void set_adf_alt_freq( double freq ) { adf_alt_freq = freq; }
 230     inline void set_adf_rotation( double rot ) { adf_rotation = rot; }
 231     inline void set_adf_vol_btn( double val ) {
 232         if ( val < 0.0 ) val = 0.0;
 233         if ( val > 1.0 ) val = 1.0;
 234         adf_vol_btn = val;
 235     }
 236     inline void set_adf_ident_btn( bool val ) { adf_ident_btn = val; }
 237
 238
 239     // NAV1 Accessors
 240     inline double get_nav1_freq () const { return nav1_freq; }
 241     inline double get_nav1_alt_freq () const { return nav1_alt_freq; }
 242     inline double get_nav1_sel_radial() const { return nav1_sel_radial; }
 243
 244     // NAV2 Accessors
 245     inline double get_nav2_freq () const { return nav2_freq; }
 246     inline double get_nav2_alt_freq () const { return nav2_alt_freq; }
 247     inline double get_nav2_sel_radial() const { return nav2_sel_radial; }
 248
 249     // DME Accessors
 250     inline double get_dme_freq () const { return dme_freq; }
 251
 252     // ADF Accessors
 253     inline double get_adf_freq () const { return adf_freq; }
 254     inline double get_adf_alt_freq () const { return adf_alt_freq; }
 255     inline double get_adf_rotation () const { return adf_rotation; }
 256
 257     // Marker Beacon Accessors
 258     inline bool get_inner_blink () const { return inner_blink; }
 259     inline bool get_middle_blink () const { return middle_blink; }
 260     inline bool get_outer_blink () const { return outer_blink; }
 261
 262     // Calculated values.
 263     inline bool get_nav1_inrange() const { return nav1_inrange; }
 264     bool get_nav1_to_flag () const;
 265     bool get_nav1_from_flag () const;
 266     inline bool get_nav1_has_dme() const { return nav1_has_dme; }
 267     inline bool get_nav1_dme_inrange () const {
 268         return nav1_inrange && nav1_has_dme;
 269     }
 270     inline bool get_nav1_has_gs() const { return nav1_has_gs; }
 271     inline bool get_nav1_loc() const { return nav1_loc; }
 272     inline double get_nav1_loclon() const { return nav1_loclon; }
 273     inline double get_nav1_loclat() const { return nav1_loclat; }
 274     inline double get_nav1_loc_dist() const { return nav1_loc_dist; }
 275     inline double get_nav1_gslon() const { return nav1_gslon; }
 276     inline double get_nav1_gslat() const { return nav1_gslat; }
 277     inline double get_nav1_gs_dist() const { return nav1_gs_dist; }
 278     inline double get_nav1_elev() const { return nav1_elev; }
 279     inline double get_nav1_heading() const { return nav1_heading; }
 280     inline double get_nav1_radial() const { return nav1_radial; }
 281     inline double get_nav1_target_gs() const { return nav1_target_gs; }
 282     inline double get_nav1_magvar() const { return nav1_magvar; }
 283     double get_nav1_heading_needle_deflection() const;
 284     double get_nav1_gs_needle_deflection() const;
 285     inline double get_nav1_vol_btn() const { return nav1_vol_btn; }
 286     inline bool get_nav1_ident_btn() const { return nav1_ident_btn; }
 287
 288     inline bool get_nav2_inrange() const { return nav2_inrange; }
 289     bool get_nav2_to_flag () const;
 290     bool get_nav2_from_flag () const;
 291     inline bool get_nav2_has_dme() const { return nav2_has_dme; }
 292     inline bool get_nav2_dme_inrange () const {
 293         return nav2_inrange && nav2_has_dme;
 294     }
 295     inline bool get_nav2_has_gs() const { return nav2_has_gs; }
 296     inline bool get_nav2_loc() const { return nav2_loc; }
 297     inline double get_nav2_loclon() const { return nav2_loclon; }
 298     inline double get_nav2_loclat() const { return nav2_loclat; }
 299     inline double get_nav2_loc_dist() const { return nav2_loc_dist; }
 300     inline double get_nav2_gslon() const { return nav2_gslon; }
 301     inline double get_nav2_gslat() const { return nav2_gslat; }
 302     inline double get_nav2_gs_dist() const { return nav2_gs_dist; }
 303     inline double get_nav2_elev() const { return nav2_elev; }
 304     inline double get_nav2_heading() const { return nav2_heading; }
 305     inline double get_nav2_radial() const { return nav2_radial; }
 306     inline double get_nav2_target_gs() const { return nav2_target_gs; }
 307     inline double get_nav2_magvar() const { return nav2_magvar; }
 308     double get_nav2_heading_needle_deflection() const;
 309     double get_nav2_gs_needle_deflection() const;
 310     inline double get_nav2_vol_btn() const { return nav2_vol_btn; }
 311     inline bool get_nav2_ident_btn() const { return nav2_ident_btn; }
 312
 313     inline bool get_dme_inrange () const { return dme_inrange; }
 314     inline double get_dme_dist () const { return dme_dist; }
 315     inline double get_dme_spd () const { return dme_spd; }
 316     inline double get_dme_ete () const { return dme_ete; }
 317
 318     inline bool get_adf_inrange() const { return adf_inrange; }
 319     inline double get_adf_lon() const { return adf_lon; }
 320     inline double get_adf_lat() const { return adf_lat; }
 321     inline double get_adf_heading() const { return adf_heading; }
 322     inline double get_adf_vol_btn() const { return adf_vol_btn; }
 323     inline bool get_adf_ident_btn() const { return adf_ident_btn; }
 324 };
 325
 326
 327 extern FGRadioStack *current_radiostack;
 328
 329 #endif // _FG_RADIOSTACK_HXX