1 // navradio.hxx -- class to manage a nav radio instance
3 // Written by Curtis Olson, started April 2000.
5 // Copyright (C) 2000 - 2002 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
24 #ifndef _FG_NAVRADIO_HXX
25 #define _FG_NAVRADIO_HXX
28 #include <Main/fg_props.hxx>
30 #include <simgear/compiler.h>
31 #include <simgear/structure/subsystem_mgr.hxx>
32 #include <simgear/timing/timestamp.hxx>
39 typedef SGSharedPtr<FGNavRecord> FGNavRecordPtr;
41 class FGNavRadio : public SGSubsystem, public SGPropertyChangeListener
43 SGInterpTable *term_tbl;
44 SGInterpTable *low_tbl;
45 SGInterpTable *high_tbl;
47 SGPropertyNode_ptr _radio_node;
48 SGPropertyNode_ptr bus_power_node;
51 SGPropertyNode_ptr is_valid_node; // is station data valid (may be way out
53 SGPropertyNode_ptr power_btn_node;
54 SGPropertyNode_ptr freq_node; // primary freq
55 SGPropertyNode_ptr alt_freq_node; // standby freq
56 SGPropertyNode_ptr sel_radial_node; // selected radial
57 SGPropertyNode_ptr vol_btn_node;
58 SGPropertyNode_ptr ident_btn_node;
59 SGPropertyNode_ptr audio_btn_node;
60 SGPropertyNode_ptr backcourse_node;
61 SGPropertyNode_ptr nav_serviceable_node;
62 SGPropertyNode_ptr cdi_serviceable_node;
63 SGPropertyNode_ptr gs_serviceable_node;
64 SGPropertyNode_ptr tofrom_serviceable_node;
67 SGPropertyNode_ptr fmt_freq_node; // formated frequency
68 SGPropertyNode_ptr fmt_alt_freq_node; // formated alternate frequency
69 SGPropertyNode_ptr heading_node; // true heading to nav station
70 SGPropertyNode_ptr radial_node; // current radial we are on (taking
71 // into consideration the vor station
72 // alignment which likely doesn't
73 // match the magnetic alignment
75 SGPropertyNode_ptr recip_radial_node; // radial_node(val) + 180 (for
77 SGPropertyNode_ptr target_radial_true_node;
78 // true heading of selected radial
79 SGPropertyNode_ptr target_auto_hdg_node;
80 // suggested autopilot heading
81 // to intercept selected radial
82 SGPropertyNode_ptr time_to_intercept; // estimated time to intecept selected
83 // radial at current speed and heading
84 SGPropertyNode_ptr to_flag_node;
85 SGPropertyNode_ptr from_flag_node;
86 SGPropertyNode_ptr inrange_node;
87 SGPropertyNode_ptr signal_quality_norm_node;
88 SGPropertyNode_ptr cdi_deflection_node;
89 SGPropertyNode_ptr cdi_deflection_norm_node;
90 SGPropertyNode_ptr cdi_xtrack_error_node;
91 SGPropertyNode_ptr cdi_xtrack_hdg_err_node;
92 SGPropertyNode_ptr has_gs_node;
93 SGPropertyNode_ptr loc_node;
94 SGPropertyNode_ptr loc_dist_node;
95 SGPropertyNode_ptr gs_deflection_node;
96 SGPropertyNode_ptr gs_deflection_deg_node;
97 SGPropertyNode_ptr gs_deflection_norm_node;
98 SGPropertyNode_ptr gs_direct_node;
99 SGPropertyNode_ptr gs_rate_of_climb_node;
100 SGPropertyNode_ptr gs_rate_of_climb_fpm_node;
101 SGPropertyNode_ptr gs_dist_node;
102 SGPropertyNode_ptr gs_inrange_node;
103 SGPropertyNode_ptr nav_id_node;
104 SGPropertyNode_ptr id_c1_node;
105 SGPropertyNode_ptr id_c2_node;
106 SGPropertyNode_ptr id_c3_node;
107 SGPropertyNode_ptr id_c4_node;
109 // gps slaving support
110 SGPropertyNode_ptr nav_slaved_to_gps_node;
111 SGPropertyNode_ptr gps_cdi_deflection_node;
112 SGPropertyNode_ptr gps_to_flag_node;
113 SGPropertyNode_ptr gps_from_flag_node;
114 SGPropertyNode_ptr gps_has_gs_node;
115 SGPropertyNode_ptr gps_course_node;
116 SGPropertyNode_ptr gps_xtrack_error_nm_node;
117 SGPropertyNode_ptr _magvarNode;
119 // realism setting, are false courses and GS lobes enabled?
120 SGPropertyNode_ptr falseCoursesEnabledNode;
122 // internal (private) values
124 bool _operable; ///< is the unit serviceable, on, powered, etc
127 FGNavRecordPtr _navaid;
130 double target_radial;
131 double effective_range;
136 double last_xtrack_error;
138 double _localizerWidth; // cached localizer width in degrees
143 // internal periodic station search timer
144 double _time_before_search_sec;
146 SGVec3d _gsCart, _gsAxis, _gsVertical, _gsBaseline;
149 bool _toFlag, _fromFlag;
150 double _cdiDeflection;
151 double _cdiCrossTrackErrorM;
152 double _gsNeedleDeflection;
153 double _gsNeedleDeflectionNorm;
156 class AudioIdent * _audioIdent;
158 bool updateWithPower(double aDt);
160 // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
161 double adjustNavRange( double stationElev, double aircraftElev,
162 double nominalRange );
164 // model standard ILS service volumes as per AIM 1-1-9
165 double adjustILSRange( double stationElev, double aircraftElev,
166 double offsetDegrees, double distance );
168 void updateAudio( double dt );
170 void updateReceiver(double dt);
171 void updateGlideSlope(double dt, const SGVec3d& aircraft, double signal_quality_norm);
172 void updateGPSSlaved();
173 void updateCDI(double dt);
177 FGNavRecord* findPrimaryNavaid(const SGGeod& aPos, double aFreqMHz);
179 /// accessor for tied, read-only 'operable' property
180 bool isOperable() const
181 { return _operable; }
183 // implement SGPropertyChangeListener
184 virtual void valueChanged (SGPropertyNode * prop);
187 FGNavRadio(SGPropertyNode *node);
193 void update (double dt);
195 // Update nav/adf radios based on current postition
200 #endif // _FG_NAVRADIO_HXX