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