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