1 // radiostack.cxx -- class to manage an instance of the radio stack
3 // Written by Curtis Olson, started April 2000.
5 // Copyright (C) 2000 Curtis L. Olson - curt@flightgear.org
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., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <Aircraft/aircraft.hxx>
25 #include <Main/bfi.hxx>
26 #include <Navaids/ilslist.hxx>
27 #include <Navaids/navlist.hxx>
28 #include <Time/event.hxx>
30 #include "radiostack.hxx"
33 * Boy, this is ugly! Make the VOR range vary by altitude difference.
36 kludgeRange (double stationElev, double aircraftElev, double nominalRange)
38 // Assume that the nominal range (usually
39 // 50nm) applies at a 5,000 ft difference.
41 double factor = ((aircraftElev*METER_TO_FEET) - stationElev) / 1000.0;
42 double range = fabs(nominalRange * factor);
44 // Clamp the range to keep it sane; for
45 // now, never less than 25% or more than
46 // 500% of nominal range.
47 if (range < nominalRange/4.0) {
48 range = nominalRange/4.0;
49 } else if (range > nominalRange*5.0) {
50 range = nominalRange*5.0;
57 FGRadioStack *current_radiostack;
60 // periodic radio station search wrapper
61 static void fgRadioSearch( void ) {
62 current_radiostack->search();
66 FGRadioStack::FGRadioStack() {
72 longitudeVal = fgGetValue("/position/longitude");
73 latitudeVal = fgGetValue("/position/latitude");
74 altitudeVal = fgGetValue("/position/altitude");
79 FGRadioStack::~FGRadioStack()
81 unbind(); // FIXME: should be called externally
93 // Search radio database once per second
94 global_events.Register( "fgRadioSearch()", fgRadioSearch,
95 fgEVENT::FG_EVENT_READY, 1000);
102 fgTie("/radios/nav1/frequencies/selected", this,
103 &FGRadioStack::get_nav1_freq, &FGRadioStack::set_nav1_freq);
104 fgTie("/radios/nav1/frequencies/standby", this,
105 &FGRadioStack::get_nav1_alt_freq, &FGRadioStack::set_nav1_alt_freq);
106 fgTie("/radios/nav1/radials/selected", this,
107 &FGRadioStack::get_nav1_sel_radial,
108 &FGRadioStack::set_nav1_sel_radial);
109 fgTie("/radios/nav1/on", this,
110 &FGRadioStack::get_nav1_on_btn,
111 &FGRadioStack::set_nav1_on_btn);
112 fgTie("/radios/nav1/ident", this,
113 &FGRadioStack::get_nav1_ident_btn,
114 &FGRadioStack::set_nav1_ident_btn);
117 fgTie("/radios/nav1/radials/actual", this, &FGRadioStack::get_nav1_radial);
118 fgTie("/radios/nav1/to-flag", this, &FGRadioStack::get_nav1_to_flag);
119 fgTie("/radios/nav1/from-flag", this, &FGRadioStack::get_nav1_from_flag);
120 fgTie("/radios/nav1/in-range", this, &FGRadioStack::get_nav1_inrange);
121 fgTie("/radios/nav1/dme/distance", this, &FGRadioStack::get_nav1_dme_dist);
122 fgTie("/radios/nav1/dme/in-range", this,
123 &FGRadioStack::get_nav1_dme_inrange);
124 fgTie("/radios/nav1/heading-needle-deflection", this,
125 &FGRadioStack::get_nav1_heading_needle_deflection);
126 fgTie("/radios/nav1/gs-needle-deflection", this,
127 &FGRadioStack::get_nav1_gs_needle_deflection);
130 fgTie("/radios/nav2/frequencies/selected", this,
131 &FGRadioStack::get_nav2_freq, &FGRadioStack::set_nav2_freq);
132 fgTie("/radios/nav2/frequencies/standby", this,
133 &FGRadioStack::get_nav2_alt_freq, &FGRadioStack::set_nav2_alt_freq);
134 fgTie("/radios/nav2/radials/selected", this,
135 &FGRadioStack::get_nav2_sel_radial,
136 &FGRadioStack::set_nav2_sel_radial);
137 fgTie("/radios/nav2/on", this,
138 &FGRadioStack::get_nav2_on_btn,
139 &FGRadioStack::set_nav2_on_btn);
140 fgTie("/radios/nav2/ident", this,
141 &FGRadioStack::get_nav2_ident_btn,
142 &FGRadioStack::set_nav2_ident_btn);
145 fgTie("/radios/nav2/radials/actual", this, &FGRadioStack::get_nav2_radial);
146 fgTie("/radios/nav2/to-flag", this, &FGRadioStack::get_nav2_to_flag);
147 fgTie("/radios/nav2/from-flag", this, &FGRadioStack::get_nav2_from_flag);
148 fgTie("/radios/nav2/in-range", this, &FGRadioStack::get_nav2_inrange);
149 fgTie("/radios/nav2/dme/distance", this, &FGRadioStack::get_nav2_dme_dist);
150 fgTie("/radios/nav2/dme/in-range", this,
151 &FGRadioStack::get_nav2_dme_inrange);
152 fgTie("/radios/nav2/heading-needle-deflection", this,
153 &FGRadioStack::get_nav2_heading_needle_deflection);
154 fgTie("/radios/nav2/gs-needle-deflection", this,
155 &FGRadioStack::get_nav2_gs_needle_deflection);
158 fgTie("/radios/adf/frequencies/selected", this,
159 &FGRadioStack::get_adf_freq, &FGRadioStack::set_adf_freq);
160 fgTie("/radios/adf/frequencies/standby", this,
161 &FGRadioStack::get_adf_alt_freq, &FGRadioStack::set_adf_alt_freq);
162 fgTie("/radios/adf/rotation", this,
163 &FGRadioStack::get_adf_rotation, &FGRadioStack::set_adf_rotation);
167 FGRadioStack::unbind ()
169 fgUntie("/radios/nav1/frequencies/selected");
170 fgUntie("/radios/nav1/frequencies/standby");
171 fgUntie("/radios/nav1/radials/actual");
172 fgUntie("/radios/nav1/radials/selected");
173 fgUntie("/radios/nav1/on");
174 fgUntie("/radios/nav1/ident");
175 fgUntie("/radios/nav1/to-flag");
176 fgUntie("/radios/nav1/from-flag");
177 fgUntie("/radios/nav1/in-range");
178 fgUntie("/radios/nav1/dme/distance");
179 fgUntie("/radios/nav1/dme/in-range");
180 fgUntie("/radios/nav1/heading-needle-deflection");
181 fgUntie("/radios/nav1/gs-needle-deflection");
183 fgUntie("/radios/nav2/frequencies/selected");
184 fgUntie("/radios/nav2/frequencies/standby");
185 fgUntie("/radios/nav2/radials/actual");
186 fgUntie("/radios/nav2/radials/selected");
187 fgUntie("/radios/nav2/on");
188 fgUntie("/radios/nav2/ident");
189 fgUntie("/radios/nav2/to-flag");
190 fgUntie("/radios/nav2/from-flag");
191 fgUntie("/radios/nav2/in-range");
192 fgUntie("/radios/nav2/dme/distance");
193 fgUntie("/radios/nav2/dme/in-range");
194 fgUntie("/radios/nav2/heading-needle-deflection");
195 fgUntie("/radios/nav2/gs-needle-deflection");
197 fgUntie("/radios/adf/frequencies/selected");
198 fgUntie("/radios/adf/frequencies/standby");
199 fgUntie("/radios/adf/rotation");
202 // Update the various nav values based on position and valid tuned in navs
204 FGRadioStack::update()
206 double lon = longitudeVal->getDoubleValue() * DEG_TO_RAD;
207 double lat = latitudeVal->getDoubleValue() * DEG_TO_RAD;
208 double elev = altitudeVal->getDoubleValue() * FEET_TO_METER;
212 Point3D aircraft = sgGeodToCart( Point3D( lon, lat, elev ) );
217 station = Point3D( nav1_x, nav1_y, nav1_z );
218 nav1_loc_dist = aircraft.distance3D( station );
220 if ( nav1_has_dme ) {
221 // staightline distance
222 station = Point3D( nav1_dme_x, nav1_dme_y, nav1_dme_z );
223 nav1_dme_dist = aircraft.distance3D( station );
229 station = Point3D( nav1_gs_x, nav1_gs_y, nav1_gs_z );
230 nav1_gs_dist = aircraft.distance3D( station );
235 if ( nav1_loc_dist < nav1_effective_range * NM_TO_METER ) {
239 geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
240 nav1_loclat, nav1_loclon,
242 // cout << "az1 = " << az1 << " magvar = " << nav1_magvar << endl;
243 nav1_heading = az1 - nav1_magvar;
244 // Alex: nav1_heading = - (az1 - FGBFI::getMagVar() / RAD_TO_DEG);
246 // cout << " heading = " << nav1_heading
247 // << " dist = " << nav1_dist << endl;
249 nav1_inrange = false;
254 nav1_radial = nav1_sel_radial;
257 // play station ident via audio system if on + ident,
258 // otherwise turn it off
259 if ( nav1_on_btn && nav1_ident_btn ) {
260 if ( ! globals->get_soundmgr()->is_playing( "nav1-ident" ) ) {
261 globals->get_soundmgr()->play_once( "nav1-ident" );
264 globals->get_soundmgr()->stop( "nav1-ident" );
267 nav1_inrange = false;
269 globals->get_soundmgr()->stop( "nav1-ident" );
270 // cout << "not picking up vor. :-(" << endl;
274 station = Point3D( nav2_x, nav2_y, nav2_z );
275 nav2_loc_dist = aircraft.distance3D( station );
277 if ( nav2_has_dme ) {
278 // staightline distance
279 station = Point3D( nav2_dme_x, nav2_dme_y, nav2_dme_z );
280 nav2_dme_dist = aircraft.distance3D( station );
286 station = Point3D( nav2_gs_x, nav2_gs_y, nav2_gs_z );
287 nav2_gs_dist = aircraft.distance3D( station );
292 if ( nav2_loc_dist < nav2_effective_range * NM_TO_METER ) {
296 geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
297 nav2_loclat, nav2_loclon,
299 nav2_heading = az1 - nav2_magvar;
300 // Alex: nav2_heading = - (az1 - FGBFI::getMagVar() / RAD_TO_DEG);
302 // cout << " heading = " << nav2_heading
303 // << " dist = " << nav2_dist << endl;
305 nav2_inrange = false;
309 nav2_radial = nav2_sel_radial;
312 nav2_inrange = false;
313 // cout << "not picking up vor. :-(" << endl;
318 // staightline distance
319 station = Point3D( adf_x, adf_y, adf_z );
320 adf_dist = aircraft.distance3D( station );
322 if ( adf_dist < adf_effective_range * NM_TO_METER ) {
326 geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
331 // cout << " heading = " << nav2_heading
332 // << " dist = " << nav2_dist << endl;
342 // Update current nav/adf radio stations based on current postition
343 void FGRadioStack::search()
345 double lon = longitudeVal->getDoubleValue() * DEG_TO_RAD;
346 double lat = latitudeVal->getDoubleValue() * DEG_TO_RAD;
347 double elev = altitudeVal->getDoubleValue() * FEET_TO_METER;
353 static string last_nav1_ident = "";
354 static string last_nav2_ident = "";
356 if ( current_ilslist->query( lon, lat, elev, nav1_freq, &ils ) ) {
357 nav1_ident = ils.get_locident();
358 if ( last_nav1_ident != nav1_ident ) {
359 last_nav1_ident = nav1_ident;
362 nav1_has_dme = ils.get_has_dme();
363 nav1_has_gs = ils.get_has_gs();
365 nav1_loclon = ils.get_loclon();
366 nav1_loclat = ils.get_loclat();
367 nav1_gslon = ils.get_gslon();
368 nav1_gslat = ils.get_gslat();
369 nav1_dmelon = ils.get_dmelon();
370 nav1_dmelat = ils.get_dmelat();
371 nav1_elev = ils.get_gselev();
373 nav1_effective_range = FG_ILS_DEFAULT_RANGE;
374 nav1_target_gs = ils.get_gsangle();
375 nav1_radial = ils.get_locheading();
376 while ( nav1_radial < 0.0 ) { nav1_radial += 360.0; }
377 while ( nav1_radial > 360.0 ) { nav1_radial -= 360.0; }
378 nav1_x = ils.get_x();
379 nav1_y = ils.get_y();
380 nav1_z = ils.get_z();
381 nav1_gs_x = ils.get_gs_x();
382 nav1_gs_y = ils.get_gs_y();
383 nav1_gs_z = ils.get_gs_z();
384 nav1_dme_x = ils.get_dme_x();
385 nav1_dme_y = ils.get_dme_y();
386 nav1_dme_z = ils.get_dme_z();
388 if ( globals->get_soundmgr()->exists( "nav1-ident" ) ) {
389 globals->get_soundmgr()->remove( "nav1-ident" );
391 FGSimpleSound *sound = morse.make_ident( nav1_ident );
392 sound->set_volume( 0.3 );
393 globals->get_soundmgr()->add( sound, "nav1-ident" );
395 // cout << "Found an ils station in range" << endl;
396 // cout << " id = " << ils.get_locident() << endl;
398 } else if ( current_navlist->query( lon, lat, elev, nav1_freq, &nav ) ) {
399 nav1_ident = nav.get_ident();
400 if ( last_nav1_ident != nav1_ident ) {
401 last_nav1_ident = nav1_ident;
404 nav1_has_dme = nav.get_has_dme();
406 nav1_loclon = nav.get_lon();
407 nav1_loclat = nav.get_lat();
408 nav1_elev = nav.get_elev();
409 nav1_magvar = nav.get_magvar();
411 = kludgeRange(nav1_elev, elev, nav.get_range());
412 nav1_target_gs = 0.0;
413 nav1_radial = nav1_sel_radial;
414 nav1_x = nav1_dme_x = nav.get_x();
415 nav1_y = nav1_dme_y = nav.get_y();
416 nav1_z = nav1_dme_z = nav.get_z();
418 if ( globals->get_soundmgr()->exists( "nav1-ident" ) ) {
419 globals->get_soundmgr()->remove( "nav1-ident" );
421 FGSimpleSound *sound = morse.make_ident( nav1_ident );
422 sound->set_volume( 0.3 );
423 globals->get_soundmgr()->add( sound, "nav1-ident" );
425 // cout << "Found a vor station in range" << endl;
426 // cout << " id = " << nav.get_ident() << endl;
433 globals->get_soundmgr()->remove( "nav1-ident" );
434 // cout << "not picking up vor1. :-(" << endl;
437 if ( current_ilslist->query( lon, lat, elev, nav2_freq, &ils ) ) {
438 nav2_ident = ils.get_locident();
439 if ( last_nav2_ident != nav2_ident ) {
440 last_nav2_ident = nav2_ident;
443 nav2_has_dme = ils.get_has_dme();
444 nav2_has_gs = ils.get_has_gs();
446 nav2_loclon = ils.get_loclon();
447 nav2_loclat = ils.get_loclat();
448 nav2_elev = ils.get_gselev();
450 nav2_effective_range = FG_ILS_DEFAULT_RANGE;
451 nav2_target_gs = ils.get_gsangle();
452 nav2_radial = ils.get_locheading();
453 while ( nav2_radial < 0.0 ) { nav2_radial += 360.0; }
454 while ( nav2_radial > 360.0 ) { nav2_radial -= 360.0; }
455 nav2_x = ils.get_x();
456 nav2_y = ils.get_y();
457 nav2_z = ils.get_z();
458 nav2_gs_x = ils.get_gs_x();
459 nav2_gs_y = ils.get_gs_y();
460 nav2_gs_z = ils.get_gs_z();
461 nav2_dme_x = ils.get_dme_x();
462 nav2_dme_y = ils.get_dme_y();
463 nav2_dme_z = ils.get_dme_z();
464 // cout << "Found an ils station in range" << endl;
465 // cout << " id = " << ils.get_locident() << endl;
467 } else if ( current_navlist->query( lon, lat, elev, nav2_freq, &nav ) ) {
468 nav2_ident = nav.get_ident();
469 if ( last_nav2_ident != nav2_ident ) {
470 last_nav2_ident = nav2_ident;
473 nav2_has_dme = nav.get_has_dme();
474 nav2_has_dme = false;
475 nav2_loclon = nav.get_lon();
476 nav2_loclat = nav.get_lat();
477 nav2_elev = nav.get_elev();
478 nav2_magvar = nav.get_magvar();
480 = kludgeRange(nav2_elev, elev, nav.get_range());
481 nav2_target_gs = 0.0;
482 nav2_radial = nav2_sel_radial;
483 nav2_x = nav2_dme_x = nav.get_x();
484 nav2_y = nav2_dme_y = nav.get_y();
485 nav2_z = nav2_dme_z = nav.get_z();
486 // cout << "Found a vor station in range" << endl;
487 // cout << " id = " << nav.get_ident() << endl;
494 // cout << "not picking up vor2. :-(" << endl;
498 if ( current_navlist->query( lon, lat, elev, adf_freq, &nav ) ) {
501 adf_lon = nav.get_lon();
502 adf_lat = nav.get_lat();
503 adf_elev = nav.get_elev();
504 adf_effective_range = kludgeRange(adf_elev, elev, nav.get_range());
508 // cout << "Found an adf station in range" << endl;
509 // cout << " id = " << nav.get_ident() << endl;
512 // cout << "not picking up adf. :-(" << endl;
517 // return the amount of heading needle deflection, returns a value
518 // clamped to the range of ( -10 , 10 )
519 double FGRadioStack::get_nav1_heading_needle_deflection() const {
522 if ( nav1_inrange ) {
523 r = nav1_heading - nav1_radial;
524 // cout << "Radial = " << nav1_radial
525 // << " Bearing = " << nav1_heading << endl;
527 while ( r > 180.0 ) { r -= 360.0;}
528 while ( r < -180.0 ) { r += 360.0;}
529 if ( fabs(r) > 90.0 ) {
530 r = ( r<0.0 ? -r-180.0 : -r+180.0 );
536 // According to Robin Peel, the ILS is 4x more sensitive than a vor
537 if ( nav1_loc ) { r *= 4.0; }
538 if ( r < -10.0 ) { r = -10.0; }
539 if ( r > 10.0 ) { r = 10.0; }
547 // return the amount of heading needle deflection, returns a value
548 // clamped to the range of ( -10 , 10 )
549 double FGRadioStack::get_nav2_heading_needle_deflection() const {
552 if ( nav2_inrange ) {
553 r = nav2_heading - nav2_radial;
554 // cout << "Radial = " << nav2_radial
555 // << " Bearing = " << nav2_heading << endl;
557 while (r> 180.0) r-=360.0;
558 while (r<-180.0) r+=360.0;
559 if ( fabs(r) > 90.0 )
560 r = ( r<0.0 ? -r-180.0 : -r+180.0 );
561 // According to Robin Peel, the ILS is 4x more sensitive than a vor
562 if ( nav2_loc ) r *= 4.0;
563 if ( r < -10.0 ) r = -10.0;
564 if ( r > 10.0 ) r = 10.0;
572 // return the amount of glide slope needle deflection (.i.e. the
573 // number of degrees we are off the glide slope * 5.0
574 double FGRadioStack::get_nav1_gs_needle_deflection() const {
575 if ( nav1_inrange && nav1_has_gs ) {
576 double x = nav1_gs_dist;
577 double y = (FGBFI::getAltitude() - nav1_elev) * FEET_TO_METER;
578 double angle = atan2( y, x ) * RAD_TO_DEG;
579 return (nav1_target_gs - angle) * 5.0;
586 // return the amount of glide slope needle deflection (.i.e. the
587 // number of degrees we are off the glide slope * 5.0
588 double FGRadioStack::get_nav2_gs_needle_deflection() const {
589 if ( nav2_inrange && nav2_has_gs ) {
590 double x = nav2_gs_dist;
591 double y = (FGBFI::getAltitude() - nav2_elev) * FEET_TO_METER;
592 double angle = atan2( y, x ) * RAD_TO_DEG;
593 return (nav2_target_gs - angle) * 5.0;
601 * Return true if the NAV1 TO flag should be active.
604 FGRadioStack::get_nav1_to_flag () const
607 double offset = fabs(nav1_heading - nav1_radial);
611 return (offset <= 90.0 || offset >= 270.0);
619 * Return true if the NAV1 FROM flag should be active.
622 FGRadioStack::get_nav1_from_flag () const
625 double offset = fabs(nav1_heading - nav1_radial);
629 return (offset > 90.0 && offset < 270.0);
637 * Return true if the NAV2 TO flag should be active.
640 FGRadioStack::get_nav2_to_flag () const
643 double offset = fabs(nav2_heading - nav2_radial);
647 return (offset <= 90.0 || offset >= 270.0);
655 * Return true if the NAV2 FROM flag should be active.
658 FGRadioStack::get_nav2_from_flag () const
661 double offset = fabs(nav2_heading - nav2_radial);
665 return (offset > 90.0 && offset < 270.0);