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