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