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 *lat_node;
  52     SGPropertyNode *lon_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     double nav1_dmelon;
  81     double nav1_dmelat;
  82     double nav1_dme_x;
  83     double nav1_dme_y;
  84     double nav1_dme_z;
  85     double nav1_dme_dist;
  86     double nav1_elev;
  87     double nav1_range;
  88     double nav1_effective_range;
  89     double nav1_heading;
  90     double nav1_target_gs;
  91     double nav1_magvar;
  92     double nav1_vol_btn;
  93     bool nav1_ident_btn;
  94
  95     string nav2_ident;
  96     string nav2_trans_ident;
  97     bool nav2_valid;
  98     bool nav2_inrange;
  99     bool nav2_has_dme;
 100     bool nav2_has_gs;
 101     bool nav2_loc;
 102     double nav2_freq;
 103     double nav2_alt_freq;
 104     double nav2_radial;
 105     double nav2_sel_radial;
 106     double nav2_loclon;
 107     double nav2_loclat;
 108     double nav2_x;
 109     double nav2_y;
 110     double nav2_z;
 111     double nav2_loc_dist;
 112     double nav2_gslon;
 113     double nav2_gslat;
 114     double nav2_gs_x;
 115     double nav2_gs_y;
 116     double nav2_gs_z;
 117     double nav2_gs_dist;
 118     double nav2_dmelon;
 119     double nav2_dmelat;
 120     double nav2_dme_x;
 121     double nav2_dme_y;
 122     double nav2_dme_z;
 123     double nav2_dme_dist;
 124     double nav2_elev;
 125     double nav2_range;
 126     double nav2_effective_range;
 127     double nav2_heading;
 128     double nav2_target_gs;
 129     double nav2_magvar;
 130     double nav2_vol_btn;
 131     bool nav2_ident_btn;
 132
 133     bool outer_marker;
 134     bool middle_marker;
 135     bool inner_marker;
 136
 137     SGTimeStamp blink;
 138     bool outer_blink;
 139     bool middle_blink;
 140     bool inner_blink;
 141
 142     string adf_ident;
 143     string adf_trans_ident;
 144     bool adf_valid;
 145     bool adf_inrange;
 146     double adf_freq;
 147     double adf_alt_freq;
 148     double adf_rotation;
 149     double adf_lon;
 150     double adf_lat;
 151     double adf_elev;
 152     double adf_range;
 153     double adf_effective_range;
 154     double adf_dist;
 155     double adf_heading;
 156     double adf_x;
 157     double adf_y;
 158     double adf_z;
 159     double adf_vol_btn;
 160     bool adf_ident_btn;
 161
 162     // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 163     double adjustNavRange( double stationElev, double aircraftElev,
 164                            double nominalRange );
 165
 166     // model standard ILS service volumes as per AIM 1-1-9
 167     double adjustILSRange( double stationElev, double aircraftElev,
 168                            double offsetDegrees, double distance );
 169
 170 public:
 171
 172     FGRadioStack();
 173     ~FGRadioStack();
 174
 175     void init ();
 176     void bind ();
 177     void unbind ();
 178     void update ();
 179
 180     // Update nav/adf radios based on current postition
 181     void search ();
 182
 183     // NAV1 Setters
 184     inline void set_nav1_freq( double freq ) {
 185         nav1_freq = freq; need_update = true;
 186     }
 187     inline void set_nav1_alt_freq( double freq ) { nav1_alt_freq = freq; }
 188     inline void set_nav1_sel_radial( double radial ) {
 189         nav1_sel_radial = radial; need_update = true;
 190     }
 191     inline void set_nav1_vol_btn( double val ) {
 192         if ( val < 0.0 ) val = 0.0;
 193         if ( val > 1.0 ) val = 1.0;
 194         nav1_vol_btn = val;
 195     }
 196     inline void set_nav1_ident_btn( bool val ) { nav1_ident_btn = val; }
 197
 198     // NAV2 Setters
 199     inline void set_nav2_freq( double freq ) {
 200         nav2_freq = freq; need_update = true;
 201     }
 202     inline void set_nav2_alt_freq( double freq ) { nav2_alt_freq = freq; }
 203     inline void set_nav2_sel_radial( double radial ) {
 204         nav2_sel_radial = radial; need_update = true;
 205     }
 206     inline void set_nav2_vol_btn( double val ) {
 207         if ( val < 0.0 ) val = 0.0;
 208         if ( val > 1.0 ) val = 1.0;
 209         nav2_vol_btn = val;
 210     }
 211     inline void set_nav2_ident_btn( bool val ) { nav2_ident_btn = val; }
 212
 213     // ADF Setters
 214     inline void set_adf_freq( double freq ) {
 215         adf_freq = freq; need_update = true;
 216     }
 217     inline void set_adf_alt_freq( double freq ) { adf_alt_freq = freq; }
 218     inline void set_adf_rotation( double rot ) { adf_rotation = rot; }
 219     inline void set_adf_vol_btn( double val ) {
 220         if ( val < 0.0 ) val = 0.0;
 221         if ( val > 1.0 ) val = 1.0;
 222         adf_vol_btn = val;
 223     }
 224     inline void set_adf_ident_btn( bool val ) { adf_ident_btn = val; }
 225
 226
 227     // NAV1 Accessors
 228     inline double get_nav1_freq () const { return nav1_freq; }
 229     inline double get_nav1_alt_freq () const { return nav1_alt_freq; }
 230     inline double get_nav1_sel_radial() const { return nav1_sel_radial; }
 231
 232     // NAV2 Accessors
 233     inline double get_nav2_freq () const { return nav2_freq; }
 234     inline double get_nav2_alt_freq () const { return nav2_alt_freq; }
 235     inline double get_nav2_sel_radial() const { return nav2_sel_radial; }
 236
 237     // ADF Accessors
 238     inline double get_adf_freq () const { return adf_freq; }
 239     inline double get_adf_alt_freq () const { return adf_alt_freq; }
 240     inline double get_adf_rotation () const { return adf_rotation; }
 241
 242     // Marker Beacon Accessors
 243     inline bool get_inner_blink () const { return inner_blink; }
 244     inline bool get_middle_blink () const { return middle_blink; }
 245     inline bool get_outer_blink () const { return outer_blink; }
 246
 247     // Calculated values.
 248     inline bool get_nav1_inrange() const { return nav1_inrange; }
 249     bool get_nav1_to_flag () const;
 250     bool get_nav1_from_flag () const;
 251     inline bool get_nav1_has_dme() const { return nav1_has_dme; }
 252     inline bool get_nav1_dme_inrange () const {
 253         return nav1_inrange && nav1_has_dme;
 254     }
 255     inline bool get_nav1_has_gs() const { return nav1_has_gs; }
 256     inline bool get_nav1_loc() const { return nav1_loc; }
 257     inline double get_nav1_loclon() const { return nav1_loclon; }
 258     inline double get_nav1_loclat() const { return nav1_loclat; }
 259     inline double get_nav1_loc_dist() const { return nav1_loc_dist; }
 260     inline double get_nav1_gslon() const { return nav1_gslon; }
 261     inline double get_nav1_gslat() const { return nav1_gslat; }
 262     inline double get_nav1_gs_dist() const { return nav1_gs_dist; }
 263     inline double get_nav1_dmelon() const { return nav1_dmelon; }
 264     inline double get_nav1_dmelat() const { return nav1_dmelat; }
 265     inline double get_nav1_dme_dist() const { return nav1_dme_dist; }
 266     inline double get_nav1_elev() const { return nav1_elev; }
 267     inline double get_nav1_heading() const { return nav1_heading; }
 268     inline double get_nav1_radial() const { return nav1_radial; }
 269     inline double get_nav1_target_gs() const { return nav1_target_gs; }
 270     inline double get_nav1_magvar() const { return nav1_magvar; }
 271     double get_nav1_heading_needle_deflection() const;
 272     double get_nav1_gs_needle_deflection() const;
 273     inline double get_nav1_vol_btn() const { return nav1_vol_btn; }
 274     inline bool get_nav1_ident_btn() const { return nav1_ident_btn; }
 275
 276     inline bool get_nav2_inrange() const { return nav2_inrange; }
 277     bool get_nav2_to_flag () const;
 278     bool get_nav2_from_flag () const;
 279     inline bool get_nav2_has_dme() const { return nav2_has_dme; }
 280     inline bool get_nav2_dme_inrange () const {
 281         return nav2_inrange && nav2_has_dme;
 282     }
 283     inline bool get_nav2_has_gs() const { return nav2_has_gs; }
 284     inline bool get_nav2_loc() const { return nav2_loc; }
 285     inline double get_nav2_loclon() const { return nav2_loclon; }
 286     inline double get_nav2_loclat() const { return nav2_loclat; }
 287     inline double get_nav2_loc_dist() const { return nav2_loc_dist; }
 288     inline double get_nav2_gslon() const { return nav2_gslon; }
 289     inline double get_nav2_gslat() const { return nav2_gslat; }
 290     inline double get_nav2_gs_dist() const { return nav2_gs_dist; }
 291     inline double get_nav2_dmelon() const { return nav2_dmelon; }
 292     inline double get_nav2_dmelat() const { return nav2_dmelat; }
 293     inline double get_nav2_dme_dist() const { return nav2_dme_dist; }
 294     inline double get_nav2_elev() const { return nav2_elev; }
 295     inline double get_nav2_heading() const { return nav2_heading; }
 296     inline double get_nav2_radial() const { return nav2_radial; }
 297     inline double get_nav2_target_gs() const { return nav2_target_gs; }
 298     inline double get_nav2_magvar() const { return nav2_magvar; }
 299     double get_nav2_heading_needle_deflection() const;
 300     double get_nav2_gs_needle_deflection() const;
 301     inline double get_nav2_vol_btn() const { return nav2_vol_btn; }
 302     inline bool get_nav2_ident_btn() const { return nav2_ident_btn; }
 303
 304     inline bool get_adf_inrange() const { return adf_inrange; }
 305     inline double get_adf_lon() const { return adf_lon; }
 306     inline double get_adf_lat() const { return adf_lat; }
 307     inline double get_adf_heading() const { return adf_heading; }
 308     inline double get_adf_vol_btn() const { return adf_vol_btn; }
 309     inline bool get_adf_ident_btn() const { return adf_ident_btn; }
 310 };
 311
 312
 313 extern FGRadioStack *current_radiostack;
 314
 315 #endif // _FG_RADIOSTACK_HXX