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>
29 #include "Sound/morse.hxx"
31 #include <simgear/compiler.h>
32 #include <simgear/structure/subsystem_mgr.hxx>
33 #include <simgear/timing/timestamp.hxx>
40 typedef SGSharedPtr<FGNavRecord> FGNavRecordPtr;
42 class FGNavRadio : public SGSubsystem
46 SGInterpTable *term_tbl;
47 SGInterpTable *low_tbl;
48 SGInterpTable *high_tbl;
50 SGPropertyNode_ptr lon_node;
51 SGPropertyNode_ptr lat_node;
52 SGPropertyNode_ptr alt_node;
53 SGPropertyNode_ptr bus_power_node;
56 SGPropertyNode_ptr is_valid_node; // is station data valid (may be way out
58 SGPropertyNode_ptr power_btn_node;
59 SGPropertyNode_ptr freq_node; // primary freq
60 SGPropertyNode_ptr alt_freq_node; // standby freq
61 SGPropertyNode_ptr sel_radial_node; // selected radial
62 SGPropertyNode_ptr vol_btn_node;
63 SGPropertyNode_ptr ident_btn_node;
64 SGPropertyNode_ptr audio_btn_node;
65 SGPropertyNode_ptr backcourse_node;
66 SGPropertyNode_ptr nav_serviceable_node;
67 SGPropertyNode_ptr cdi_serviceable_node;
68 SGPropertyNode_ptr gs_serviceable_node;
69 SGPropertyNode_ptr tofrom_serviceable_node;
70 SGPropertyNode_ptr dme_serviceable_node;
73 SGPropertyNode_ptr fmt_freq_node; // formated frequency
74 SGPropertyNode_ptr fmt_alt_freq_node; // formated alternate frequency
75 SGPropertyNode_ptr heading_node; // true heading to nav station
76 SGPropertyNode_ptr radial_node; // current radial we are on (taking
77 // into consideration the vor station
78 // alignment which likely doesn't
79 // match the magnetic alignment
81 SGPropertyNode_ptr recip_radial_node; // radial_node(val) + 180 (for
83 SGPropertyNode_ptr target_radial_true_node;
84 // true heading of selected radial
85 SGPropertyNode_ptr target_auto_hdg_node;
86 // suggested autopilot heading
87 // to intercept selected radial
88 SGPropertyNode_ptr time_to_intercept; // estimated time to intecept selected
89 // radial at current speed and heading
90 SGPropertyNode_ptr to_flag_node;
91 SGPropertyNode_ptr from_flag_node;
92 SGPropertyNode_ptr inrange_node;
93 SGPropertyNode_ptr signal_quality_norm_node;
94 SGPropertyNode_ptr cdi_deflection_node;
95 SGPropertyNode_ptr cdi_deflection_norm_node;
96 SGPropertyNode_ptr cdi_xtrack_error_node;
97 SGPropertyNode_ptr cdi_xtrack_hdg_err_node;
98 SGPropertyNode_ptr has_gs_node;
99 SGPropertyNode_ptr loc_node;
100 SGPropertyNode_ptr loc_dist_node;
101 SGPropertyNode_ptr gs_deflection_node;
102 SGPropertyNode_ptr gs_deflection_deg_node;
103 SGPropertyNode_ptr gs_deflection_norm_node;
104 SGPropertyNode_ptr gs_rate_of_climb_node;
105 SGPropertyNode_ptr gs_dist_node;
106 SGPropertyNode_ptr gs_inrange_node;
107 SGPropertyNode_ptr nav_id_node;
108 SGPropertyNode_ptr id_c1_node;
109 SGPropertyNode_ptr id_c2_node;
110 SGPropertyNode_ptr id_c3_node;
111 SGPropertyNode_ptr id_c4_node;
113 // gps slaving support
114 SGPropertyNode_ptr nav_slaved_to_gps_node;
115 SGPropertyNode_ptr gps_cdi_deflection_node;
116 SGPropertyNode_ptr gps_to_flag_node;
117 SGPropertyNode_ptr gps_from_flag_node;
118 SGPropertyNode_ptr gps_has_gs_node;
119 SGPropertyNode_ptr gps_course_node;
120 SGPropertyNode_ptr gps_xtrack_error_nm_node;
121 SGPropertyNode_ptr _magvarNode;
123 // internal (private) values
127 FGNavRecordPtr _navaid;
133 double target_radial;
134 SGTimeStamp prev_time;
135 SGTimeStamp curr_time;
136 double effective_range;
141 double last_loc_dist;
142 double last_xtrack_error;
144 double _localizerWidth; // cached localizer width in degrees
149 // internal periodic station search timer
150 double _time_before_search_sec;
152 SGVec3d _gsCart, _gsAxis, _gsVertical;
158 bool _toFlag, _fromFlag;
159 double _cdiDeflection;
160 double _cdiCrossTrackErrorM;
161 double _gsNeedleDeflection;
162 double _gsNeedleDeflectionNorm;
164 // realism setting, are false courses and GS lobes enabled?
165 bool _falseCoursesEnabled;
167 SGSharedPtr<SGSampleGroup> _sgr;
169 bool updateWithPower(double aDt);
171 // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
172 double adjustNavRange( double stationElev, double aircraftElev,
173 double nominalRange );
175 // model standard ILS service volumes as per AIM 1-1-9
176 double adjustILSRange( double stationElev, double aircraftElev,
177 double offsetDegrees, double distance );
180 void audioNavidChanged();
182 void updateReceiver(double dt);
183 void updateDME(const SGVec3d& aircraft);
184 void updateGlideSlope(double dt, const SGVec3d& aircraft, double signal_quality_norm);
185 void updateGPSSlaved();
186 void updateCDI(double dt);
191 * Compute the localizer width in degrees - see implementation for
192 * more information on the relevant standards and formulae.
194 double localizerWidth(FGNavRecord* aLOC);
195 FGNavRecord* findPrimaryNavaid(const SGGeod& aPos, double aFreqMHz);
198 FGNavRadio(SGPropertyNode *node);
204 void update (double dt);
206 // Update nav/adf radios based on current postition
211 #endif // _FG_NAVRADIO_HXX