src/Instrumentation/navradio.cxx

   1 // navradio.cxx -- class to manage a nav radio instance
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 //
   5 // Copyright (C) 2000 - 2002  Curtis L. Olson - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include "navradio.hxx"
  29
  30 #include <sstream>
  31
  32 #include <simgear/sg_inlines.h>
  33 #include <simgear/timing/sg_time.hxx>
  34 #include <simgear/math/vector.hxx>
  35 #include <simgear/math/sg_random.h>
  36 #include <simgear/misc/sg_path.hxx>
  37 #include <simgear/math/sg_geodesy.hxx>
  38 #include <simgear/structure/exception.hxx>
  39 #include <simgear/math/interpolater.hxx>
  40
  41 #include <Navaids/navrecord.hxx>
  42
  43 #include <Airports/runways.hxx>
  44 #include <Navaids/navlist.hxx>
  45 #include <Main/util.hxx>
  46
  47
  48 using std::string;
  49
  50 // General-purpose sawtooth function.  Graph looks like this:
  51 //         /\                                    .
  52 //       \/
  53 // Odd symmetry, inversion symmetry about the origin.
  54 // Unit slope at the origin.
  55 // Max 1, min -1, period 4.
  56 // Two zero-crossings per period, one with + slope, one with - slope.
  57 // Useful for false localizer courses.
  58 static double sawtooth(double xx)
  59 {
  60   return 4.0 * fabs(xx/4.0 + 0.25 - floor(xx/4.0 + 0.75)) - 1.0;
  61 }
  62
  63 // Calculate a unit vector in the horizontal tangent plane
  64 // starting at the given "tail" of the vector and going off
  65 // with the given heading.
  66 static SGVec3d tangentVector(const SGGeod& tail, const SGVec3d& tail_xyz,
  67           const double heading)
  68 {
  69 // The fudge factor here is presumably intended to improve
  70 // numerical stability.  I don't know if it is necessary.
  71 // It gets divided out later.
  72   double fudge(100.0);
  73   SGGeod head;
  74   double az2; // ignored
  75   SGGeodesy::direct(tail, heading, fudge, head, az2);
  76   head.setElevationM(tail.getElevationM());
  77   SGVec3d head_xyz = SGVec3d::fromGeod(head);
  78   return (head_xyz - tail_xyz) * (1.0/fudge);
  79 }
  80
  81 // Create a "serviceable" node with a default value of "true"
  82 SGPropertyNode_ptr createServiceableProp(SGPropertyNode* aParent, const char* aName)
  83 {
  84   SGPropertyNode_ptr n = (aParent->getChild(aName, 0, true)->getChild("serviceable", 0, true));
  85   simgear::props::Type typ = n->getType();
  86   if ((typ == simgear::props::NONE) || (typ == simgear::props::UNSPECIFIED)) {
  87     n->setBoolValue(true);
  88   }
  89   return n;
  90 }
  91
  92 // Constructor
  93 FGNavRadio::FGNavRadio(SGPropertyNode *node) :
  94     lon_node(fgGetNode("/position/longitude-deg", true)),
  95     lat_node(fgGetNode("/position/latitude-deg", true)),
  96     alt_node(fgGetNode("/position/altitude-ft", true)),
  97     is_valid_node(NULL),
  98     power_btn_node(NULL),
  99     freq_node(NULL),
 100     alt_freq_node(NULL),
 101     sel_radial_node(NULL),
 102     vol_btn_node(NULL),
 103     ident_btn_node(NULL),
 104     audio_btn_node(NULL),
 105     backcourse_node(NULL),
 106     nav_serviceable_node(NULL),
 107     cdi_serviceable_node(NULL),
 108     gs_serviceable_node(NULL),
 109     tofrom_serviceable_node(NULL),
 110     dme_serviceable_node(NULL),
 111     fmt_freq_node(NULL),
 112     fmt_alt_freq_node(NULL),
 113     heading_node(NULL),
 114     radial_node(NULL),
 115     recip_radial_node(NULL),
 116     target_radial_true_node(NULL),
 117     target_auto_hdg_node(NULL),
 118     time_to_intercept(NULL),
 119     to_flag_node(NULL),
 120     from_flag_node(NULL),
 121     inrange_node(NULL),
 122     signal_quality_norm_node(NULL),
 123     cdi_deflection_node(NULL),
 124     cdi_deflection_norm_node(NULL),
 125     cdi_xtrack_error_node(NULL),
 126     cdi_xtrack_hdg_err_node(NULL),
 127     has_gs_node(NULL),
 128     loc_node(NULL),
 129     loc_dist_node(NULL),
 130     gs_deflection_node(NULL),
 131     gs_deflection_deg_node(NULL),
 132     gs_deflection_norm_node(NULL),
 133     gs_rate_of_climb_node(NULL),
 134     gs_dist_node(NULL),
 135     gs_inrange_node(NULL),
 136     nav_id_node(NULL),
 137     id_c1_node(NULL),
 138     id_c2_node(NULL),
 139     id_c3_node(NULL),
 140     id_c4_node(NULL),
 141     nav_slaved_to_gps_node(NULL),
 142     gps_cdi_deflection_node(NULL),
 143     gps_to_flag_node(NULL),
 144     gps_from_flag_node(NULL),
 145     gps_has_gs_node(NULL),
 146     play_count(0),
 147     last_time(0),
 148     target_radial(0.0),
 149     horiz_vel(0.0),
 150     last_x(0.0),
 151     last_loc_dist(0.0),
 152     last_xtrack_error(0.0),
 153     _localizerWidth(5.0),
 154     _name(node->getStringValue("name", "nav")),
 155     _num(node->getIntValue("number", 0)),
 156     _time_before_search_sec(-1.0),
 157     _falseCoursesEnabled(true),
 158     _sgr(NULL)
 159 {
 160     SGPath path( globals->get_fg_root() );
 161     SGPath term = path;
 162     term.append( "Navaids/range.term" );
 163     SGPath low = path;
 164     low.append( "Navaids/range.low" );
 165     SGPath high = path;
 166     high.append( "Navaids/range.high" );
 167
 168     term_tbl = new SGInterpTable( term.str() );
 169     low_tbl = new SGInterpTable( low.str() );
 170     high_tbl = new SGInterpTable( high.str() );
 171 }
 172
 173
 174 // Destructor
 175 FGNavRadio::~FGNavRadio()
 176 {
 177     delete term_tbl;
 178     delete low_tbl;
 179     delete high_tbl;
 180 }
 181
 182
 183 void
 184 FGNavRadio::init ()
 185 {
 186     SGSoundMgr *smgr = globals->get_soundmgr();
 187     _sgr = smgr->find("avionics", true);
 188     _sgr->tie_to_listener();
 189
 190     morse.init();
 191
 192     string branch;
 193     branch = "/instrumentation/" + _name;
 194
 195     SGPropertyNode *node = fgGetNode(branch.c_str(), _num, true );
 196
 197     bus_power_node =
 198         fgGetNode(("/systems/electrical/outputs/" + _name).c_str(), true);
 199
 200     // inputs
 201     is_valid_node = node->getChild("data-is-valid", 0, true);
 202     power_btn_node = node->getChild("power-btn", 0, true);
 203     power_btn_node->setBoolValue( true );
 204     vol_btn_node = node->getChild("volume", 0, true);
 205     ident_btn_node = node->getChild("ident", 0, true);
 206     ident_btn_node->setBoolValue( true );
 207     audio_btn_node = node->getChild("audio-btn", 0, true);
 208     audio_btn_node->setBoolValue( true );
 209     backcourse_node = node->getChild("back-course-btn", 0, true);
 210     backcourse_node->setBoolValue( false );
 211
 212     nav_serviceable_node = node->getChild("serviceable", 0, true);
 213     cdi_serviceable_node = createServiceableProp(node, "cdi");
 214     gs_serviceable_node = createServiceableProp(node, "gs");
 215     tofrom_serviceable_node = createServiceableProp(node, "to-from");
 216     dme_serviceable_node = createServiceableProp(node, "dme");
 217
 218     globals->get_props()->tie("sim/realism/false-radio-courses-enabled",
 219       SGRawValuePointer<bool>(&_falseCoursesEnabled));
 220
 221     // frequencies
 222     SGPropertyNode *subnode = node->getChild("frequencies", 0, true);
 223     freq_node = subnode->getChild("selected-mhz", 0, true);
 224     alt_freq_node = subnode->getChild("standby-mhz", 0, true);
 225     fmt_freq_node = subnode->getChild("selected-mhz-fmt", 0, true);
 226     fmt_alt_freq_node = subnode->getChild("standby-mhz-fmt", 0, true);
 227
 228     // radials
 229     subnode = node->getChild("radials", 0, true);
 230     sel_radial_node = subnode->getChild("selected-deg", 0, true);
 231     radial_node = subnode->getChild("actual-deg", 0, true);
 232     recip_radial_node = subnode->getChild("reciprocal-radial-deg", 0, true);
 233     target_radial_true_node = subnode->getChild("target-radial-deg", 0, true);
 234     target_auto_hdg_node = subnode->getChild("target-auto-hdg-deg", 0, true);
 235
 236     // outputs
 237     heading_node = node->getChild("heading-deg", 0, true);
 238     time_to_intercept = node->getChild("time-to-intercept-sec", 0, true);
 239     to_flag_node = node->getChild("to-flag", 0, true);
 240     from_flag_node = node->getChild("from-flag", 0, true);
 241     inrange_node = node->getChild("in-range", 0, true);
 242     signal_quality_norm_node = node->getChild("signal-quality-norm", 0, true);
 243     cdi_deflection_node = node->getChild("heading-needle-deflection", 0, true);
 244     cdi_deflection_norm_node = node->getChild("heading-needle-deflection-norm", 0, true);
 245     cdi_xtrack_error_node = node->getChild("crosstrack-error-m", 0, true);
 246     cdi_xtrack_hdg_err_node
 247         = node->getChild("crosstrack-heading-error-deg", 0, true);
 248     has_gs_node = node->getChild("has-gs", 0, true);
 249     loc_node = node->getChild("nav-loc", 0, true);
 250     loc_dist_node = node->getChild("nav-distance", 0, true);
 251     gs_deflection_node = node->getChild("gs-needle-deflection", 0, true);
 252     gs_deflection_deg_node = node->getChild("gs-needle-deflection-deg", 0, true);
 253     gs_deflection_norm_node = node->getChild("gs-needle-deflection-norm", 0, true);
 254     gs_rate_of_climb_node = node->getChild("gs-rate-of-climb", 0, true);
 255     gs_dist_node = node->getChild("gs-distance", 0, true);
 256     gs_inrange_node = node->getChild("gs-in-range", 0, true);
 257
 258     nav_id_node = node->getChild("nav-id", 0, true);
 259     id_c1_node = node->getChild("nav-id_asc1", 0, true);
 260     id_c2_node = node->getChild("nav-id_asc2", 0, true);
 261     id_c3_node = node->getChild("nav-id_asc3", 0, true);
 262     id_c4_node = node->getChild("nav-id_asc4", 0, true);
 263
 264     node->tie("dme-in-range", SGRawValuePointer<bool>(&_dmeInRange));
 265
 266     // gps slaving support
 267     nav_slaved_to_gps_node = node->getChild("slaved-to-gps", 0, true);
 268     gps_cdi_deflection_node = fgGetNode("/instrumentation/gps/cdi-deflection", true);
 269     gps_to_flag_node = fgGetNode("/instrumentation/gps/to-flag", true);
 270     gps_from_flag_node = fgGetNode("/instrumentation/gps/from-flag", true);
 271     gps_has_gs_node = fgGetNode("/instrumentation/gps/has-gs", true);
 272
 273     std::ostringstream temp;
 274     temp << _name << "nav-ident" << _num;
 275     nav_fx_name = temp.str();
 276     temp << _name << "dme-ident" << _num;
 277     dme_fx_name = temp.str();
 278 }
 279
 280 void
 281 FGNavRadio::bind ()
 282 {
 283
 284 }
 285
 286
 287 void
 288 FGNavRadio::unbind ()
 289 {
 290 }
 291
 292
 293 // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 294 double FGNavRadio::adjustNavRange( double stationElev, double aircraftElev,
 295                                  double nominalRange )
 296 {
 297     if (nominalRange <= 0.0) {
 298       nominalRange = FG_NAV_DEFAULT_RANGE;
 299     }
 300
 301     // extend out actual usable range to be 1.3x the published safe range
 302     const double usability_factor = 1.3;
 303
 304     // assumptions we model the standard service volume, plus
 305     // ... rather than specifying a cylinder, we model a cone that
 306     // contains the cylinder.  Then we put an upside down cone on top
 307     // to model diminishing returns at too-high altitudes.
 308
 309     // altitude difference
 310     double alt = ( aircraftElev * SG_METER_TO_FEET - stationElev );
 311     // cout << "aircraft elev = " << aircraftElev * SG_METER_TO_FEET
 312     //      << " station elev = " << stationElev << endl;
 313
 314     if ( nominalRange < 25.0 + SG_EPSILON ) {
 315         // Standard Terminal Service Volume
 316         return term_tbl->interpolate( alt ) * usability_factor;
 317     } else if ( nominalRange < 50.0 + SG_EPSILON ) {
 318         // Standard Low Altitude Service Volume
 319         // table is based on range of 40, scale to actual range
 320         return low_tbl->interpolate( alt ) * nominalRange / 40.0
 321             * usability_factor;
 322     } else {
 323         // Standard High Altitude Service Volume
 324         // table is based on range of 130, scale to actual range
 325         return high_tbl->interpolate( alt ) * nominalRange / 130.0
 326             * usability_factor;
 327     }
 328 }
 329
 330
 331 // model standard ILS service volumes as per AIM 1-1-9
 332 double FGNavRadio::adjustILSRange( double stationElev, double aircraftElev,
 333                                  double offsetDegrees, double distance )
 334 {
 335     // assumptions we model the standard service volume, plus
 336
 337     // altitude difference
 338     // double alt = ( aircraftElev * SG_METER_TO_FEET - stationElev );
 339 //     double offset = fabs( offsetDegrees );
 340
 341 //     if ( offset < 10 ) {
 342 //      return FG_ILS_DEFAULT_RANGE;
 343 //     } else if ( offset < 35 ) {
 344 //      return 10 + (35 - offset) * (FG_ILS_DEFAULT_RANGE - 10) / 25;
 345 //     } else if ( offset < 45 ) {
 346 //      return (45 - offset);
 347 //     } else if ( offset > 170 ) {
 348 //         return FG_ILS_DEFAULT_RANGE;
 349 //     } else if ( offset > 145 ) {
 350 //      return 10 + (offset - 145) * (FG_ILS_DEFAULT_RANGE - 10) / 25;
 351 //     } else if ( offset > 135 ) {
 352 //         return (offset - 135);
 353 //     } else {
 354 //      return 0;
 355 //     }
 356     return FG_LOC_DEFAULT_RANGE;
 357 }
 358
 359
 360 //////////////////////////////////////////////////////////////////////////
 361 // Update the various nav values based on position and valid tuned in navs
 362 //////////////////////////////////////////////////////////////////////////
 363 void
 364 FGNavRadio::update(double dt)
 365 {
 366   if (dt <= 0.0) {
 367     return; // paused
 368   }
 369
 370   // Create "formatted" versions of the nav frequencies for
 371   // instrument displays.
 372   char tmp[16];
 373   sprintf( tmp, "%.2f", freq_node->getDoubleValue() );
 374   fmt_freq_node->setStringValue(tmp);
 375   sprintf( tmp, "%.2f", alt_freq_node->getDoubleValue() );
 376   fmt_alt_freq_node->setStringValue(tmp);
 377
 378   if (power_btn_node->getBoolValue()
 379       && (bus_power_node->getDoubleValue() > 1.0)
 380       && nav_serviceable_node->getBoolValue() )
 381   {
 382     if (nav_slaved_to_gps_node->getBoolValue()) {
 383       updateGPSSlaved();
 384     } else {
 385       updateReceiver(dt);
 386     }
 387
 388     updateCDI(dt);
 389   } else {
 390     clearOutputs();
 391   }
 392
 393   updateAudio();
 394 }
 395
 396 void FGNavRadio::clearOutputs()
 397 {
 398   inrange_node->setBoolValue( false );
 399   cdi_deflection_node->setDoubleValue( 0.0 );
 400   cdi_deflection_norm_node->setDoubleValue( 0.0 );
 401   cdi_xtrack_error_node->setDoubleValue( 0.0 );
 402   cdi_xtrack_hdg_err_node->setDoubleValue( 0.0 );
 403   time_to_intercept->setDoubleValue( 0.0 );
 404   gs_deflection_node->setDoubleValue( 0.0 );
 405   gs_deflection_deg_node->setDoubleValue(0.0);
 406   gs_deflection_norm_node->setDoubleValue(0.0);
 407   gs_inrange_node->setBoolValue( false );
 408
 409   to_flag_node->setBoolValue( false );
 410   from_flag_node->setBoolValue( false );
 411
 412   _dmeInRange = false;
 413 }
 414
 415 void FGNavRadio::updateReceiver(double dt)
 416 {
 417   // Do a nav station search only once a second to reduce
 418   // unnecessary work. (Also, make sure to do this before caching
 419   // any values!)
 420   _time_before_search_sec -= dt;
 421   if ( _time_before_search_sec < 0 ) {
 422    search();
 423   }
 424
 425   if (!_navaid) {
 426     _cdiDeflection = 0.0;
 427     _cdiCrossTrackErrorM = 0.0;
 428     _toFlag = _fromFlag = false;
 429     _gsNeedleDeflection = 0.0;
 430     _gsNeedleDeflectionNorm = 0.0;
 431     inrange_node->setBoolValue(false);
 432     return;
 433   }
 434
 435   SGGeod pos = SGGeod::fromDegFt(lon_node->getDoubleValue(),
 436                                lat_node->getDoubleValue(),
 437                                alt_node->getDoubleValue());
 438
 439   double nav_elev = _navaid->get_elev_ft();
 440   SGVec3d aircraft = SGVec3d::fromGeod(pos);
 441   double loc_dist = dist(aircraft, _navaid->cart());
 442   loc_dist_node->setDoubleValue( loc_dist );
 443   bool is_loc = loc_node->getBoolValue();
 444   double signal_quality_norm = signal_quality_norm_node->getDoubleValue();
 445
 446   double az2, s;
 447   //////////////////////////////////////////////////////////
 448         // compute forward and reverse wgs84 headings to localizer
 449   //////////////////////////////////////////////////////////
 450   double hdg;
 451   SGGeodesy::inverse(pos, _navaid->geod(), hdg, az2, s);
 452   heading_node->setDoubleValue(hdg);
 453   double radial = az2 - twist;
 454   double recip = radial + 180.0;
 455   SG_NORMALIZE_RANGE(recip, 0.0, 360.0);
 456   radial_node->setDoubleValue( radial );
 457   recip_radial_node->setDoubleValue( recip );
 458
 459   //////////////////////////////////////////////////////////
 460   // compute the target/selected radial in "true" heading
 461   //////////////////////////////////////////////////////////
 462   if (!is_loc) {
 463     target_radial = sel_radial_node->getDoubleValue();
 464   }
 465
 466   // VORs need twist (mag-var) added; ILS/LOCs don't but we set twist to 0.0
 467   double trtrue = target_radial + twist;
 468   SG_NORMALIZE_RANGE(trtrue, 0.0, 360.0);
 469   target_radial_true_node->setDoubleValue( trtrue );
 470
 471   //////////////////////////////////////////////////////////
 472   // adjust reception range for altitude
 473   // FIXME: make sure we are using the navdata range now that
 474   //        it is valid in the data file
 475   //////////////////////////////////////////////////////////
 476         if ( is_loc ) {
 477             double offset = radial - target_radial;
 478       SG_NORMALIZE_RANGE(offset, -180.0, 180.0);
 479             effective_range
 480                 = adjustILSRange( nav_elev, pos.getElevationM(), offset,
 481                                   loc_dist * SG_METER_TO_NM );
 482         } else {
 483             effective_range
 484                 = adjustNavRange( nav_elev, pos.getElevationM(), _navaid->get_range() );
 485         }
 486
 487   double effective_range_m = effective_range * SG_NM_TO_METER;
 488
 489   //////////////////////////////////////////////////////////
 490   // compute signal quality
 491   // 100% within effective_range
 492   // decreases 1/x^2 further out
 493   //////////////////////////////////////////////////////////
 494   double last_signal_quality_norm = signal_quality_norm;
 495
 496   if ( loc_dist < effective_range_m ) {
 497     signal_quality_norm = 1.0;
 498   } else {
 499     double range_exceed_norm = loc_dist/effective_range_m;
 500     signal_quality_norm = 1/(range_exceed_norm*range_exceed_norm);
 501   }
 502
 503   signal_quality_norm = fgGetLowPass( last_signal_quality_norm,
 504            signal_quality_norm, dt );
 505
 506   signal_quality_norm_node->setDoubleValue( signal_quality_norm );
 507   bool inrange = signal_quality_norm > 0.2;
 508   inrange_node->setBoolValue( inrange );
 509
 510   //////////////////////////////////////////////////////////
 511   // compute to/from flag status
 512   //////////////////////////////////////////////////////////
 513   if (inrange) {
 514     if (is_loc) {
 515       _toFlag = true;
 516     } else {
 517       double offset = fabs(radial - target_radial);
 518       _toFlag = (offset > 90.0 && offset < 270.0);
 519     }
 520     _fromFlag = !_toFlag;
 521   } else {
 522     _toFlag = _fromFlag = false;
 523   }
 524
 525   // CDI deflection
 526   double r = target_radial - radial;
 527   SG_NORMALIZE_RANGE(r, -180.0, 180.0);
 528
 529   if ( is_loc ) {
 530     if (_falseCoursesEnabled) {
 531       // The factor of 30.0 gives a period of 120 which gives us 3 cycles and six
 532       // zeros i.e. six courses: one front course, one back course, and four
 533       // false courses. Three of the six are reverse sensing.
 534       _cdiDeflection = 30.0 * sawtooth(r / 30.0);
 535     } else {
 536       // no false courses, but we do need to create a back course
 537       if (fabs(r) > 90.0) { // front course
 538         _cdiDeflection = r - copysign(180.0, r);
 539       } else {
 540         _cdiDeflection = r; // back course
 541       }
 542
 543       _cdiDeflection = -_cdiDeflection; // reverse for outbound radial
 544     } // of false courses disabled
 545
 546     const double VOR_FULL_ARC = 20.0; // VOR is -10 .. 10 degree swing
 547     _cdiDeflection *= VOR_FULL_ARC / _localizerWidth; // increased localiser sensitivity
 548
 549     if (backcourse_node->getBoolValue()) {
 550       _cdiDeflection = -_cdiDeflection;
 551     }
 552   } else {
 553     // handle the TO side of the VOR
 554     if (fabs(r) > 90.0) {
 555       r = ( r<0.0 ? -r-180.0 : -r+180.0 );
 556     }
 557     _cdiDeflection = r;
 558   } // of non-localiser case
 559
 560   SG_CLAMP_RANGE(_cdiDeflection, -10.0, 10.0 );
 561   _cdiDeflection *= signal_quality_norm;
 562
 563   // cross-track error (in metres)
 564   _cdiCrossTrackErrorM = loc_dist * sin(r * SGD_DEGREES_TO_RADIANS);
 565
 566   updateGlideSlope(dt, aircraft, signal_quality_norm);
 567   updateDME(aircraft);
 568
 569   last_loc_dist = loc_dist;
 570 }
 571
 572 void FGNavRadio::updateGlideSlope(double dt, const SGVec3d& aircraft, double signal_quality_norm)
 573 {
 574   _gsNeedleDeflection = 0.0;
 575   if (!_gs || !inrange_node->getBoolValue()) {
 576     gs_dist_node->setDoubleValue( 0.0 );
 577     gs_inrange_node->setBoolValue(false);
 578     return;
 579   }
 580
 581   double gsDist = dist(aircraft, _gsCart);
 582   gs_dist_node->setDoubleValue(gsDist);
 583   bool gsInRange = (gsDist < (_gs->get_range() * SG_NM_TO_METER));
 584   gs_inrange_node->setBoolValue(gsInRange);
 585
 586   if (!gsInRange) {
 587     return;
 588   }
 589
 590   SGVec3d pos = aircraft - _gsCart; // relative vector from gs antenna to aircraft
 591   // The positive GS axis points along the runway in the landing direction,
 592   // toward the far end, not toward the approach area, so we need a - sign here:
 593   double dot_h = -dot(pos, _gsAxis);
 594   double dot_v = dot(pos, _gsVertical);
 595   double angle = atan2(dot_v, dot_h) * SGD_RADIANS_TO_DEGREES;
 596   double deflectionAngle = target_gs - angle;
 597
 598   if (_falseCoursesEnabled) {
 599     // Construct false glideslopes.  The scale factor of 1.5
 600     // in the sawtooth gives a period of 6 degrees.
 601     // There will be zeros at 3, 6r, 9, 12r et cetera
 602     // where "r" indicates reverse sensing.
 603     // This is is consistent with conventional pilot lore
 604     // e.g. http://www.allstar.fiu.edu/aerojava/ILS.htm
 605     // but inconsistent with
 606     // http://www.freepatentsonline.com/3757338.html
 607     //
 608     // It may be that some of each exist.
 609     if (deflectionAngle < 0) {
 610       deflectionAngle = 1.5 * sawtooth(deflectionAngle / 1.5);
 611     } else {
 612       // no false GS below the true GS
 613     }
 614   }
 615
 616   _gsNeedleDeflection = deflectionAngle * 5.0;
 617   _gsNeedleDeflection *= signal_quality_norm;
 618
 619   SG_CLAMP_RANGE(deflectionAngle, -0.7, 0.7);
 620   _gsNeedleDeflectionNorm = (deflectionAngle / 0.7) * signal_quality_norm;
 621
 622   //////////////////////////////////////////////////////////
 623   // Calculate desired rate of climb for intercepting the GS
 624   //////////////////////////////////////////////////////////
 625   double gs_diff = target_gs - angle;
 626   // convert desired vertical path angle into a climb rate
 627   double des_angle = angle - 10 * gs_diff;
 628
 629   // estimate horizontal speed towards ILS in meters per minute
 630   double elapsedDistance = last_x - gsDist;
 631   last_x = gsDist;
 632
 633   double new_vel = ( elapsedDistance / dt );
 634   horiz_vel = 0.75 * horiz_vel + 0.25 * new_vel;
 635
 636   gs_rate_of_climb_node
 637       ->setDoubleValue( -sin( des_angle * SGD_DEGREES_TO_RADIANS )
 638                         * horiz_vel * SG_METER_TO_FEET );
 639 }
 640
 641 void FGNavRadio::updateDME(const SGVec3d& aircraft)
 642 {
 643   if (!_dme || !dme_serviceable_node->getBoolValue()) {
 644     _dmeInRange = false;
 645     return;
 646   }
 647
 648   double dme_distance = dist(aircraft, _dme->cart());
 649   _dmeInRange =  (dme_distance < _dme->get_range() * SG_NM_TO_METER);
 650 }
 651
 652 void FGNavRadio::updateGPSSlaved()
 653 {
 654   has_gs_node->setBoolValue(gps_has_gs_node->getBoolValue());
 655
 656   _toFlag = gps_to_flag_node->getBoolValue();
 657   _fromFlag = gps_from_flag_node->getBoolValue();
 658
 659   inrange_node->setBoolValue(_toFlag | _fromFlag);
 660
 661   _cdiDeflection =  gps_cdi_deflection_node->getDoubleValue();
 662   // clmap to some range (+/- 10 degrees) as the regular deflection
 663   SG_CLAMP_RANGE(_cdiDeflection, -10.0, 10.0 );
 664
 665   _cdiCrossTrackErrorM = 0.0; // FIXME, supply this
 666   _gsNeedleDeflection = 0.0; // FIXME, supply this
 667 }
 668
 669 void FGNavRadio::updateCDI(double dt)
 670 {
 671   bool cdi_serviceable = cdi_serviceable_node->getBoolValue();
 672   bool inrange = inrange_node->getBoolValue();
 673
 674   if (tofrom_serviceable_node->getBoolValue()) {
 675     to_flag_node->setBoolValue(_toFlag);
 676     from_flag_node->setBoolValue(_fromFlag);
 677   } else {
 678     to_flag_node->setBoolValue(false);
 679     from_flag_node->setBoolValue(false);
 680   }
 681
 682   if (!cdi_serviceable) {
 683     _cdiDeflection = 0.0;
 684     _cdiCrossTrackErrorM = 0.0;
 685   }
 686
 687   cdi_deflection_node->setDoubleValue(_cdiDeflection);
 688   cdi_deflection_norm_node->setDoubleValue(_cdiDeflection * 0.1);
 689   cdi_xtrack_error_node->setDoubleValue(_cdiCrossTrackErrorM);
 690
 691   //////////////////////////////////////////////////////////
 692   // compute an approximate ground track heading error
 693   //////////////////////////////////////////////////////////
 694   double hdg_error = 0.0;
 695   if ( inrange && cdi_serviceable ) {
 696     double vn = fgGetDouble( "/velocities/speed-north-fps" );
 697     double ve = fgGetDouble( "/velocities/speed-east-fps" );
 698     double gnd_trk_true = atan2( ve, vn ) * SGD_RADIANS_TO_DEGREES;
 699     if ( gnd_trk_true < 0.0 ) { gnd_trk_true += 360.0; }
 700
 701     SGPropertyNode *true_hdg
 702         = fgGetNode("/orientation/heading-deg", true);
 703     hdg_error = gnd_trk_true - true_hdg->getDoubleValue();
 704
 705     // cout << "ground track = " << gnd_trk_true
 706     //      << " orientation = " << true_hdg->getDoubleValue() << endl;
 707   }
 708   cdi_xtrack_hdg_err_node->setDoubleValue( hdg_error );
 709
 710   //////////////////////////////////////////////////////////
 711   // Calculate a suggested target heading to smoothly intercept
 712   // a nav/ils radial.
 713   //////////////////////////////////////////////////////////
 714
 715   // Now that we have cross track heading adjustment built in,
 716   // we shouldn't need to overdrive the heading angle within 8km
 717   // of the station.
 718   //
 719   // The cdi deflection should be +/-10 for a full range of deflection
 720   // so multiplying this by 3 gives us +/- 30 degrees heading
 721   // compensation.
 722   double adjustment = _cdiDeflection * 3.0;
 723   SG_CLAMP_RANGE( adjustment, -30.0, 30.0 );
 724
 725   // determine the target heading to fly to intercept the
 726   // tgt_radial = target radial (true) + cdi offset adjustmest -
 727   // xtrack heading error adjustment
 728   double nta_hdg;
 729   double trtrue = target_radial_true_node->getDoubleValue();
 730   if ( loc_node->getBoolValue() && backcourse_node->getBoolValue() ) {
 731       // tuned to a localizer and backcourse mode activated
 732       trtrue += 180.0;   // reverse the target localizer heading
 733       SG_NORMALIZE_RANGE(trtrue, 0.0, 360.0);
 734       nta_hdg = trtrue - adjustment - hdg_error;
 735   } else {
 736       nta_hdg = trtrue + adjustment - hdg_error;
 737   }
 738
 739   SG_NORMALIZE_RANGE(nta_hdg, 0.0, 360.0);
 740   target_auto_hdg_node->setDoubleValue( nta_hdg );
 741
 742   //////////////////////////////////////////////////////////
 743   // compute the time to intercept selected radial (based on
 744   // current and last cross track errors and dt
 745   //////////////////////////////////////////////////////////
 746   double t = 0.0;
 747   if ( inrange && cdi_serviceable ) {
 748     double xrate_ms = (last_xtrack_error - _cdiCrossTrackErrorM) / dt;
 749     if ( fabs(xrate_ms) > 0.00001 ) {
 750         t = _cdiCrossTrackErrorM / xrate_ms;
 751     } else {
 752         t = 9999.9;
 753     }
 754   }
 755   time_to_intercept->setDoubleValue( t );
 756
 757   if (!gs_serviceable_node->getBoolValue() ) {
 758     _gsNeedleDeflection = 0.0;
 759     _gsNeedleDeflectionNorm = 0.0;
 760   }
 761   gs_deflection_node->setDoubleValue(_gsNeedleDeflection);
 762   gs_deflection_deg_node->setDoubleValue(_gsNeedleDeflectionNorm * 0.7);
 763   gs_deflection_norm_node->setDoubleValue(_gsNeedleDeflectionNorm);
 764
 765   last_xtrack_error = _cdiCrossTrackErrorM;
 766 }
 767
 768 void FGNavRadio::updateAudio()
 769 {
 770   if (!_navaid || !inrange_node->getBoolValue() || !nav_serviceable_node->getBoolValue()) {
 771     return;
 772   }
 773
 774         // play station ident via audio system if on + ident,
 775         // otherwise turn it off
 776   if (!power_btn_node->getBoolValue()
 777       || !(bus_power_node->getDoubleValue() > 1.0)
 778       || !ident_btn_node->getBoolValue()
 779       || !audio_btn_node->getBoolValue() ) {
 780     _sgr->stop( nav_fx_name );
 781     _sgr->stop( dme_fx_name );
 782     return;
 783   }
 784
 785   SGSoundSample *sound = _sgr->find( nav_fx_name );
 786   double vol = vol_btn_node->getFloatValue();
 787   SG_CLAMP_RANGE(vol, 0.0, 1.0);
 788
 789   if ( sound != NULL ) {
 790     sound->set_volume( vol );
 791   } else {
 792     SG_LOG( SG_COCKPIT, SG_ALERT, "Can't find nav-vor-ident sound" );
 793   }
 794
 795   sound = _sgr->find( dme_fx_name );
 796   if ( sound != NULL ) {
 797     sound->set_volume( vol );
 798   } else {
 799     SG_LOG( SG_COCKPIT, SG_ALERT, "Can't find nav-dme-ident sound" );
 800   }
 801
 802   const int NUM_IDENT_SLOTS = 5;
 803   const time_t SLOT_LENGTH = 5; // seconds
 804
 805   // There are N slots numbered 0 through (NUM_IDENT_SLOTS-1) inclusive.
 806   // Each slot is 5 seconds long.
 807   // Slots 0 is for DME
 808   // the rest are for azimuth.
 809   time_t now = globals->get_time_params()->get_cur_time();
 810   if ((now >= last_time) && (now < last_time + SLOT_LENGTH)) {
 811     return; // wait longer
 812   }
 813
 814   last_time = now;
 815   play_count = ++play_count % NUM_IDENT_SLOTS;
 816
 817   // Previous ident is out of time;  if still playing, cut it off:
 818   _sgr->stop( nav_fx_name );
 819   _sgr->stop( dme_fx_name );
 820   if (play_count == 0) { // the DME slot
 821     if (_dmeInRange && dme_serviceable_node->getBoolValue()) {
 822       // play DME ident
 823       if (vol > 0.05) _sgr->play_once( dme_fx_name );
 824     }
 825   } else { // NAV slot
 826     if (inrange_node->getBoolValue() && nav_serviceable_node->getBoolValue()) {
 827       if (vol > 0.05) _sgr->play_once(nav_fx_name);
 828     }
 829   }
 830 }
 831
 832 FGNavRecord* FGNavRadio::findPrimaryNavaid(const SGGeod& aPos, double aFreqMHz)
 833 {
 834   FGNavRecord* nav = globals->get_navlist()->findByFreq(aFreqMHz, aPos);
 835   if (nav) {
 836     return nav;
 837   }
 838
 839   return globals->get_loclist()->findByFreq(aFreqMHz, aPos);
 840 }
 841
 842 // Update current nav/adf radio stations based on current postition
 843 void FGNavRadio::search()
 844 {
 845   _time_before_search_sec = 1.0;
 846   SGGeod pos = SGGeod::fromDegFt(lon_node->getDoubleValue(),
 847     lat_node->getDoubleValue(), alt_node->getDoubleValue());
 848   double freq = freq_node->getDoubleValue();
 849
 850   FGNavRecord* nav = findPrimaryNavaid(pos, freq);
 851   if (nav == _navaid) {
 852     return; // found the same as last search, we're done
 853   }
 854
 855   _navaid = nav;
 856   char identBuffer[5] = "    ";
 857   if (nav) {
 858     _dme = globals->get_dmelist()->findByFreq(freq, pos);
 859
 860     nav_id_node->setStringValue(nav->get_ident());
 861     strncpy(identBuffer, nav->ident().c_str(), 5);
 862
 863     effective_range = adjustNavRange(nav->get_elev_ft(), pos.getElevationM(), nav->get_range());
 864     loc_node->setBoolValue(nav->type() != FGPositioned::VOR);
 865     twist = nav->get_multiuse();
 866
 867     if (nav->type() == FGPositioned::VOR) {
 868       target_radial = sel_radial_node->getDoubleValue();
 869       _gs = NULL;
 870       has_gs_node->setBoolValue(false);
 871     } else { // ILS or LOC
 872       _gs = globals->get_gslist()->findByFreq(freq, pos);
 873       has_gs_node->setBoolValue(_gs != NULL);
 874       _localizerWidth = localizerWidth(nav);
 875       twist = 0.0;
 876             effective_range = nav->get_range();
 877
 878       target_radial = nav->get_multiuse();
 879       SG_NORMALIZE_RANGE(target_radial, 0.0, 360.0);
 880
 881       if (_gs) {
 882         int tmp = (int)(_gs->get_multiuse() / 1000.0);
 883         target_gs = (double)tmp / 100.0;
 884
 885         // until penaltyForNav goes away, we cannot assume we always pick
 886         // paired LOC/GS trasmsitters. As we pass over a runway threshold, we
 887         // often end up picking the 'wrong' LOC, but the correct GS. To avoid
 888         // breaking the basis computation, ensure we use the GS radial and not
 889         // the (potentially reversed) LOC radial.
 890         double gs_radial = fmod(_gs->get_multiuse(), 1000.0);
 891         SG_NORMALIZE_RANGE(gs_radial, 0.0, 360.0);
 892
 893         // GS axis unit tangent vector
 894         // (along the runway)
 895         _gsCart = _gs->cart();
 896         _gsAxis = tangentVector(_gs->geod(), _gsCart, gs_radial);
 897
 898         // GS baseline unit tangent vector
 899         // (perpendicular to the runay along the ground)
 900         SGVec3d baseline = tangentVector(_gs->geod(), _gsCart, gs_radial + 90.0);
 901         _gsVertical = cross(baseline, _gsAxis);
 902       } // of have glideslope
 903     } // of found LOC or ILS
 904
 905     audioNavidChanged();
 906   } else { // found nothing
 907     _gs = NULL;
 908     _dme = NULL;
 909     nav_id_node->setStringValue("");
 910
 911     _sgr->remove( nav_fx_name );
 912     _sgr->remove( dme_fx_name );
 913   }
 914
 915   is_valid_node->setBoolValue(nav != NULL);
 916   id_c1_node->setIntValue( (int)identBuffer[0] );
 917   id_c2_node->setIntValue( (int)identBuffer[1] );
 918   id_c3_node->setIntValue( (int)identBuffer[2] );
 919   id_c4_node->setIntValue( (int)identBuffer[3] );
 920 }
 921
 922 double FGNavRadio::localizerWidth(FGNavRecord* aLOC)
 923 {
 924   FGRunway* rwy = aLOC->runway();
 925   assert(rwy);
 926
 927   SGVec3d thresholdCart(SGVec3d::fromGeod(rwy->threshold()));
 928   double axisLength = dist(aLOC->cart(), thresholdCart);
 929   double landingLength = dist(thresholdCart, SGVec3d::fromGeod(rwy->end()));
 930
 931 // Reference: http://dcaa.slv.dk:8000/icaodocs/
 932 // ICAO standard width at threshold is 210 m = 689 feet = approx 700 feet.
 933 // ICAO 3.1.1 half course = DDM = 0.0775
 934 // ICAO 3.1.3.7.1 Sensitivity 0.00145 DDM/m at threshold
 935 //  implies peg-to-peg of 214 m ... we will stick with 210.
 936 // ICAO 3.1.3.7.1 "Course sector angle shall not exceed 6 degrees."
 937
 938 // Very short runway:  less than 1200 m (4000 ft) landing length:
 939   if (landingLength < 1200.0) {
 940 // ICAO fudges localizer sensitivity for very short runways.
 941 // This produces a non-monotonic sensitivity-versus length relation.
 942     axisLength += 1050.0;
 943   }
 944
 945 // Example: very short: San Diego   KMYF (Montgomery Field) ILS RWY 28R
 946 // Example: short:      Tom's River KMJX (Robert J. Miller) ILS RWY 6
 947 // Example: very long:  Denver      KDEN (Denver)           ILS RWY 16R
 948   double raw_width = 210.0 / axisLength * SGD_RADIANS_TO_DEGREES;
 949   return raw_width < 6.0? raw_width : 6.0;
 950 }
 951
 952 void FGNavRadio::audioNavidChanged()
 953 {
 954   if (_sgr->exists(nav_fx_name)) {
 955                 _sgr->remove(nav_fx_name);
 956   }
 957
 958   try {
 959     string trans_ident(_navaid->get_trans_ident());
 960     SGSoundSample* sound = morse.make_ident(trans_ident, LO_FREQUENCY);
 961     sound->set_volume( 0.3 );
 962     if (!_sgr->add( sound, nav_fx_name )) {
 963       SG_LOG(SG_COCKPIT, SG_WARN, "Failed to add v1-vor-ident sound");
 964     }
 965
 966           if ( _sgr->exists( dme_fx_name ) ) {
 967       _sgr->remove( dme_fx_name );
 968     }
 969
 970     sound = morse.make_ident( trans_ident, HI_FREQUENCY );
 971     sound->set_volume( 0.3 );
 972     _sgr->add( sound, dme_fx_name );
 973
 974           int offset = (int)(sg_random() * 30.0);
 975           play_count = offset / 4;
 976     last_time = globals->get_time_params()->get_cur_time() - offset;
 977   } catch (sg_io_exception& e) {
 978     SG_LOG(SG_GENERAL, SG_ALERT, e.getFormattedMessage());
 979   }
 980 }