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
 117                                 // User inputs
 118     fgTie("/radios/nav2/frequencies/selected", this,
 119           &FGRadioStack::get_nav2_freq, &FGRadioStack::set_nav2_freq);
 120     fgTie("/radios/nav2/frequencies/standby", this,
 121           &FGRadioStack::get_nav2_alt_freq, &FGRadioStack::set_nav2_alt_freq);
 122     fgTie("/radios/nav2/radials/selected", this,
 123           &FGRadioStack::get_nav2_sel_radial,
 124           &FGRadioStack::set_nav2_sel_radial);
 125
 126                                 // Radio outputs
 127     fgTie("/radios/nav2/radials/actual", this, &FGRadioStack::get_nav2_radial);
 128     fgTie("/radios/nav2/to-flag", this, &FGRadioStack::get_nav2_to_flag);
 129     fgTie("/radios/nav2/from-flag", this, &FGRadioStack::get_nav2_from_flag);
 130     fgTie("/radios/nav2/in-range", this, &FGRadioStack::get_nav2_inrange);
 131     fgTie("/radios/nav2/dme/distance", this, &FGRadioStack::get_nav2_dme_dist);
 132     fgTie("/radios/nav2/dme/in-range", this,
 133           &FGRadioStack::get_nav2_dme_inrange);
 134
 135                                 // User inputs
 136     fgTie("/radios/adf/frequencies/selected", this,
 137           &FGRadioStack::get_adf_freq, &FGRadioStack::set_adf_freq);
 138     fgTie("/radios/adf/frequencies/standby", this,
 139           &FGRadioStack::get_adf_alt_freq, &FGRadioStack::set_adf_alt_freq);
 140     fgTie("/radios/adf/rotation", this,
 141           &FGRadioStack::get_adf_rotation, &FGRadioStack::set_adf_rotation);
 142 }
 143
 144 void
 145 FGRadioStack::unbind ()
 146 {
 147     fgUntie("/radios/nav1/frequencies/selected");
 148     fgUntie("/radios/nav1/frequencies/standby");
 149     fgUntie("/radios/nav1/radials/actual");
 150     fgUntie("/radios/nav1/radials/selected");
 151     fgUntie("/radios/nav1/to-flag");
 152     fgUntie("/radios/nav1/from-flag");
 153     fgUntie("/radios/nav1/in-range");
 154     fgUntie("/radios/nav1/dme/distance");
 155     fgUntie("/radios/nav1/dme/in-range");
 156
 157     fgUntie("/radios/nav2/frequencies/selected");
 158     fgUntie("/radios/nav2/frequencies/standby");
 159     fgUntie("/radios/nav2/radials/actual");
 160     fgUntie("/radios/nav2/radials/selected");
 161     fgUntie("/radios/nav2/to-flag");
 162     fgUntie("/radios/nav2/from-flag");
 163     fgUntie("/radios/nav2/in-range");
 164     fgUntie("/radios/nav2/dme/distance");
 165     fgUntie("/radios/nav2/dme/in-range");
 166
 167     fgUntie("/radios/adf/frequencies/selected");
 168     fgUntie("/radios/adf/frequencies/standby");
 169     fgUntie("/radios/adf/rotation");
 170 }
 171
 172 // Search the database for the current frequencies given current location
 173 void
 174 FGRadioStack::update()
 175 {
 176     double lon = longitudeVal->getDoubleValue() * DEG_TO_RAD;
 177     double lat = latitudeVal->getDoubleValue() * DEG_TO_RAD;
 178     double elev = altitudeVal->getDoubleValue() * FEET_TO_METER;
 179
 180     need_update = false;
 181
 182     Point3D aircraft = sgGeodToCart( Point3D( lon, lat, elev ) );
 183     Point3D station;
 184     double az1, az2, s;
 185
 186     if ( nav1_valid ) {
 187         station = Point3D( nav1_x, nav1_y, nav1_z );
 188         nav1_loc_dist = aircraft.distance3D( station );
 189
 190         if ( nav1_has_dme ) {
 191             // staightline distance
 192             station = Point3D( nav1_dme_x, nav1_dme_y, nav1_dme_z );
 193             nav1_dme_dist = aircraft.distance3D( station );
 194         } else {
 195             nav1_dme_dist = 0.0;
 196         }
 197
 198         if ( nav1_has_gs ) {
 199             station = Point3D( nav1_gs_x, nav1_gs_y, nav1_gs_z );
 200             nav1_gs_dist = aircraft.distance3D( station );
 201         } else {
 202             nav1_gs_dist = 0.0;
 203         }
 204
 205         if ( nav1_loc_dist < nav1_effective_range * NM_TO_METER ) {
 206             nav1_inrange = true;
 207
 208             // wgs84 heading
 209             geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
 210                                 nav1_loclat, nav1_loclon,
 211                                 &az1, &az2, &s );
 212             nav1_heading = az1 - nav1_offset;
 213             // Alex: nav1_heading = - (az1 - FGBFI::getMagVar() / RAD_TO_DEG);
 214
 215             // cout << " heading = " << nav1_heading
 216             //      << " dist = " << nav1_dist << endl;
 217         } else {
 218             nav1_inrange = false;
 219         }
 220
 221         if ( nav1_loc ) {
 222         } else {
 223             nav1_radial = nav1_sel_radial;
 224         }
 225     } else {
 226         nav1_inrange = false;
 227         nav1_dme_dist = 0.0;
 228         // cout << "not picking up vor. :-(" << endl;
 229     }
 230
 231     if ( nav2_valid ) {
 232         station = Point3D( nav2_x, nav2_y, nav2_z );
 233         nav2_loc_dist = aircraft.distance3D( station );
 234
 235         if ( nav2_has_dme ) {
 236             // staightline distance
 237             station = Point3D( nav2_dme_x, nav2_dme_y, nav2_dme_z );
 238             nav2_dme_dist = aircraft.distance3D( station );
 239         } else {
 240             nav2_dme_dist = 0.0;
 241         }
 242
 243         if ( nav2_has_gs ) {
 244             station = Point3D( nav2_gs_x, nav2_gs_y, nav2_gs_z );
 245             nav2_gs_dist = aircraft.distance3D( station );
 246         } else {
 247             nav2_gs_dist = 0.0;
 248         }
 249
 250         if ( nav2_loc_dist < nav2_effective_range * NM_TO_METER ) {
 251             nav2_inrange = true;
 252
 253             // wgs84 heading
 254             geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
 255                                 nav2_loclat, nav2_loclon,
 256                                 &az1, &az2, &s );
 257             nav2_heading = az1 - nav2_offset;
 258             // Alex: nav2_heading = - (az1 - FGBFI::getMagVar() / RAD_TO_DEG);
 259
 260             // cout << " heading = " << nav2_heading
 261             //      << " dist = " << nav2_dist << endl;
 262         } else {
 263             nav2_inrange = false;
 264         }
 265
 266         if ( !nav2_loc ) {
 267             nav2_radial = nav2_sel_radial;
 268         }
 269     } else {
 270         nav2_inrange = false;
 271         // cout << "not picking up vor. :-(" << endl;
 272     }
 273
 274     // adf
 275     if ( adf_valid ) {
 276         // staightline distance
 277         station = Point3D( adf_x, adf_y, adf_z );
 278         adf_dist = aircraft.distance3D( station );
 279
 280         if ( adf_dist < adf_effective_range * NM_TO_METER ) {
 281             adf_inrange = true;
 282
 283             // wgs84 heading
 284             geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
 285                                 adf_lat, adf_lon,
 286                                 &az1, &az2, &s );
 287             adf_heading = az1;
 288
 289             // cout << " heading = " << nav2_heading
 290             //      << " dist = " << nav2_dist << endl;
 291         } else {
 292             adf_inrange = false;
 293         }
 294     } else {
 295         adf_inrange = false;
 296     }
 297 }
 298
 299
 300 // Update current nav/adf radio stations based on current postition
 301 void FGRadioStack::search ()
 302 {
 303     double lon = longitudeVal->getDoubleValue() * DEG_TO_RAD;
 304     double lat = latitudeVal->getDoubleValue() * DEG_TO_RAD;
 305     double elev = altitudeVal->getDoubleValue() * FEET_TO_METER;
 306
 307     // nav1
 308     FGILS ils;
 309     FGNav nav;
 310
 311     if ( current_ilslist->query( lon, lat, elev, nav1_freq, &ils ) ) {
 312         nav1_valid = true;
 313         nav1_loc = true;
 314         nav1_has_dme = ils.get_has_dme();
 315         nav1_has_gs = ils.get_has_gs();
 316
 317         nav1_loclon = ils.get_loclon();
 318         nav1_loclat = ils.get_loclat();
 319         nav1_gslon = ils.get_gslon();
 320         nav1_gslat = ils.get_gslat();
 321         nav1_dmelon = ils.get_dmelon();
 322         nav1_dmelat = ils.get_dmelat();
 323         nav1_elev = ils.get_gselev();
 324         nav1_offset = 0;
 325         nav1_effective_range = FG_ILS_DEFAULT_RANGE;
 326         nav1_target_gs = ils.get_gsangle();
 327         nav1_radial = ils.get_locheading();
 328         while ( nav1_radial <   0.0 ) { nav1_radial += 360.0; }
 329         while ( nav1_radial > 360.0 ) { nav1_radial -= 360.0; }
 330         nav1_x = ils.get_x();
 331         nav1_y = ils.get_y();
 332         nav1_z = ils.get_z();
 333         nav1_gs_x = ils.get_gs_x();
 334         nav1_gs_y = ils.get_gs_y();
 335         nav1_gs_z = ils.get_gs_z();
 336         nav1_dme_x = ils.get_dme_x();
 337         nav1_dme_y = ils.get_dme_y();
 338         nav1_dme_z = ils.get_dme_z();
 339         // cout << "Found an ils station in range" << endl;
 340         // cout << " id = " << ils.get_locident() << endl;
 341     } else if ( current_navlist->query( lon, lat, elev, nav1_freq, &nav ) ) {
 342         nav1_valid = true;
 343         nav1_loc = false;
 344         nav1_has_dme = nav.get_has_dme();
 345         nav1_has_gs = false;
 346         nav1_loclon = nav.get_lon();
 347         nav1_loclat = nav.get_lat();
 348         nav1_elev = nav.get_elev();
 349         nav1_offset = nav.get_offset();
 350         nav1_effective_range = kludgeRange(nav1_elev, elev, nav.get_range());
 351         nav1_target_gs = 0.0;
 352         nav1_radial = nav1_sel_radial;
 353         nav1_x = nav1_dme_x = nav.get_x();
 354         nav1_y = nav1_dme_y = nav.get_y();
 355         nav1_z = nav1_dme_z = nav.get_z();
 356         // cout << "Found a vor station in range" << endl;
 357         // cout << " id = " << nav.get_ident() << endl;
 358     } else {
 359         nav1_valid = false;
 360         nav1_radial = 0;
 361         nav1_dme_dist = 0;
 362         // cout << "not picking up vor1. :-(" << endl;
 363     }
 364
 365     if ( current_ilslist->query( lon, lat, elev, nav2_freq, &ils ) ) {
 366         nav2_valid = true;
 367         nav2_loc = true;
 368         nav2_has_dme = ils.get_has_dme();
 369         nav2_has_gs = ils.get_has_gs();
 370
 371         nav2_loclon = ils.get_loclon();
 372         nav2_loclat = ils.get_loclat();
 373         nav2_elev = ils.get_gselev();
 374         nav2_offset = 0;
 375         nav2_effective_range = FG_ILS_DEFAULT_RANGE;
 376         nav2_target_gs = ils.get_gsangle();
 377         nav2_radial = ils.get_locheading();
 378         while ( nav2_radial <   0.0 ) { nav2_radial += 360.0; }
 379         while ( nav2_radial > 360.0 ) { nav2_radial -= 360.0; }
 380         nav2_x = ils.get_x();
 381         nav2_y = ils.get_y();
 382         nav2_z = ils.get_z();
 383         nav2_gs_x = ils.get_gs_x();
 384         nav2_gs_y = ils.get_gs_y();
 385         nav2_gs_z = ils.get_gs_z();
 386         nav2_dme_x = ils.get_dme_x();
 387         nav2_dme_y = ils.get_dme_y();
 388         nav2_dme_z = ils.get_dme_z();
 389         // cout << "Found an ils station in range" << endl;
 390         // cout << " id = " << ils.get_locident() << endl;
 391     } else if ( current_navlist->query( lon, lat, elev, nav2_freq, &nav ) ) {
 392         nav2_valid = true;
 393         nav2_loc = false;
 394         nav2_has_dme = nav.get_has_dme();
 395         nav2_has_dme = false;
 396         nav2_loclon = nav.get_lon();
 397         nav2_loclat = nav.get_lat();
 398         nav2_elev = nav.get_elev();
 399         nav2_offset = nav.get_offset();
 400         nav2_effective_range = kludgeRange(nav2_elev, elev, nav.get_range());
 401         nav2_target_gs = 0.0;
 402         nav2_radial = nav2_sel_radial;
 403         nav2_x = nav2_dme_x = nav.get_x();
 404         nav2_y = nav2_dme_y = nav.get_y();
 405         nav2_z = nav2_dme_z = nav.get_z();
 406         // cout << "Found a vor station in range" << endl;
 407         // cout << " id = " << nav.get_ident() << endl;
 408     } else {
 409         nav2_valid = false;
 410         nav2_radial = 0;
 411         nav2_dme_dist = 0;
 412         // cout << "not picking up vor2. :-(" << endl;
 413     }
 414
 415     // adf
 416     if ( current_navlist->query( lon, lat, elev, adf_freq, &nav ) ) {
 417         adf_valid = true;
 418
 419         adf_lon = nav.get_lon();
 420         adf_lat = nav.get_lat();
 421         adf_elev = nav.get_elev();
 422         adf_effective_range = kludgeRange(adf_elev, elev, nav.get_range());
 423         adf_x = nav.get_x();
 424         adf_y = nav.get_y();
 425         adf_z = nav.get_z();
 426         // cout << "Found an adf station in range" << endl;
 427         // cout << " id = " << nav.get_ident() << endl;
 428     } else {
 429         adf_valid = false;
 430         // cout << "not picking up adf. :-(" << endl;
 431     }
 432 }
 433
 434
 435 /**
 436  * Return true if the NAV1 TO flag should be active.
 437  */
 438 bool
 439 FGRadioStack::get_nav1_to_flag () const
 440 {
 441   if (nav1_inrange) {
 442     double offset = fabs(nav1_heading - nav1_radial);
 443     if (nav1_loc)
 444       return (offset <= 8.0 || offset >= 352.0);
 445     else
 446       return (offset <= 20.0 || offset >= 340.0);
 447   } else {
 448     return false;
 449   }
 450 }
 451
 452
 453 /**
 454  * Return true if the NAV1 FROM flag should be active.
 455  */
 456 bool
 457 FGRadioStack::get_nav1_from_flag () const
 458 {
 459   if (nav1_inrange) {
 460     double offset = fabs(nav1_heading - nav1_radial);
 461     if (nav1_loc)
 462       return (offset >= 172.0 && offset <= 188.0);
 463     else
 464       return (offset >= 160.0 && offset <= 200.0);
 465   } else {
 466     return false;
 467   }
 468 }
 469
 470
 471 /**
 472  * Return true if the NAV2 TO flag should be active.
 473  */
 474 bool
 475 FGRadioStack::get_nav2_to_flag () const
 476 {
 477   if (nav2_inrange) {
 478     double offset = fabs(nav2_heading - nav2_radial);
 479     if (nav2_loc)
 480       return (offset <= 8.0 || offset >= 352.0);
 481     else
 482       return (offset <= 20.0 || offset >= 340.0);
 483   } else {
 484     return false;
 485   }
 486 }
 487
 488
 489 /**
 490  * Return true if the NAV2 FROM flag should be active.
 491  */
 492 bool
 493 FGRadioStack::get_nav2_from_flag () const
 494 {
 495   if (nav2_inrange) {
 496     double offset = fabs(nav2_heading - nav2_radial);
 497     if (nav2_loc)
 498       return (offset >= 172.0 && offset <= 188.0);
 499     else
 500       return (offset >= 160.0 && offset <= 200.0);
 501   } else {
 502     return false;
 503   }
 504 }
 505
 506