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