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 <ATC/atislist.hxx>
  39 #include <Sound/beacon.hxx>
  40 #include <Sound/morse.hxx>
  41
  42
  43 class FGRadioStack : public FGSubsystem
  44 {
  45     FGBeacon beacon;
  46     FGMorse morse;
  47
  48     SGInterpTable *term_tbl;
  49     SGInterpTable *low_tbl;
  50     SGInterpTable *high_tbl;
  51
  52     SGPropertyNode *lon_node;
  53     SGPropertyNode *lat_node;
  54     SGPropertyNode *alt_node;
  55
  56     bool need_update;
  57
  58     FGATIS atis;
  59
  60     string comm1_ident;
  61     bool comm1_valid;
  62     bool comm1_inrange;
  63     double comm1_freq;
  64     double comm1_alt_freq;
  65     double comm1_vol_btn;
  66     bool comm1_ident_btn;
  67     double comm1_x;
  68     double comm1_y;
  69     double comm1_z;
  70     double comm1_dist;
  71     double comm1_elev;
  72     double comm1_range;
  73     double comm1_effective_range;
  74
  75     string comm2_ident;
  76     bool comm2_valid;
  77     bool comm2_inrange;
  78     double comm2_freq;
  79     double comm2_alt_freq;
  80     double comm2_vol_btn;
  81     bool comm2_ident_btn;
  82     double comm2_x;
  83     double comm2_y;
  84     double comm2_z;
  85     double comm2_dist;
  86     double comm2_elev;
  87     double comm2_range;
  88     double comm2_effective_range;
  89
  90     string nav1_ident;
  91     string nav1_trans_ident;
  92     bool nav1_valid;
  93     bool nav1_inrange;
  94     bool nav1_has_dme;
  95     bool nav1_has_gs;
  96     bool nav1_loc;
  97     double nav1_freq;
  98     double nav1_alt_freq;
  99     double nav1_radial;
 100     double nav1_sel_radial;
 101     double nav1_loclon;
 102     double nav1_loclat;
 103     double nav1_x;
 104     double nav1_y;
 105     double nav1_z;
 106     double nav1_loc_dist;
 107     double nav1_gslon;
 108     double nav1_gslat;
 109     double nav1_gs_x;
 110     double nav1_gs_y;
 111     double nav1_gs_z;
 112     double nav1_gs_dist;
 113     SGTimeStamp prev_time;
 114     SGTimeStamp curr_time;
 115     double nav1_elev;
 116     double nav1_range;
 117     double nav1_effective_range;
 118     double nav1_heading;
 119     double nav1_target_gs;
 120     double nav1_magvar;
 121     double nav1_vol_btn;
 122     bool nav1_ident_btn;
 123
 124     string nav2_ident;
 125     string nav2_trans_ident;
 126     bool nav2_valid;
 127     bool nav2_inrange;
 128     bool nav2_has_dme;
 129     bool nav2_has_gs;
 130     bool nav2_loc;
 131     double nav2_freq;
 132     double nav2_alt_freq;
 133     double nav2_radial;
 134     double nav2_sel_radial;
 135     double nav2_loclon;
 136     double nav2_loclat;
 137     double nav2_x;
 138     double nav2_y;
 139     double nav2_z;
 140     double nav2_loc_dist;
 141     double nav2_gslon;
 142     double nav2_gslat;
 143     double nav2_gs_x;
 144     double nav2_gs_y;
 145     double nav2_gs_z;
 146     double nav2_gs_dist;
 147     double nav2_elev;
 148     double nav2_range;
 149     double nav2_effective_range;
 150     double nav2_heading;
 151     double nav2_target_gs;
 152     double nav2_magvar;
 153     double nav2_vol_btn;
 154     bool nav2_ident_btn;
 155
 156     bool dme_valid;
 157     bool dme_inrange;
 158     double dme_freq;
 159     double dme_lon;
 160     double dme_lat;
 161     double dme_elev;
 162     double dme_range;
 163     double dme_effective_range;
 164     double dme_x;
 165     double dme_y;
 166     double dme_z;
 167     double dme_dist;
 168     double dme_prev_dist;
 169     double dme_spd;
 170     double dme_ete;
 171     SGTimeStamp dme_last_time;
 172
 173     bool outer_marker;
 174     bool middle_marker;
 175     bool inner_marker;
 176
 177     SGTimeStamp blink;
 178     bool outer_blink;
 179     bool middle_blink;
 180     bool inner_blink;
 181
 182     string adf_ident;
 183     string adf_trans_ident;
 184     bool adf_valid;
 185     bool adf_inrange;
 186     double adf_freq;
 187     double adf_alt_freq;
 188     double adf_rotation;
 189     double adf_lon;
 190     double adf_lat;
 191     double adf_elev;
 192     double adf_range;
 193     double adf_effective_range;
 194     double adf_dist;
 195     double adf_heading;
 196     double adf_x;
 197     double adf_y;
 198     double adf_z;
 199     double adf_vol_btn;
 200     bool adf_ident_btn;
 201
 202     // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 203     double adjustNavRange( double stationElev, double aircraftElev,
 204                            double nominalRange );
 205
 206     // model standard ILS service volumes as per AIM 1-1-9
 207     double adjustILSRange( double stationElev, double aircraftElev,
 208                            double offsetDegrees, double distance );
 209
 210 public:
 211
 212     FGRadioStack();
 213     ~FGRadioStack();
 214
 215     void init ();
 216     void bind ();
 217     void unbind ();
 218     void update ();
 219
 220     // Update nav/adf radios based on current postition
 221     void search ();
 222
 223     // COMM1 Setters
 224     inline void set_comm1_freq( double freq ) {
 225         comm1_freq = freq; need_update = true;
 226     }
 227     inline void set_comm1_alt_freq( double freq ) { comm1_alt_freq = freq; }
 228     inline void set_comm1_vol_btn( double val ) {
 229         if ( val < 0.0 ) val = 0.0;
 230         if ( val > 1.0 ) val = 1.0;
 231         comm1_vol_btn = val;
 232     }
 233     inline void set_comm1_ident_btn( bool val ) { comm1_ident_btn = val; }
 234
 235     // COMM2 Setters
 236     inline void set_comm2_freq( double freq ) {
 237         comm2_freq = freq; need_update = true;
 238     }
 239     inline void set_comm2_alt_freq( double freq ) { comm2_alt_freq = freq; }
 240     inline void set_comm2_vol_btn( double val ) {
 241         if ( val < 0.0 ) val = 0.0;
 242         if ( val > 1.0 ) val = 1.0;
 243         comm2_vol_btn = val;
 244     }
 245     inline void set_comm2_ident_btn( bool val ) { comm2_ident_btn = val; }
 246
 247     // NAV1 Setters
 248     inline void set_nav1_freq( double freq ) {
 249         nav1_freq = freq; need_update = true;
 250     }
 251     inline void set_nav1_alt_freq( double freq ) { nav1_alt_freq = freq; }
 252     inline void set_nav1_sel_radial( double radial ) {
 253         nav1_sel_radial = radial; need_update = true;
 254     }
 255     inline void set_nav1_vol_btn( double val ) {
 256         if ( val < 0.0 ) val = 0.0;
 257         if ( val > 1.0 ) val = 1.0;
 258         nav1_vol_btn = val;
 259     }
 260     inline void set_nav1_ident_btn( bool val ) { nav1_ident_btn = val; }
 261
 262     // NAV2 Setters
 263     inline void set_nav2_freq( double freq ) {
 264         nav2_freq = freq; need_update = true;
 265     }
 266     inline void set_nav2_alt_freq( double freq ) { nav2_alt_freq = freq; }
 267     inline void set_nav2_sel_radial( double radial ) {
 268         nav2_sel_radial = radial; need_update = true;
 269     }
 270     inline void set_nav2_vol_btn( double val ) {
 271         if ( val < 0.0 ) val = 0.0;
 272         if ( val > 1.0 ) val = 1.0;
 273         nav2_vol_btn = val;
 274     }
 275     inline void set_nav2_ident_btn( bool val ) { nav2_ident_btn = val; }
 276
 277     // DME Setters
 278     inline void set_dme_freq (double freq) {
 279         dme_freq = freq; need_update = true;
 280     }
 281
 282     // ADF Setters
 283     inline void set_adf_freq( double freq ) {
 284         adf_freq = freq; need_update = true;
 285     }
 286     inline void set_adf_alt_freq( double freq ) { adf_alt_freq = freq; }
 287     inline void set_adf_rotation( double rot ) { adf_rotation = rot; }
 288     inline void set_adf_vol_btn( double val ) {
 289         if ( val < 0.0 ) val = 0.0;
 290         if ( val > 1.0 ) val = 1.0;
 291         adf_vol_btn = val;
 292     }
 293     inline void set_adf_ident_btn( bool val ) { adf_ident_btn = val; }
 294
 295     // COMM1 Accessors
 296     inline double get_comm1_freq () const { return comm1_freq; }
 297     inline double get_comm1_alt_freq () const { return comm1_alt_freq; }
 298
 299     // COMM2 Accessors
 300     inline double get_comm2_freq () const { return comm2_freq; }
 301     inline double get_comm2_alt_freq () const { return comm2_alt_freq; }
 302
 303     // NAV1 Accessors
 304     inline double get_nav1_freq () const { return nav1_freq; }
 305     inline double get_nav1_alt_freq () const { return nav1_alt_freq; }
 306     inline double get_nav1_sel_radial() const { return nav1_sel_radial; }
 307
 308     // NAV2 Accessors
 309     inline double get_nav2_freq () const { return nav2_freq; }
 310     inline double get_nav2_alt_freq () const { return nav2_alt_freq; }
 311     inline double get_nav2_sel_radial() const { return nav2_sel_radial; }
 312
 313     // DME Accessors
 314     inline double get_dme_freq () const { return dme_freq; }
 315
 316     // ADF Accessors
 317     inline double get_adf_freq () const { return adf_freq; }
 318     inline double get_adf_alt_freq () const { return adf_alt_freq; }
 319     inline double get_adf_rotation () const { return adf_rotation; }
 320
 321     // Marker Beacon Accessors
 322     inline bool get_inner_blink () const { return inner_blink; }
 323     inline bool get_middle_blink () const { return middle_blink; }
 324     inline bool get_outer_blink () const { return outer_blink; }
 325
 326     // Calculated values.
 327     inline bool get_comm1_inrange() const { return comm1_inrange; }
 328     inline double get_comm1_vol_btn() const { return comm1_vol_btn; }
 329     inline bool get_comm1_ident_btn() const { return comm1_ident_btn; }
 330
 331     inline bool get_comm2_inrange() const { return comm2_inrange; }
 332     inline double get_comm2_vol_btn() const { return comm2_vol_btn; }
 333     inline bool get_comm2_ident_btn() const { return comm2_ident_btn; }
 334
 335     inline bool get_nav1_inrange() const { return nav1_inrange; }
 336     bool get_nav1_to_flag () const;
 337     bool get_nav1_from_flag () const;
 338     inline bool get_nav1_has_dme() const { return nav1_has_dme; }
 339     inline bool get_nav1_dme_inrange () const {
 340         return nav1_inrange && nav1_has_dme;
 341     }
 342     inline bool get_nav1_has_gs() const { return nav1_has_gs; }
 343     inline bool get_nav1_loc() const { return nav1_loc; }
 344     inline double get_nav1_loclon() const { return nav1_loclon; }
 345     inline double get_nav1_loclat() const { return nav1_loclat; }
 346     inline double get_nav1_loc_dist() const { return nav1_loc_dist; }
 347     inline double get_nav1_gslon() const { return nav1_gslon; }
 348     inline double get_nav1_gslat() const { return nav1_gslat; }
 349     inline double get_nav1_gs_dist() const { return nav1_gs_dist; }
 350     inline double get_nav1_elev() const { return nav1_elev; }
 351     inline double get_nav1_heading() const { return nav1_heading; }
 352     inline double get_nav1_radial() const { return nav1_radial; }
 353     inline double get_nav1_target_gs() const { return nav1_target_gs; }
 354     inline double get_nav1_magvar() const { return nav1_magvar; }
 355     double get_nav1_heading_needle_deflection() const;
 356     double get_nav1_gs_needle_deflection() const;
 357     inline double get_nav1_vol_btn() const { return nav1_vol_btn; }
 358     inline bool get_nav1_ident_btn() const { return nav1_ident_btn; }
 359
 360     inline bool get_nav2_inrange() const { return nav2_inrange; }
 361     bool get_nav2_to_flag () const;
 362     bool get_nav2_from_flag () const;
 363     inline bool get_nav2_has_dme() const { return nav2_has_dme; }
 364     inline bool get_nav2_dme_inrange () const {
 365         return nav2_inrange && nav2_has_dme;
 366     }
 367     inline bool get_nav2_has_gs() const { return nav2_has_gs; }
 368     inline bool get_nav2_loc() const { return nav2_loc; }
 369     inline double get_nav2_loclon() const { return nav2_loclon; }
 370     inline double get_nav2_loclat() const { return nav2_loclat; }
 371     inline double get_nav2_loc_dist() const { return nav2_loc_dist; }
 372     inline double get_nav2_gslon() const { return nav2_gslon; }
 373     inline double get_nav2_gslat() const { return nav2_gslat; }
 374     inline double get_nav2_gs_dist() const { return nav2_gs_dist; }
 375     inline double get_nav2_elev() const { return nav2_elev; }
 376     inline double get_nav2_heading() const { return nav2_heading; }
 377     inline double get_nav2_radial() const { return nav2_radial; }
 378     inline double get_nav2_target_gs() const { return nav2_target_gs; }
 379     inline double get_nav2_magvar() const { return nav2_magvar; }
 380     double get_nav2_heading_needle_deflection() const;
 381     double get_nav2_gs_needle_deflection() const;
 382     inline double get_nav2_vol_btn() const { return nav2_vol_btn; }
 383     inline bool get_nav2_ident_btn() const { return nav2_ident_btn; }
 384
 385     inline bool get_dme_inrange () const { return dme_inrange; }
 386     inline double get_dme_dist () const { return dme_dist; }
 387     inline double get_dme_spd () const { return dme_spd; }
 388     inline double get_dme_ete () const { return dme_ete; }
 389
 390     inline bool get_adf_inrange() const { return adf_inrange; }
 391     inline double get_adf_lon() const { return adf_lon; }
 392     inline double get_adf_lat() const { return adf_lat; }
 393     inline double get_adf_heading() const { return adf_heading; }
 394     inline double get_adf_vol_btn() const { return adf_vol_btn; }
 395     inline bool get_adf_ident_btn() const { return adf_ident_btn; }
 396 };
 397
 398
 399 extern FGRadioStack *current_radiostack;
 400
 401 #endif // _FG_RADIOSTACK_HXX