]> git.mxchange.org Git - flightgear.git/blob - src/Cockpit/radiostack.cxx
Tweaks for Mips Irix compilers.
[flightgear.git] / src / Cockpit / radiostack.cxx
1 // radiostack.cxx -- class to manage an instance of the radio stack
2 //
3 // Written by Curtis Olson, started April 2000.
4 //
5 // Copyright (C) 2000  Curtis L. Olson - curt@flightgear.org
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 #include <Aircraft/aircraft.hxx>
25 #include <Main/bfi.hxx>
26 #include <Navaids/ilslist.hxx>
27 #include <Navaids/navlist.hxx>
28 #include <Time/event.hxx>
29
30 #include "radiostack.hxx"
31
32 /**
33  * Boy, this is ugly!  Make the VOR range vary by altitude difference.
34  */
35 static inline double
36 kludgeRange (double stationElev, double aircraftElev, double nominalRange)
37 {
38                                 // Assume that the nominal range (usually
39                                 // 50nm) applies at a 5,000 ft difference.
40                                 // Just a wild guess!
41   double factor = ((aircraftElev*METER_TO_FEET) - stationElev) / 1000.0;
42   double range = fabs(nominalRange * factor);
43
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;
51   }
52
53   return range;
54 }
55
56
57 FGRadioStack *current_radiostack;
58
59
60 // periodic radio station search wrapper
61 static void fgRadioSearch( void ) {
62     current_radiostack->search();
63 }
64
65 // Constructor
66 FGRadioStack::FGRadioStack() {
67     nav1_radial = 0.0;
68     nav1_dme_dist = 0.0;
69     nav2_radial = 0.0;
70     nav2_dme_dist = 0.0;
71     need_update = true;
72     longitudeVal = fgGetValue("/position/longitude");
73     latitudeVal = fgGetValue("/position/latitude");
74     altitudeVal = fgGetValue("/position/altitude");
75 }
76
77
78 // Destructor
79 FGRadioStack::~FGRadioStack() 
80 {
81     unbind();                   // FIXME: should be called externally
82 }
83
84
85 void
86 FGRadioStack::init ()
87 {
88     search();
89     update();
90
91     // Search radio database once per second
92     global_events.Register( "fgRadioSearch()", fgRadioSearch,
93                             fgEVENT::FG_EVENT_READY, 1000);
94 }
95
96 void
97 FGRadioStack::bind ()
98 {
99                                 // User inputs
100     fgTie("/radios/nav1/frequencies/selected", this,
101           &FGRadioStack::get_nav1_freq, &FGRadioStack::set_nav1_freq);
102     fgTie("/radios/nav1/frequencies/standby", this,
103           &FGRadioStack::get_nav1_alt_freq, &FGRadioStack::set_nav1_alt_freq);
104     fgTie("/radios/nav1/radials/selected", this,
105           &FGRadioStack::get_nav1_sel_radial,
106           &FGRadioStack::set_nav1_sel_radial);
107
108                                 // Radio outputs
109     fgTie("/radios/nav1/radials/actual", this, &FGRadioStack::get_nav1_radial);
110     fgTie("/radios/nav1/to-flag", this, &FGRadioStack::get_nav1_to_flag);
111     fgTie("/radios/nav1/from-flag", this, &FGRadioStack::get_nav1_from_flag);
112     fgTie("/radios/nav1/in-range", this, &FGRadioStack::get_nav1_inrange);
113     fgTie("/radios/nav1/dme/distance", this, &FGRadioStack::get_nav1_dme_dist);
114     fgTie("/radios/nav1/dme/in-range", this,
115           &FGRadioStack::get_nav1_dme_inrange);
116     fgTie("/radios/nav1/heading-needle-deflection", this,
117           &FGRadioStack::get_nav1_heading_needle_deflection);
118     fgTie("/radios/nav1/gs-needle-deflection", this,
119           &FGRadioStack::get_nav1_gs_needle_deflection);
120
121                                 // User inputs
122     fgTie("/radios/nav2/frequencies/selected", this,
123           &FGRadioStack::get_nav2_freq, &FGRadioStack::set_nav2_freq);
124     fgTie("/radios/nav2/frequencies/standby", this,
125           &FGRadioStack::get_nav2_alt_freq, &FGRadioStack::set_nav2_alt_freq);
126     fgTie("/radios/nav2/radials/selected", this,
127           &FGRadioStack::get_nav2_sel_radial,
128           &FGRadioStack::set_nav2_sel_radial);
129
130                                 // Radio outputs
131     fgTie("/radios/nav2/radials/actual", this, &FGRadioStack::get_nav2_radial);
132     fgTie("/radios/nav2/to-flag", this, &FGRadioStack::get_nav2_to_flag);
133     fgTie("/radios/nav2/from-flag", this, &FGRadioStack::get_nav2_from_flag);
134     fgTie("/radios/nav2/in-range", this, &FGRadioStack::get_nav2_inrange);
135     fgTie("/radios/nav2/dme/distance", this, &FGRadioStack::get_nav2_dme_dist);
136     fgTie("/radios/nav2/dme/in-range", this,
137           &FGRadioStack::get_nav2_dme_inrange);
138     fgTie("/radios/nav2/heading-needle-deflection", this,
139           &FGRadioStack::get_nav2_heading_needle_deflection);
140     fgTie("/radios/nav2/gs-needle-deflection", this,
141           &FGRadioStack::get_nav2_gs_needle_deflection);
142
143                                 // User inputs
144     fgTie("/radios/adf/frequencies/selected", this,
145           &FGRadioStack::get_adf_freq, &FGRadioStack::set_adf_freq);
146     fgTie("/radios/adf/frequencies/standby", this,
147           &FGRadioStack::get_adf_alt_freq, &FGRadioStack::set_adf_alt_freq);
148     fgTie("/radios/adf/rotation", this,
149           &FGRadioStack::get_adf_rotation, &FGRadioStack::set_adf_rotation);
150 }
151
152 void
153 FGRadioStack::unbind ()
154 {
155     fgUntie("/radios/nav1/frequencies/selected");
156     fgUntie("/radios/nav1/frequencies/standby");
157     fgUntie("/radios/nav1/radials/actual");
158     fgUntie("/radios/nav1/radials/selected");
159     fgUntie("/radios/nav1/to-flag");
160     fgUntie("/radios/nav1/from-flag");
161     fgUntie("/radios/nav1/in-range");
162     fgUntie("/radios/nav1/dme/distance");
163     fgUntie("/radios/nav1/dme/in-range");
164     fgUntie("/radios/nav1/heading-needle-deflection");
165     fgUntie("/radios/nav1/gs-needle-deflection");
166
167     fgUntie("/radios/nav2/frequencies/selected");
168     fgUntie("/radios/nav2/frequencies/standby");
169     fgUntie("/radios/nav2/radials/actual");
170     fgUntie("/radios/nav2/radials/selected");
171     fgUntie("/radios/nav2/to-flag");
172     fgUntie("/radios/nav2/from-flag");
173     fgUntie("/radios/nav2/in-range");
174     fgUntie("/radios/nav2/dme/distance");
175     fgUntie("/radios/nav2/dme/in-range");
176     fgUntie("/radios/nav2/heading-needle-deflection");
177     fgUntie("/radios/nav2/gs-needle-deflection");
178
179     fgUntie("/radios/adf/frequencies/selected");
180     fgUntie("/radios/adf/frequencies/standby");
181     fgUntie("/radios/adf/rotation");
182 }
183
184 // Search the database for the current frequencies given current location
185 void 
186 FGRadioStack::update() 
187 {
188     double lon = longitudeVal->getDoubleValue() * DEG_TO_RAD;
189     double lat = latitudeVal->getDoubleValue() * DEG_TO_RAD;
190     double elev = altitudeVal->getDoubleValue() * FEET_TO_METER;
191
192     need_update = false;
193
194     Point3D aircraft = sgGeodToCart( Point3D( lon, lat, elev ) );
195     Point3D station;
196     double az1, az2, s;
197
198     if ( nav1_valid ) {
199         station = Point3D( nav1_x, nav1_y, nav1_z );
200         nav1_loc_dist = aircraft.distance3D( station );
201
202         if ( nav1_has_dme ) {
203             // staightline distance
204             station = Point3D( nav1_dme_x, nav1_dme_y, nav1_dme_z );
205             nav1_dme_dist = aircraft.distance3D( station );
206         } else {
207             nav1_dme_dist = 0.0;
208         }
209
210         if ( nav1_has_gs ) {
211             station = Point3D( nav1_gs_x, nav1_gs_y, nav1_gs_z );
212             nav1_gs_dist = aircraft.distance3D( station );
213         } else {
214             nav1_gs_dist = 0.0;
215         }
216         
217         if ( nav1_loc_dist < nav1_effective_range * NM_TO_METER ) {
218             nav1_inrange = true;
219             
220             // wgs84 heading
221             geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG, 
222                                 nav1_loclat, nav1_loclon,
223                                 &az1, &az2, &s );
224             // cout << "az1 = " << az1 << " magvar = " << nav1_magvar << endl;
225             nav1_heading = az1 - nav1_magvar;
226             // Alex: nav1_heading = - (az1 - FGBFI::getMagVar() / RAD_TO_DEG);
227
228             // cout << " heading = " << nav1_heading
229             //      << " dist = " << nav1_dist << endl;
230         } else {
231             nav1_inrange = false;
232         }
233
234         if ( nav1_loc ) {
235         } else {
236             nav1_radial = nav1_sel_radial;
237         }
238     } else {
239         nav1_inrange = false;
240         nav1_dme_dist = 0.0;
241         // cout << "not picking up vor. :-(" << endl;
242     }
243
244     if ( nav2_valid ) {
245         station = Point3D( nav2_x, nav2_y, nav2_z );
246         nav2_loc_dist = aircraft.distance3D( station );
247
248         if ( nav2_has_dme ) {
249             // staightline distance
250             station = Point3D( nav2_dme_x, nav2_dme_y, nav2_dme_z );
251             nav2_dme_dist = aircraft.distance3D( station );
252         } else {
253             nav2_dme_dist = 0.0;
254         }
255
256         if ( nav2_has_gs ) {
257             station = Point3D( nav2_gs_x, nav2_gs_y, nav2_gs_z );
258             nav2_gs_dist = aircraft.distance3D( station );
259         } else {
260             nav2_gs_dist = 0.0;
261         }
262
263         if ( nav2_loc_dist < nav2_effective_range * NM_TO_METER ) {
264             nav2_inrange = true;
265
266             // wgs84 heading
267             geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG, 
268                                 nav2_loclat, nav2_loclon,
269                                 &az1, &az2, &s );
270             nav2_heading = az1 - nav2_magvar;
271             // Alex: nav2_heading = - (az1 - FGBFI::getMagVar() / RAD_TO_DEG);
272
273             // cout << " heading = " << nav2_heading
274             //      << " dist = " << nav2_dist << endl;
275         } else {
276             nav2_inrange = false;
277         }
278
279         if ( !nav2_loc ) {
280             nav2_radial = nav2_sel_radial;
281         }
282     } else {
283         nav2_inrange = false;
284         // cout << "not picking up vor. :-(" << endl;
285     }
286
287     // adf
288     if ( adf_valid ) {
289         // staightline distance
290         station = Point3D( adf_x, adf_y, adf_z );
291         adf_dist = aircraft.distance3D( station );
292
293         if ( adf_dist < adf_effective_range * NM_TO_METER ) {
294             adf_inrange = true;
295
296             // wgs84 heading
297             geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG, 
298                                 adf_lat, adf_lon,
299                                 &az1, &az2, &s );
300             adf_heading = az1;
301
302             // cout << " heading = " << nav2_heading
303             //      << " dist = " << nav2_dist << endl;
304         } else {
305             adf_inrange = false;
306         }
307     } else {
308         adf_inrange = false;
309     }
310 }
311
312
313 // Update current nav/adf radio stations based on current postition
314 void FGRadioStack::search () 
315 {
316     double lon = longitudeVal->getDoubleValue() * DEG_TO_RAD;
317     double lat = latitudeVal->getDoubleValue() * DEG_TO_RAD;
318     double elev = altitudeVal->getDoubleValue() * FEET_TO_METER;
319
320     // nav1
321     FGILS ils;
322     FGNav nav;
323
324     if ( current_ilslist->query( lon, lat, elev, nav1_freq, &ils ) ) {
325         nav1_valid = true;
326         nav1_loc = true;
327         nav1_has_dme = ils.get_has_dme();
328         nav1_has_gs = ils.get_has_gs();
329
330         nav1_loclon = ils.get_loclon();
331         nav1_loclat = ils.get_loclat();
332         nav1_gslon = ils.get_gslon();
333         nav1_gslat = ils.get_gslat();
334         nav1_dmelon = ils.get_dmelon();
335         nav1_dmelat = ils.get_dmelat();
336         nav1_elev = ils.get_gselev();
337         nav1_magvar = 0;
338         nav1_effective_range = FG_ILS_DEFAULT_RANGE;
339         nav1_target_gs = ils.get_gsangle();
340         nav1_radial = ils.get_locheading();
341         while ( nav1_radial <   0.0 ) { nav1_radial += 360.0; }
342         while ( nav1_radial > 360.0 ) { nav1_radial -= 360.0; }
343         nav1_x = ils.get_x();
344         nav1_y = ils.get_y();
345         nav1_z = ils.get_z();
346         nav1_gs_x = ils.get_gs_x();
347         nav1_gs_y = ils.get_gs_y();
348         nav1_gs_z = ils.get_gs_z();
349         nav1_dme_x = ils.get_dme_x();
350         nav1_dme_y = ils.get_dme_y();
351         nav1_dme_z = ils.get_dme_z();
352         // cout << "Found an ils station in range" << endl;
353         // cout << " id = " << ils.get_locident() << endl;
354     } else if ( current_navlist->query( lon, lat, elev, nav1_freq, &nav ) ) {
355         nav1_valid = true;
356         nav1_loc = false;
357         nav1_has_dme = nav.get_has_dme();
358         nav1_has_gs = false;
359         nav1_loclon = nav.get_lon();
360         nav1_loclat = nav.get_lat();
361         nav1_elev = nav.get_elev();
362         nav1_magvar = nav.get_magvar();
363         nav1_effective_range = kludgeRange(nav1_elev, elev, nav.get_range());
364         nav1_target_gs = 0.0;
365         nav1_radial = nav1_sel_radial;
366         nav1_x = nav1_dme_x = nav.get_x();
367         nav1_y = nav1_dme_y = nav.get_y();
368         nav1_z = nav1_dme_z = nav.get_z();
369         // cout << "Found a vor station in range" << endl;
370         // cout << " id = " << nav.get_ident() << endl;
371     } else {
372         nav1_valid = false;
373         nav1_radial = 0;
374         nav1_dme_dist = 0;
375         // cout << "not picking up vor1. :-(" << endl;
376     }
377
378     if ( current_ilslist->query( lon, lat, elev, nav2_freq, &ils ) ) {
379         nav2_valid = true;
380         nav2_loc = true;
381         nav2_has_dme = ils.get_has_dme();
382         nav2_has_gs = ils.get_has_gs();
383
384         nav2_loclon = ils.get_loclon();
385         nav2_loclat = ils.get_loclat();
386         nav2_elev = ils.get_gselev();
387         nav2_magvar = 0;
388         nav2_effective_range = FG_ILS_DEFAULT_RANGE;
389         nav2_target_gs = ils.get_gsangle();
390         nav2_radial = ils.get_locheading();
391         while ( nav2_radial <   0.0 ) { nav2_radial += 360.0; }
392         while ( nav2_radial > 360.0 ) { nav2_radial -= 360.0; }
393         nav2_x = ils.get_x();
394         nav2_y = ils.get_y();
395         nav2_z = ils.get_z();
396         nav2_gs_x = ils.get_gs_x();
397         nav2_gs_y = ils.get_gs_y();
398         nav2_gs_z = ils.get_gs_z();
399         nav2_dme_x = ils.get_dme_x();
400         nav2_dme_y = ils.get_dme_y();
401         nav2_dme_z = ils.get_dme_z();
402         // cout << "Found an ils station in range" << endl;
403         // cout << " id = " << ils.get_locident() << endl;
404     } else if ( current_navlist->query( lon, lat, elev, nav2_freq, &nav ) ) {
405         nav2_valid = true;
406         nav2_loc = false;
407         nav2_has_dme = nav.get_has_dme();
408         nav2_has_dme = false;
409         nav2_loclon = nav.get_lon();
410         nav2_loclat = nav.get_lat();
411         nav2_elev = nav.get_elev();
412         nav2_magvar = nav.get_magvar();
413         nav2_effective_range = kludgeRange(nav2_elev, elev, nav.get_range());
414         nav2_target_gs = 0.0;
415         nav2_radial = nav2_sel_radial;
416         nav2_x = nav2_dme_x = nav.get_x();
417         nav2_y = nav2_dme_y = nav.get_y();
418         nav2_z = nav2_dme_z = nav.get_z();
419         // cout << "Found a vor station in range" << endl;
420         // cout << " id = " << nav.get_ident() << endl;
421     } else {
422         nav2_valid = false;
423         nav2_radial = 0;
424         nav2_dme_dist = 0;
425         // cout << "not picking up vor2. :-(" << endl;
426     }
427
428     // adf
429     if ( current_navlist->query( lon, lat, elev, adf_freq, &nav ) ) {
430         adf_valid = true;
431
432         adf_lon = nav.get_lon();
433         adf_lat = nav.get_lat();
434         adf_elev = nav.get_elev();
435         adf_effective_range = kludgeRange(adf_elev, elev, nav.get_range());
436         adf_x = nav.get_x();
437         adf_y = nav.get_y();
438         adf_z = nav.get_z();
439         // cout << "Found an adf station in range" << endl;
440         // cout << " id = " << nav.get_ident() << endl;
441     } else {
442         adf_valid = false;
443         // cout << "not picking up adf. :-(" << endl;
444     }
445 }
446
447
448 // return the amount of heading needle deflection, returns a value
449 // clamped to the range of ( -10 , 10 )
450 double FGRadioStack::get_nav1_heading_needle_deflection() const {
451     double r;
452
453     if ( nav1_inrange ) {
454         r = nav1_heading - nav1_radial;
455         // cout << "Radial = " << nav1_radial 
456         //      << "  Bearing = " << nav1_heading << endl;
457     
458         while ( r >  180.0 ) { r -= 360.0;}
459         while ( r < -180.0 ) { r += 360.0;}
460         if ( fabs(r) > 90.0 ) {
461             r = ( r<0.0 ? -r-180.0 : -r+180.0 );
462             if ( nav1_loc ) {
463                 r = -r;
464             }
465         }
466
467         // According to Robin Peel, the ILS is 4x more sensitive than a vor
468         if ( nav1_loc ) { r *= 4.0; }
469         if ( r < -10.0 ) { r = -10.0; }
470         if ( r >  10.0 ) { r = 10.0; }
471     } else {
472         r = 0.0;
473     }
474
475     return r;
476 }
477
478 // return the amount of heading needle deflection, returns a value
479 // clamped to the range of ( -10 , 10 )
480 double FGRadioStack::get_nav2_heading_needle_deflection() const {
481     double r;
482
483     if ( nav2_inrange ) {
484         r = nav2_heading - nav2_radial;
485         // cout << "Radial = " << nav2_radial 
486         //      << "  Bearing = " << nav2_heading << endl;
487     
488         while (r> 180.0) r-=360.0;
489         while (r<-180.0) r+=360.0;
490         if ( fabs(r) > 90.0 )
491             r = ( r<0.0 ? -r-180.0 : -r+180.0 );
492         // According to Robin Peel, the ILS is 4x more sensitive than a vor
493         if ( nav2_loc ) r *= 4.0;
494         if ( r < -10.0 ) r = -10.0;
495         if ( r > 10.0 ) r = 10.0;
496     } else {
497         r = 0.0;
498     }
499
500     return r;
501 }
502
503 // return the amount of glide slope needle deflection (.i.e. the
504 // number of degrees we are off the glide slope * 5.0
505 double FGRadioStack::get_nav1_gs_needle_deflection() const {
506     if ( nav1_inrange && nav1_has_gs ) {
507         double x = nav1_gs_dist;
508         double y = (FGBFI::getAltitude() - nav1_elev) * FEET_TO_METER;
509         double angle = atan2( y, x ) * RAD_TO_DEG;
510         return (nav1_target_gs - angle) * 5.0;
511     } else {
512         return 0.0;
513     }
514 }
515
516
517 // return the amount of glide slope needle deflection (.i.e. the
518 // number of degrees we are off the glide slope * 5.0
519 double FGRadioStack::get_nav2_gs_needle_deflection() const {
520     if ( nav2_inrange && nav2_has_gs ) {
521         double x = nav2_gs_dist;
522         double y = (FGBFI::getAltitude() - nav2_elev) * FEET_TO_METER;
523         double angle = atan2( y, x ) * RAD_TO_DEG;
524         return (nav2_target_gs - angle) * 5.0;
525     } else {
526         return 0.0;
527     }
528 }
529
530
531 /**
532  * Return true if the NAV1 TO flag should be active.
533  */
534 bool 
535 FGRadioStack::get_nav1_to_flag () const
536 {
537   if (nav1_inrange) {
538     double offset = fabs(nav1_heading - nav1_radial);
539     if (nav1_loc)
540       return true;
541     else
542       return (offset <= 90.0 || offset >= 270.0);
543   } else {
544     return false;
545   }
546 }
547
548
549 /**
550  * Return true if the NAV1 FROM flag should be active.
551  */
552 bool
553 FGRadioStack::get_nav1_from_flag () const
554 {
555   if (nav1_inrange) {
556     double offset = fabs(nav1_heading - nav1_radial);
557     if (nav1_loc)
558       return false;
559     else
560       return (offset > 90.0 && offset < 270.0);
561   } else {
562     return false;
563   }
564 }
565
566
567 /**
568  * Return true if the NAV2 TO flag should be active.
569  */
570 bool 
571 FGRadioStack::get_nav2_to_flag () const
572 {
573   if (nav2_inrange) {
574     double offset = fabs(nav2_heading - nav2_radial);
575     if (nav2_loc)
576       return true;
577     else
578       return (offset <= 90.0 || offset >= 270.0);
579   } else {
580     return false;
581   }
582 }
583
584
585 /**
586  * Return true if the NAV2 FROM flag should be active.
587  */
588 bool
589 FGRadioStack::get_nav2_from_flag () const
590 {
591   if (nav2_inrange) {
592     double offset = fabs(nav2_heading - nav2_radial);
593     if (nav2_loc)
594       return false;
595     else
596       return (offset > 90.0 && offset < 270.0);
597   } else {
598     return false;
599   }
600 }
601