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