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., 675 Mass Ave, Cambridge, MA 02139, 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/math/interpolater.hxx>
  33 #include <simgear/timing/timestamp.hxx>
  34
  35 #include <Navaids/navlist.hxx>
  36 #include <Sound/morse.hxx>
  37
  38 class FGNavRadio : public SGSubsystem
  39 {
  40     FGMorse morse;
  41
  42     SGInterpTable *term_tbl;
  43     SGInterpTable *low_tbl;
  44     SGInterpTable *high_tbl;
  45
  46     SGPropertyNode *lon_node;
  47     SGPropertyNode *lat_node;
  48     SGPropertyNode *alt_node;
  49     SGPropertyNode *bus_power_node;
  50
  51     // inputs
  52     SGPropertyNode *power_btn_node;
  53     SGPropertyNode *freq_node;       // primary freq
  54     SGPropertyNode *alt_freq_node;   // standby freq
  55     SGPropertyNode *sel_radial_node; // selected radial
  56     SGPropertyNode *vol_btn_node;
  57     SGPropertyNode *ident_btn_node;
  58     SGPropertyNode *audio_btn_node;
  59
  60     // outputs
  61     SGPropertyNode *fmt_freq_node;     // formated frequency
  62     SGPropertyNode *fmt_alt_freq_node; // formated alternate frequency
  63     SGPropertyNode *heading_node;      // true heading to nav station
  64     SGPropertyNode *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 *recip_radial_node; // radial_node(val) + 180 (for
  70                                        // convenience)
  71     SGPropertyNode *target_radial_true_node;
  72                                        // true heading of selected radial
  73     SGPropertyNode *target_auto_hdg_node;
  74     SGPropertyNode *to_flag_node;
  75     SGPropertyNode *from_flag_node;
  76     SGPropertyNode *inrange_node;
  77     SGPropertyNode *cdi_deflection_node;
  78     SGPropertyNode *cdi_xtrack_error_node;
  79     SGPropertyNode *has_gs_node;
  80     SGPropertyNode *loc_node;
  81     SGPropertyNode *loc_dist_node;
  82     SGPropertyNode *gs_deflection_node;
  83     SGPropertyNode *gs_rate_of_climb_node;
  84     SGPropertyNode *gs_dist_node;
  85     SGPropertyNode *id_node;
  86     SGPropertyNode *id_c1_node;
  87     SGPropertyNode *id_c2_node;
  88     SGPropertyNode *id_c3_node;
  89     SGPropertyNode *id_c4_node;
  90
  91     // unfiled
  92     SGPropertyNode *nav_serviceable_node;
  93     SGPropertyNode *cdi_serviceable_node;
  94     SGPropertyNode *gs_serviceable_node;
  95     SGPropertyNode *tofrom_serviceable_node;
  96     SGPropertyNode *nav_slaved_to_gps_node;
  97     SGPropertyNode *gps_cdi_deflection_node;
  98     SGPropertyNode *gps_to_flag_node;
  99     SGPropertyNode *gps_from_flag_node;
 100
 101     string last_id;
 102     bool last_nav_vor;
 103     int nav_play_count;
 104     time_t nav_last_time;
 105
 106     int index;                  // used for property binding
 107     string nav_fx_name;
 108     string dme_fx_name;
 109
 110     // internal (unexported) values
 111     string nav_trans_ident;
 112     bool nav_valid;
 113     bool nav_has_dme;
 114     double nav_target_radial;
 115     double nav_loclon;
 116     double nav_loclat;
 117     double nav_x;
 118     double nav_y;
 119     double nav_z;
 120     double nav_gslon;
 121     double nav_gslat;
 122     double nav_elev;            // use gs elev if available
 123     double nav_gs_x;
 124     double nav_gs_y;
 125     double nav_gs_z;
 126     sgdVec3 gs_base_vec;
 127     double nav_gs_dist_signed;
 128     SGTimeStamp prev_time;
 129     SGTimeStamp curr_time;
 130     double nav_range;
 131     double nav_effective_range;
 132     double nav_target_gs;
 133     double nav_twist;
 134     double horiz_vel;
 135     double last_x;
 136
 137     string name;
 138     int num;
 139
 140     // internal periodic station search timer
 141     double _time_before_search_sec;
 142
 143     // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 144     double adjustNavRange( double stationElev, double aircraftElev,
 145                            double nominalRange );
 146
 147     // model standard ILS service volumes as per AIM 1-1-9
 148     double adjustILSRange( double stationElev, double aircraftElev,
 149                            double offsetDegrees, double distance );
 150
 151 public:
 152
 153     FGNavRadio(SGPropertyNode *node);
 154     ~FGNavRadio();
 155
 156     void init ();
 157     void bind ();
 158     void unbind ();
 159     void update (double dt);
 160
 161     // Update nav/adf radios based on current postition
 162     void search ();
 163
 164     // NavCom Accessors
 165     inline bool has_power() const {
 166         return power_btn_node->getBoolValue()
 167             && (bus_power_node->getDoubleValue() > 1.0);
 168     }
 169 };
 170
 171
 172 #endif // _FG_NAVRADIO_HXX