src/Instrumentation/navradio.hxx

   1 // navradio.hxx -- class to manage a nav radio instance
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 //
   5 // Copyright (C) 2000 - 2002  Curtis L. Olson - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _FG_NAVRADIO_HXX
  25 #define _FG_NAVRADIO_HXX
  26
  27
  28 #include <Main/fg_props.hxx>
  29
  30 #include <simgear/compiler.h>
  31 #include <simgear/structure/subsystem_mgr.hxx>
  32 #include <simgear/timing/timestamp.hxx>
  33
  34 class SGSampleGroup;
  35 class FGNavRecord;
  36 typedef SGSharedPtr<FGNavRecord> FGNavRecordPtr;
  37
  38 class FGNavRadio : public SGSubsystem, public SGPropertyChangeListener
  39 {
  40     SGPropertyNode_ptr _radio_node;
  41     SGPropertyNode_ptr bus_power_node;
  42
  43     // property inputs
  44     SGPropertyNode_ptr is_valid_node;   // is station data valid (may be way out
  45                                         // of range.)
  46     SGPropertyNode_ptr power_btn_node;
  47     SGPropertyNode_ptr freq_node;       // primary freq
  48     SGPropertyNode_ptr alt_freq_node;   // standby freq
  49     SGPropertyNode_ptr is_loc_freq_node;// is the primary freq a loc/gs (paired) freq?
  50     SGPropertyNode_ptr sel_radial_node; // selected radial
  51     SGPropertyNode_ptr vol_btn_node;
  52     SGPropertyNode_ptr ident_btn_node;
  53     SGPropertyNode_ptr audio_btn_node;
  54     SGPropertyNode_ptr backcourse_node;
  55     SGPropertyNode_ptr nav_serviceable_node;
  56     SGPropertyNode_ptr cdi_serviceable_node;
  57     SGPropertyNode_ptr gs_serviceable_node;
  58     SGPropertyNode_ptr tofrom_serviceable_node;
  59
  60     // property outputs
  61     SGPropertyNode_ptr fmt_freq_node;     // formated frequency
  62     SGPropertyNode_ptr fmt_alt_freq_node; // formated alternate frequency
  63     SGPropertyNode_ptr heading_node;      // true heading to nav station
  64     SGPropertyNode_ptr radial_node;       // current radial we are on (taking
  65                                        // into consideration the vor station
  66                                        // alignment which likely doesn't
  67                                        // match the magnetic alignment
  68                                        // exactly.)
  69     SGPropertyNode_ptr recip_radial_node; // radial_node(val) + 180 (for
  70                                        // convenience)
  71     SGPropertyNode_ptr target_radial_true_node;
  72                                        // true heading of selected radial
  73     SGPropertyNode_ptr target_auto_hdg_node;
  74                                        // suggested autopilot heading
  75                                        // to intercept selected radial
  76     SGPropertyNode_ptr time_to_intercept; // estimated time to intecept selected
  77                                        // radial at current speed and heading
  78     SGPropertyNode_ptr to_flag_node;
  79     SGPropertyNode_ptr from_flag_node;
  80     SGPropertyNode_ptr inrange_node;
  81     SGPropertyNode_ptr signal_quality_norm_node;
  82     SGPropertyNode_ptr cdi_deflection_node;
  83     SGPropertyNode_ptr cdi_deflection_norm_node;
  84     SGPropertyNode_ptr cdi_xtrack_error_node;
  85     SGPropertyNode_ptr cdi_xtrack_hdg_err_node;
  86     SGPropertyNode_ptr has_gs_node;
  87     SGPropertyNode_ptr loc_node;
  88     SGPropertyNode_ptr loc_dist_node;
  89     SGPropertyNode_ptr gs_deflection_node;
  90     SGPropertyNode_ptr gs_deflection_deg_node;
  91     SGPropertyNode_ptr gs_deflection_norm_node;
  92     SGPropertyNode_ptr gs_direct_node;
  93     SGPropertyNode_ptr gs_rate_of_climb_node;
  94     SGPropertyNode_ptr gs_rate_of_climb_fpm_node;
  95     SGPropertyNode_ptr gs_dist_node;
  96     SGPropertyNode_ptr gs_inrange_node;
  97     SGPropertyNode_ptr nav_id_node;
  98     SGPropertyNode_ptr id_c1_node;
  99     SGPropertyNode_ptr id_c2_node;
 100     SGPropertyNode_ptr id_c3_node;
 101     SGPropertyNode_ptr id_c4_node;
 102
 103     // gps slaving support
 104     SGPropertyNode_ptr nav_slaved_to_gps_node;
 105     SGPropertyNode_ptr gps_cdi_deflection_node;
 106     SGPropertyNode_ptr gps_to_flag_node;
 107     SGPropertyNode_ptr gps_from_flag_node;
 108     SGPropertyNode_ptr gps_has_gs_node;
 109     SGPropertyNode_ptr gps_course_node;
 110     SGPropertyNode_ptr gps_xtrack_error_nm_node;
 111     SGPropertyNode_ptr _magvarNode;
 112
 113     // realism setting, are false courses and GS lobes enabled?
 114     SGPropertyNode_ptr falseCoursesEnabledNode;
 115
 116     // internal (private) values
 117
 118     bool _operable; ///< is the unit serviceable, on, powered, etc
 119     int play_count;
 120     bool _nav_search;
 121     double _last_freq;
 122     FGNavRecordPtr _navaid;
 123     FGNavRecordPtr _gs;
 124
 125     double target_radial;
 126     double effective_range;
 127     double target_gs;
 128     double twist;
 129     double horiz_vel;
 130     double last_x;
 131     double last_xtrack_error;
 132     double xrate_ms;
 133     double _localizerWidth; // cached localizer width in degrees
 134
 135     std::string _name;
 136     int _num;
 137
 138     // internal periodic station search timer
 139     double _time_before_search_sec;
 140
 141     SGVec3d _gsCart, _gsAxis, _gsVertical, _gsBaseline;
 142
 143     // CDI properties
 144     bool _toFlag, _fromFlag;
 145     double _cdiDeflection;
 146     double _cdiCrossTrackErrorM;
 147     double _gsNeedleDeflection;
 148     double _gsNeedleDeflectionNorm;
 149     double _gsDirect;
 150
 151     class AudioIdent * _audioIdent;
 152
 153     bool updateWithPower(double aDt);
 154
 155     // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 156     double adjustNavRange( double stationElev, double aircraftElev,
 157                            double nominalRange );
 158
 159     // model standard ILS service volumes as per AIM 1-1-9
 160     double adjustILSRange( double stationElev, double aircraftElev,
 161                            double offsetDegrees, double distance );
 162
 163     void updateAudio( double dt );
 164
 165     void updateReceiver(double dt);
 166     void updateGlideSlope(double dt, const SGVec3d& aircraft, double signal_quality_norm);
 167     void updateGPSSlaved();
 168     void updateCDI(double dt);
 169
 170     void clearOutputs();
 171
 172     FGNavRecord* findPrimaryNavaid(const SGGeod& aPos, double aFreqMHz);
 173
 174     /// accessor for tied, read-only 'operable' property
 175     bool isOperable() const
 176       { return _operable; }
 177
 178   // implement SGPropertyChangeListener
 179     virtual void valueChanged (SGPropertyNode * prop);
 180 public:
 181
 182     FGNavRadio(SGPropertyNode *node);
 183     ~FGNavRadio();
 184
 185     void init ();
 186     void reinit ();
 187     void bind ();
 188     void unbind ();
 189     void update (double dt);
 190
 191     // Update nav/adf radios based on current postition
 192     void search ();
 193     void updateNav();
 194 };
 195
 196
 197 #endif // _FG_NAVRADIO_HXX