src/Instrumentation/newnavradio.cxx

   1 // navradio.cxx -- class to manage a nav radio instance
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 // Rewritten by Torsten Dreyer, August 2011
   5 //
   6 // Copyright (C) 2000 - 2011  Curtis L. Olson - http://www.flightgear.org/~curt
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21 //
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include "newnavradio.hxx"
  28
  29 #include <assert.h>
  30 #include <boost/foreach.hpp>
  31
  32 #include <simgear/math/interpolater.hxx>
  33 #include <simgear/sg_inlines.h>
  34 #include <simgear/props/propertyObject.hxx>
  35 #include <simgear/misc/strutils.hxx>
  36
  37 #include <Main/fg_props.hxx>
  38 #include <Navaids/navlist.hxx>
  39 #include <Sound/audioident.hxx>
  40
  41 #include "navradio.hxx"
  42
  43
  44 namespace Instrumentation {
  45
  46 using simgear::PropertyObject;
  47
  48 /* --------------The Navigation Indicator ----------------------------- */
  49
  50 class NavIndicator {
  51 public:
  52     NavIndicator( SGPropertyNode * rootNode ) :
  53       _cdi( rootNode->getNode("heading-needle-deflection", true ) ),
  54       _cdiNorm( rootNode->getNode("heading-needle-deflection-norm", true ) ),
  55       _course( rootNode->getNode("radials/selected-deg", true ) ),
  56       _toFlag( rootNode->getNode("to-flag", true ) ),
  57       _fromFlag( rootNode->getNode("from-flag", true ) ),
  58       _signalQuality( rootNode->getNode("signal-quality-norm", true ) ),
  59       _hasGS( rootNode->getNode("has-gs", true ) ),
  60       _gsDeflection(rootNode->getNode("gs-needle-deflection", true )),
  61       _gsDeflectionDeg(rootNode->getNode("gs-needle-deflection-deg", true )),
  62       _gsDeflectionNorm(rootNode->getNode("gs-needle-deflection-norm", true ))
  63   {
  64   }
  65
  66   virtual ~NavIndicator() {}
  67
  68   /**
  69    * set the normalized CDI deflection
  70    * @param norm the cdi deflection normalized [-1..1]
  71    */
  72   void setCDI( double norm )
  73   {
  74       _cdi = norm * 10.0;
  75       _cdiNorm = norm;
  76   }
  77
  78   /**
  79    * set the normalized GS deflection
  80    * @param norm the gs deflection normalized to [-1..1]
  81    */
  82   void setGS( double norm )
  83   {
  84       _gsDeflectionNorm = norm;
  85       _gsDeflectionDeg = norm * 0.7;
  86       _gsDeflection = norm * 3.5;
  87   }
  88
  89   void setGS( bool enabled )
  90   {
  91       _hasGS = enabled;
  92       if( !enabled ) {
  93         setGS( 0.0 );
  94       }
  95   }
  96
  97   void showFrom( bool on )
  98   {
  99       _fromFlag = on;
 100   }
 101
 102   void showTo( bool on )
 103   {
 104       _toFlag = on;
 105   }
 106
 107   void setSelectedCourse( double course )
 108   {
 109       _course = course;
 110   }
 111
 112   double getSelectedCourse() const
 113   {
 114       return SGMiscd::normalizePeriodic(0.0, 360.0, _course );
 115   }
 116
 117   void setSignalQuality( double signalQuality )
 118   {
 119       _signalQuality = signalQuality;
 120   }
 121
 122 private:
 123   PropertyObject<double> _cdi;
 124   PropertyObject<double> _cdiNorm;
 125   PropertyObject<double> _course;
 126   PropertyObject<double> _toFlag;
 127   PropertyObject<double> _fromFlag;
 128   PropertyObject<double> _signalQuality;
 129   PropertyObject<double> _hasGS;
 130   PropertyObject<double> _gsDeflection;
 131   PropertyObject<double> _gsDeflectionDeg;
 132   PropertyObject<double> _gsDeflectionNorm;
 133 };
 134
 135 /* ---------------------------------------------------------------- */
 136
 137 class NavRadioComponent {
 138 public:
 139   NavRadioComponent( const std::string & name, SGPropertyNode_ptr rootNode );
 140   virtual ~NavRadioComponent();
 141
 142   virtual void   update( double dt, const SGGeod & aircraftPosition );
 143   virtual void   search( double frequency, const SGGeod & aircraftPosition );
 144   virtual double getRange_nm( const SGGeod & aircraftPosition );
 145   virtual void   display( NavIndicator & navIndicator ) = 0;
 146   virtual bool   valid() const { return NULL != _navRecord && true == _serviceable; }
 147   virtual const std::string getIdent() const { return _ident; }
 148
 149 protected:
 150   virtual double computeSignalQuality_norm( const SGGeod & aircraftPosition );
 151   virtual FGNavList::TypeFilter* getNavaidFilter() = 0;
 152
 153   // General-purpose sawtooth function.  Graph looks like this:
 154   //         /\                                    .
 155   //       \/
 156   // Odd symmetry, inversion symmetry about the origin.
 157   // Unit slope at the origin.
 158   // Max 1, min -1, period 4.
 159   // Two zero-crossings per period, one with + slope, one with - slope.
 160   // Useful for false localizer courses.
 161   static double sawtooth(double xx)
 162   {
 163     return 4.0 * fabs(xx/4.0 + 0.25 - floor(xx/4.0 + 0.75)) - 1.0;
 164   }
 165
 166   SGPropertyNode_ptr _rootNode;
 167   const std::string _name;
 168   FGNavRecord * _navRecord;
 169   PropertyObject<bool>   _serviceable;
 170   PropertyObject<double> _signalQuality_norm;
 171   PropertyObject<double> _trueBearingTo_deg;
 172   PropertyObject<double> _trueBearingFrom_deg;
 173   PropertyObject<double> _trackDistance_m;
 174   PropertyObject<double> _slantDistance_m;
 175   PropertyObject<double> _heightAboveStation_ft;
 176   PropertyObject<string> _ident;
 177   PropertyObject<bool>   _inRange;
 178   PropertyObject<double> _range_nm;
 179 };
 180
 181 class NavRadioComponentWithIdent : public NavRadioComponent {
 182 public:
 183   NavRadioComponentWithIdent( const std::string & name, SGPropertyNode_ptr rootNode, AudioIdent * audioIdent );
 184   virtual ~NavRadioComponentWithIdent();
 185   void update( double dt, const SGGeod & aircraftPosition );
 186 protected:
 187   static std::string getIdentString( const std::string & name, int index );
 188 private:
 189   AudioIdent * _audioIdent;
 190   PropertyObject<double> _identVolume;
 191   PropertyObject<bool>   _identEnabled;
 192 };
 193
 194 std::string NavRadioComponentWithIdent::getIdentString( const std::string & name, int index )
 195 {
 196   std::ostringstream temp;
 197   temp << name << "-ident-" << index;
 198   return temp.str();
 199 }
 200
 201 NavRadioComponentWithIdent::NavRadioComponentWithIdent( const std::string & name, SGPropertyNode_ptr rootNode, AudioIdent * audioIdent ) :
 202   NavRadioComponent( name, rootNode ),
 203   _audioIdent( audioIdent ),
 204   _identVolume( rootNode->getNode(name,true)->getNode("ident-volume",true) ),
 205   _identEnabled( rootNode->getNode(name,true)->getNode("ident-enabled",true) )
 206 {
 207   _audioIdent->init();
 208
 209 }
 210 NavRadioComponentWithIdent::~NavRadioComponentWithIdent()
 211 {
 212   delete _audioIdent;
 213 }
 214
 215 void NavRadioComponentWithIdent::update( double dt, const SGGeod & aircraftPosition )
 216 {
 217   NavRadioComponent::update( dt, aircraftPosition );
 218   _audioIdent->update( dt );
 219
 220   if( false == ( valid() && _identEnabled && _signalQuality_norm > 0.1 ) ) {
 221       _audioIdent->setIdent("", 0.0 );
 222       return;
 223   }
 224   _audioIdent->setIdent( _ident, SGMiscd::clip(_identVolume, 0.0, 1.0) );
 225 }
 226
 227 NavRadioComponent::NavRadioComponent( const std::string & name, SGPropertyNode_ptr rootNode ) :
 228   _rootNode(rootNode),
 229   _name(name),
 230   _navRecord(NULL),
 231   _serviceable( rootNode->getNode(name,true)->getNode("serviceable",true) ),
 232   _signalQuality_norm( rootNode->getNode(name,true)->getNode("signal-quality-norm",true) ),
 233   _trueBearingTo_deg( rootNode->getNode(name,true)->getNode("true-bearing-to-deg",true) ),
 234   _trueBearingFrom_deg( rootNode->getNode(name,true)->getNode("true-bearing-from-deg",true) ),
 235   _trackDistance_m( rootNode->getNode(name,true)->getNode("track-distance-m",true) ),
 236   _slantDistance_m( rootNode->getNode(name,true)->getNode("slant-distance-m",true) ),
 237   _heightAboveStation_ft( rootNode->getNode(name,true)->getNode("height-above-station-ft",true) ),
 238   _ident( rootNode->getNode(name,true)->getNode("ident",true) ),
 239   _inRange( rootNode->getNode(name,true)->getNode("in-range",true) ),
 240   _range_nm( rootNode->getNode(_name,true)->getNode("range-nm",true) )
 241 {
 242   simgear::props::Type typ = _serviceable.node()->getType();
 243   if ((typ == simgear::props::NONE) || (typ == simgear::props::UNSPECIFIED))
 244     _serviceable = true;
 245 }
 246
 247 NavRadioComponent::~NavRadioComponent()
 248 {
 249 }
 250
 251 double NavRadioComponent::getRange_nm( const SGGeod & aircraftPosition )
 252 {
 253   if( _navRecord == NULL ) return 0.0; // no station: no range
 254   double d = _navRecord->get_range();
 255   if( d <= SGLimitsd::min() ) return 25.0; // no configured range: arbitrary number
 256   return d; // configured range
 257 }
 258
 259 void NavRadioComponent::search( double frequency, const SGGeod & aircraftPosition )
 260 {
 261   _navRecord = FGNavList::findByFreq(frequency, aircraftPosition, getNavaidFilter() );
 262   if( NULL == _navRecord ) {
 263     SG_LOG(SG_INSTR,SG_ALERT, "No " << _name << " available at " << frequency );
 264     _ident = "";
 265     return;
 266   }
 267   SG_LOG(SG_INSTR,SG_ALERT, "Using " << _name << "'" << _navRecord->get_ident() << "' for " << frequency );
 268   _ident = _navRecord->ident();
 269 }
 270
 271 double NavRadioComponent::computeSignalQuality_norm( const SGGeod & aircraftPosition )
 272 {
 273   if( false == valid() ) return 0.0;
 274
 275   double distance_nm = _slantDistance_m * SG_METER_TO_NM;
 276   double range_nm = _range_nm;
 277
 278   // assume signal quality is 100% up to the published range and
 279   // decay with the distance squared further out
 280   if ( distance_nm <= range_nm ) return 1.0;
 281   return range_nm*range_nm/(distance_nm*distance_nm);
 282 }
 283
 284 void NavRadioComponent::update( double dt, const SGGeod & aircraftPosition )
 285 {
 286     if( false == valid() ) {
 287       _signalQuality_norm = 0.0;
 288       _trueBearingTo_deg = 0.0;
 289       _trueBearingFrom_deg = 0.0;
 290       _trackDistance_m = 0.0;
 291       _slantDistance_m = 0.0;
 292       return;
 293     }
 294
 295     _slantDistance_m = dist(_navRecord->cart(), SGVec3d::fromGeod(aircraftPosition));
 296
 297     double az1 = 0.0, az2 = 0.0, dist = 0.0;
 298     SGGeodesy::inverse(aircraftPosition, _navRecord->geod(), az1, az2, dist );
 299     _trueBearingTo_deg = az1; _trueBearingFrom_deg = az2; _trackDistance_m = dist;
 300     _heightAboveStation_ft = SGMiscd::max(0.0, aircraftPosition.getElevationFt() - _navRecord->get_elev_ft());
 301
 302     _range_nm = getRange_nm(aircraftPosition);
 303     _signalQuality_norm = computeSignalQuality_norm( aircraftPosition );
 304     _inRange = _signalQuality_norm > 0.2;
 305 }
 306
 307 /* ---------------------------------------------------------------- */
 308
 309 static std::string VORTablePath( const char * name )
 310 {
 311     SGPath path( globals->get_fg_root() );
 312     path.append( "Navaids" );
 313     path.append(name);
 314     return path.str();
 315 }
 316
 317 class VOR : public NavRadioComponentWithIdent {
 318 public:
 319   VOR( SGPropertyNode_ptr rootNode);
 320   virtual ~VOR();
 321   virtual void update( double dt, const SGGeod & aircraftPosition );
 322   virtual void display( NavIndicator & navIndicator );
 323   virtual double getRange_nm(const SGGeod & aircraftPosition);
 324 protected:
 325   virtual double computeSignalQuality_norm( const SGGeod & aircraftPosition );
 326   virtual FGNavList::TypeFilter* getNavaidFilter();
 327
 328 private:
 329   double _totalTime;
 330   class ServiceVolume {
 331   public:
 332     ServiceVolume() :
 333       term_tbl(VORTablePath("range.term")),
 334       low_tbl(VORTablePath("range.low")),
 335       high_tbl(VORTablePath("range.high")) {
 336     }
 337     double adjustRange( double height_ft, double nominalRange_nm );
 338
 339   private:
 340     SGInterpTable term_tbl;
 341     SGInterpTable low_tbl;
 342     SGInterpTable high_tbl;
 343   } _serviceVolume;
 344
 345   PropertyObject<double> _radial;
 346   PropertyObject<double> _radialInbound;
 347 };
 348
 349 // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 350 double VOR::ServiceVolume::adjustRange( double height_ft, double nominalRange_nm )
 351 {
 352     if (nominalRange_nm < SGLimitsd::min() )
 353       nominalRange_nm = FG_NAV_DEFAULT_RANGE;
 354
 355     // extend out actual usable range to be 1.3x the published safe range
 356     const double usability_factor = 1.3;
 357
 358     // assumptions we model the standard service volume, plus
 359     // ... rather than specifying a cylinder, we model a cone that
 360     // contains the cylinder.  Then we put an upside down cone on top
 361     // to model diminishing returns at too-high altitudes.
 362
 363     if ( nominalRange_nm < 25.0 + SG_EPSILON ) {
 364         // Standard Terminal Service Volume
 365         return term_tbl.interpolate( height_ft ) * usability_factor;
 366     } else if ( nominalRange_nm < 50.0 + SG_EPSILON ) {
 367         // Standard Low Altitude Service Volume
 368         // table is based on range of 40, scale to actual range
 369         return low_tbl.interpolate( height_ft ) * nominalRange_nm / 40.0
 370             * usability_factor;
 371     } else {
 372         // Standard High Altitude Service Volume
 373         // table is based on range of 130, scale to actual range
 374         return high_tbl.interpolate( height_ft ) * nominalRange_nm / 130.0
 375             * usability_factor;
 376     }
 377 }
 378
 379 VOR::VOR( SGPropertyNode_ptr rootNode) :
 380   NavRadioComponentWithIdent("vor", rootNode, new VORAudioIdent(getIdentString(string("vor"), rootNode->getIndex()))),
 381   _totalTime(0.0),
 382   _radial( rootNode->getNode(_name,true)->getNode("radial",true) ),
 383   _radialInbound( rootNode->getNode(_name,true)->getNode("radial-inbound",true) )
 384 {
 385 }
 386
 387 VOR::~VOR()
 388 {
 389 }
 390
 391 double VOR::getRange_nm( const SGGeod & aircraftPosition )
 392 {
 393   return _serviceVolume.adjustRange( _heightAboveStation_ft, _navRecord->get_range() );
 394 }
 395
 396 FGNavList::TypeFilter* VOR::getNavaidFilter()
 397 {
 398   static FGNavList::TypeFilter filter(FGPositioned::VOR);
 399   return &filter;
 400 }
 401
 402 double VOR::computeSignalQuality_norm( const SGGeod & aircraftPosition )
 403 {
 404   // apply cone of confusion. Some sources say it's opening angle is 53deg, others estimate
 405   // a diameter of 1NM per 6000ft (approx. 45deg). ICAO Annex 10 says minimum 40deg.
 406   // We use 1NM@6000ft and a distance-squared
 407   // function to make signal-quality=100% 0.5NM@6000ft from the center and zero overhead
 408   double cone_of_confusion_width = 0.5 * _heightAboveStation_ft / 6000.0 * SG_NM_TO_METER;
 409   if( _trackDistance_m < cone_of_confusion_width ) {
 410     double d = cone_of_confusion_width <= SGLimitsd::min() ? 1 :
 411               (1 - _trackDistance_m/cone_of_confusion_width);
 412     return 1-d*d;
 413   }
 414
 415   // use default decay function outside the cone of confusion
 416   return NavRadioComponentWithIdent::computeSignalQuality_norm( aircraftPosition );
 417 }
 418
 419 void VOR::update( double dt, const SGGeod & aircraftPosition )
 420 {
 421   _totalTime += dt;
 422   NavRadioComponentWithIdent::update( dt, aircraftPosition );
 423
 424   if( false == valid() ) {
 425       _radial = 0.0;
 426       return;
 427   }
 428
 429   // an arbitrary error function
 430   double error = 0.5*(sin(_totalTime/11.0) + sin(_totalTime/23.0));
 431
 432   // add 1% error at 100% signal-quality
 433   // add 50% error at  0% signal-quality
 434   // of full deflection (+/-10deg)
 435   double e = 10.0 * ( 0.01 + (1-_signalQuality_norm) * 0.49 ) * error;
 436
 437   // compute magnetic bearing from the station (aka current radial)
 438   double r = SGMiscd::normalizePeriodic(0.0, 360.0, _trueBearingFrom_deg - _navRecord->get_multiuse() + e );
 439
 440   _radial = r;
 441   _radialInbound = SGMiscd::normalizePeriodic(0.0,360.0, 180.0 + _radial);
 442 }
 443
 444 void VOR::display( NavIndicator & navIndicator )
 445 {
 446   if( false == valid() ) return;
 447
 448   double offset = SGMiscd::normalizePeriodic(-180.0,180.0,_radial - navIndicator.getSelectedCourse());
 449   bool to = fabs(offset) >= 90.0;
 450
 451   if( to ) offset = -offset + copysign(180.0,offset);
 452
 453   navIndicator.showTo( to );
 454   navIndicator.showFrom( !to );
 455   // normalize to +/- 1.0 for +/- 10deg, decrease deflection with decreasing signal
 456   navIndicator.setCDI( SGMiscd::clip( -offset/10.0, -1.0, 1.0 ) * _signalQuality_norm );
 457   navIndicator.setSignalQuality( _signalQuality_norm );
 458 }
 459
 460 /* ---------------------------------------------------------------- */
 461 class LOC : public NavRadioComponentWithIdent {
 462 public:
 463   LOC( SGPropertyNode_ptr rootNode );
 464   virtual ~LOC();
 465   virtual void update( double dt, const SGGeod & aircraftPosition );
 466   virtual void search( double frequency, const SGGeod & aircraftPosition );
 467   virtual void display( NavIndicator & navIndicator );
 468   virtual double getRange_nm(const SGGeod & aircraftPosition);
 469
 470 protected:
 471   virtual double computeSignalQuality_norm( const SGGeod & aircraftPosition );
 472   virtual FGNavList::TypeFilter* getNavaidFilter();
 473
 474 private:
 475   class ServiceVolume {
 476   public:
 477       ServiceVolume();
 478       double adjustRange( double azimuthAngle_deg, double elevationAngle_deg );
 479   private:
 480       SGInterpTable _azimuthTable;
 481       SGInterpTable _elevationTable;
 482   } _serviceVolume;
 483   PropertyObject<double> _localizerOffset_norm;
 484   PropertyObject<double> _localizerWidth_deg;
 485 };
 486
 487 LOC::ServiceVolume::ServiceVolume()
 488 {
 489 // maybe this: http://www.tpub.com/content/aviation2/P-1244/P-12440125.htm
 490   // ICAO Annex 10 - 3.1.3.2.2: The emission from the localizer
 491   // shall be horizontally polarized
 492   // very rough abstraction of a 5-element yagi antenna's
 493   // E-plane radiation diagram
 494   _azimuthTable.addEntry(   0.0, 1.0 );
 495   _azimuthTable.addEntry(  10.0, 1.0 );
 496   _azimuthTable.addEntry(  30.0, 0.75 );
 497   _azimuthTable.addEntry(  40.0, 0.50 );
 498   _azimuthTable.addEntry(  50.0, 0.20 );
 499   _azimuthTable.addEntry(  60.0, 0.10 );
 500   _azimuthTable.addEntry(  70.0, 0.20 );
 501   _azimuthTable.addEntry(  80.0, 0.10 );
 502   _azimuthTable.addEntry(  90.0, 0.05 );
 503   _azimuthTable.addEntry( 105.0, 0.10 );
 504   _azimuthTable.addEntry( 130.0, 0.05 );
 505   _azimuthTable.addEntry( 150.0, 0.30 );
 506   _azimuthTable.addEntry( 160.0, 0.40 );
 507   _azimuthTable.addEntry( 170.0, 0.50 );
 508   _azimuthTable.addEntry( 180.0, 0.50 );
 509
 510   _elevationTable.addEntry(   0.0, 0.1 );
 511   _elevationTable.addEntry(  1.05, 1.0 );
 512   _elevationTable.addEntry(  7.00, 1.0 );
 513   _elevationTable.addEntry(  45.0, 0.3 );
 514   _elevationTable.addEntry(  90.0, 0.1 );
 515   _elevationTable.addEntry( 180.0, 0.01 );
 516 }
 517
 518 double LOC::ServiceVolume::adjustRange( double azimuthAngle_deg, double elevationAngle_deg )
 519 {
 520     return _azimuthTable.interpolate( fabs(azimuthAngle_deg) ) *
 521         _elevationTable.interpolate( fabs(elevationAngle_deg) );
 522 }
 523
 524 LOC::LOC( SGPropertyNode_ptr rootNode) :
 525   NavRadioComponentWithIdent("loc", rootNode, new LOCAudioIdent(getIdentString(string("loc"), rootNode->getIndex()))),
 526   _serviceVolume(),
 527   _localizerOffset_norm( rootNode->getNode(_name,true)->getNode("offset-norm",true) ),
 528   _localizerWidth_deg( rootNode->getNode(_name,true)->getNode("width-deg",true) )
 529 {
 530 }
 531
 532 LOC::~LOC()
 533 {
 534 }
 535
 536 FGNavList::TypeFilter* LOC::getNavaidFilter()
 537 {
 538   return FGNavList::locFilter();
 539 }
 540
 541 void LOC::search( double frequency, const SGGeod & aircraftPosition )
 542 {
 543   NavRadioComponentWithIdent::search( frequency, aircraftPosition );
 544   if( false == valid() ) {
 545       _localizerWidth_deg = 0.0;
 546       return;
 547   }
 548
 549   // cache slightly expensive value,
 550   // sanitized in FGNavRecord::localizerWidth() to  never become zero
 551   _localizerWidth_deg = _navRecord->localizerWidth();
 552 }
 553
 554 /* Localizer coverage (ICAO Annex 10 Volume I 3.1.3.3
 555   25NM within +/-10 deg from the front course line
 556   17NM between 10 and 35deg from the front course line
 557   10NM outside of +/- 35deg  if coverage is provided
 558   at and above a height of 2000ft above threshold or
 559   1000ft above the highest point within intermediate
 560   and final approach areas. Upper limit is a surface
 561   extending outward from the localizer and inclined at
 562   7 degrees above the horizontal
 563  */
 564 double LOC::getRange_nm(const SGGeod & aircraftPosition)
 565 {
 566   double elevationAngle = ::atan2(_heightAboveStation_ft*SG_FEET_TO_METER, _trackDistance_m)*SG_RADIANS_TO_DEGREES;
 567   double azimuthAngle = SGMiscd::normalizePeriodic( -180.0, 180.0, _trueBearingFrom_deg + 180.0 - _navRecord->get_multiuse() );
 568
 569   // looks like our navrecord declared range is based on 10NM?
 570   return  _navRecord->get_range() * _serviceVolume.adjustRange( azimuthAngle, elevationAngle );
 571 }
 572
 573 double LOC::computeSignalQuality_norm( const SGGeod & aircraftPosition )
 574 {
 575   return NavRadioComponentWithIdent::computeSignalQuality_norm( aircraftPosition );
 576 }
 577
 578 void LOC::update( double dt, const SGGeod & aircraftPosition )
 579 {
 580   NavRadioComponentWithIdent::update( dt, aircraftPosition );
 581
 582   if( false == valid() ) {
 583     _localizerOffset_norm = 0.0;
 584     return;
 585   }
 586
 587   double offset = SGMiscd::normalizePeriodic( -180.0, 180.0, _trueBearingFrom_deg + 180.0 - _navRecord->get_multiuse() );
 588
 589   // The factor of 30.0 gives a period of 120 which gives us 3 cycles and six
 590   // zeros i.e. six courses: one front course, one back course, and four
 591   // false courses. Three of the six are reverse sensing.
 592   offset = 30.0 * sawtooth(offset / 30.0);
 593
 594   // normalize offset to the localizer width, scale and clip to [-1..1]
 595   offset = SGMiscd::clip( 2.0 * offset / _localizerWidth_deg, -1.0, 1.0 );
 596
 597   _localizerOffset_norm = offset;
 598 }
 599
 600 void LOC::display( NavIndicator & navIndicator )
 601 {
 602   if( false == valid() )
 603     return;
 604
 605   navIndicator.showTo( true );
 606   navIndicator.showFrom( false );
 607
 608   navIndicator.setCDI( _localizerOffset_norm * _signalQuality_norm );
 609   navIndicator.setSignalQuality( _signalQuality_norm );
 610 }
 611
 612 class GS : public NavRadioComponent {
 613 public:
 614   GS( SGPropertyNode_ptr rootNode);
 615   virtual ~GS();
 616   virtual void update( double dt, const SGGeod & aircraftPosition );
 617   virtual void search( double frequency, const SGGeod & aircraftPosition );
 618   virtual void display( NavIndicator & navIndicator );
 619
 620   virtual double getRange_nm(const SGGeod & aircraftPosition);
 621 protected:
 622   virtual FGNavList::TypeFilter* getNavaidFilter();
 623 private:
 624   class ServiceVolume {
 625   public:
 626       ServiceVolume();
 627       double adjustRange( double azimuthAngle_deg, double elevationAngle_deg );
 628   private:
 629       SGInterpTable _azimuthTable;
 630       SGInterpTable _elevationTable;
 631   } _serviceVolume;
 632   static SGVec3d tangentVector(const SGGeod& midpoint, const double heading);
 633
 634   PropertyObject<double>  _targetGlideslope_deg;
 635   PropertyObject<double>  _glideslopeOffset_norm;
 636   SGVec3d _gsAxis;
 637   SGVec3d _gsVertical;
 638 };
 639
 640 GS::ServiceVolume::ServiceVolume()
 641 {
 642 // maybe this: http://www.tpub.com/content/aviation2/P-1244/P-12440125.htm
 643   // ICAO Annex 10 - 3.1.5.2.2: The emission from the glide path equipment
 644   // shall be horizontally polarized
 645   // very rough abstraction of a 5-element yagi antenna's
 646   // E-plane radiation diagram
 647   _azimuthTable.addEntry(   0.0, 1.0 );
 648   _azimuthTable.addEntry(  10.0, 1.0 );
 649   _azimuthTable.addEntry(  30.0, 0.75 );
 650   _azimuthTable.addEntry(  40.0, 0.50 );
 651   _azimuthTable.addEntry(  50.0, 0.20 );
 652   _azimuthTable.addEntry(  60.0, 0.10 );
 653   _azimuthTable.addEntry(  70.0, 0.20 );
 654   _azimuthTable.addEntry(  80.0, 0.10 );
 655   _azimuthTable.addEntry(  90.0, 0.05 );
 656   _azimuthTable.addEntry( 105.0, 0.10 );
 657   _azimuthTable.addEntry( 130.0, 0.05 );
 658   _azimuthTable.addEntry( 150.0, 0.30 );
 659   _azimuthTable.addEntry( 160.0, 0.40 );
 660   _azimuthTable.addEntry( 170.0, 0.50 );
 661   _azimuthTable.addEntry( 180.0, 0.50 );
 662
 663   _elevationTable.addEntry(   0.0, 0.1 );
 664   _elevationTable.addEntry(  1.05, 1.0 );
 665   _elevationTable.addEntry(  7.00, 1.0 );
 666   _elevationTable.addEntry(  45.0, 0.3 );
 667   _elevationTable.addEntry(  90.0, 0.1 );
 668   _elevationTable.addEntry( 180.0, 0.01 );
 669 }
 670
 671 double GS::ServiceVolume::adjustRange( double azimuthAngle_deg, double elevationAngle_deg )
 672 {
 673     return _azimuthTable.interpolate( fabs(azimuthAngle_deg) ) *
 674         _elevationTable.interpolate( fabs(elevationAngle_deg) );
 675 }
 676
 677 GS::GS( SGPropertyNode_ptr rootNode) :
 678   NavRadioComponent("gs", rootNode ),
 679   _targetGlideslope_deg( rootNode->getNode(_name,true)->getNode("slope",true) ),
 680   _glideslopeOffset_norm( rootNode->getNode(_name,true)->getNode("offset-norm",true) ),
 681   _gsAxis(SGVec3d::zeros()),
 682   _gsVertical(SGVec3d::zeros())
 683 {
 684 }
 685
 686 GS::~GS()
 687 {
 688 }
 689
 690 FGNavList::TypeFilter* GS::getNavaidFilter()
 691 {
 692   static FGNavList::TypeFilter filter(FGPositioned::GS);
 693   return &filter;
 694 }
 695
 696 double GS::getRange_nm(const SGGeod & aircraftPosition)
 697 {
 698   double elevationAngle = ::atan2(_heightAboveStation_ft*SG_FEET_TO_METER, _trackDistance_m)*SG_RADIANS_TO_DEGREES;
 699   double azimuthAngle = SGMiscd::normalizePeriodic( -180.0, 180.0, _trueBearingFrom_deg + 180.0 - fmod(_navRecord->get_multiuse(), 1000.0) );
 700   return  _navRecord->get_range() * _serviceVolume.adjustRange( azimuthAngle, elevationAngle );
 701 }
 702
 703 // Calculate a Cartesian unit vector in the
 704 // local horizontal plane, i.e. tangent to the
 705 // surface of the earth at the local ground zero.
 706 // The tangent vector passes through the given  <midpoint>
 707 // and points forward along the given <heading>.
 708 // The <heading> is given in degrees.
 709 SGVec3d GS::tangentVector(const SGGeod& midpoint, const double heading)
 710 {
 711   // move 100m away from the midpoint - arbitrary number
 712   const double delta(100.0);
 713   SGGeod head, tail;
 714   double az2;                   // ignored
 715   SGGeodesy::direct(midpoint, heading,     delta, head, az2);
 716   SGGeodesy::direct(midpoint, 180+heading, delta, tail, az2);
 717   head.setElevationM(midpoint.getElevationM());
 718   tail.setElevationM(midpoint.getElevationM());
 719   SGVec3d head_xyz = SGVec3d::fromGeod(head);
 720   SGVec3d tail_xyz = SGVec3d::fromGeod(tail);
 721 // Awkward formula here, needed because vector-by-scalar
 722 // multiplication is defined, but not vector-by-scalar division.
 723   return (head_xyz - tail_xyz) * (0.5/delta);
 724 }
 725
 726 void GS::search( double frequency, const SGGeod & aircraftPosition )
 727 {
 728   NavRadioComponent::search( frequency, aircraftPosition );
 729   if( false == valid() ) {
 730       _gsAxis = SGVec3d::zeros();
 731       _gsVertical = SGVec3d::zeros();
 732       _targetGlideslope_deg = 3.0;
 733       return;
 734   }
 735
 736   double gs_radial = SGMiscd::normalizePeriodic(0.0, 360.0, fmod(_navRecord->get_multiuse(), 1000.0) );
 737
 738   _gsAxis = tangentVector(_navRecord->geod(), gs_radial);
 739   SGVec3d gsBaseline = tangentVector(_navRecord->geod(), gs_radial + 90.0);
 740   _gsVertical = cross(gsBaseline, _gsAxis);
 741
 742   int tmp = (int)(_navRecord->get_multiuse() / 1000.0);
 743   // catch unconfigured glideslopes here, they will cause nan later
 744   _targetGlideslope_deg = SGMiscd::max( 1.0, (double)tmp / 100.0 );
 745 }
 746
 747 void GS::update( double dt, const SGGeod & aircraftPosition )
 748 {
 749   NavRadioComponent::update( dt, aircraftPosition );
 750   if( false == valid() ) {
 751       _glideslopeOffset_norm = 0.0;
 752       return;
 753   }
 754
 755   SGVec3d pos = SGVec3d::fromGeod(aircraftPosition) - _navRecord->cart(); // relative vector from gs antenna to aircraft
 756   // The positive GS axis points along the runway in the landing direction,
 757   // toward the far end, not toward the approach area, so we need a - sign here:
 758   double comp_h = -dot(pos, _gsAxis);      // component in horiz direction
 759   double comp_v = dot(pos, _gsVertical);   // component in vertical direction
 760   //double comp_b = dot(pos, _gsBaseline);   // component in baseline direction
 761   //if (comp_b) {}                           // ... (useful for debugging)
 762
 763 // _gsDirect represents the angle of elevation of the aircraft
 764 // as seen by the GS transmitter.
 765   double gsDirect = atan2(comp_v, comp_h) * SGD_RADIANS_TO_DEGREES;
 766 // At this point, if the aircraft is centered on the glide slope,
 767 // _gsDirect will be a small positive number, e.g. 3.0 degrees
 768
 769 // Aim the branch cut straight down
 770 // into the ground below the GS transmitter:
 771   if (gsDirect < -90.0) gsDirect += 360.0;
 772
 773   double offset = _targetGlideslope_deg - gsDirect;
 774   if( offset < 0.0 )
 775     offset = _targetGlideslope_deg/2 * sawtooth(2.0*offset/_targetGlideslope_deg);
 776   assert( false == isnan(offset) );
 777 // GS is documented to be 1.4 degrees thick,
 778 // i.e. plus or minus 0.7 degrees from the midline:
 779   _glideslopeOffset_norm = SGMiscd::clip(offset/0.7, -1.0, 1.0);
 780 }
 781
 782 void GS::display( NavIndicator & navIndicator )
 783 {
 784   if( false == valid() ) {
 785     navIndicator.setGS( false );
 786     return;
 787   }
 788   navIndicator.setGS( true );
 789   navIndicator.setGS( _glideslopeOffset_norm );
 790 }
 791
 792 /* ------------- A NAV/COMM Frequency formatter ---------------------- */
 793
 794 class FrequencyFormatter : public SGPropertyChangeListener {
 795 public:
 796   FrequencyFormatter( SGPropertyNode_ptr freqNode, SGPropertyNode_ptr fmtFreqNode, double channelSpacing ) :
 797     _freqNode( freqNode ),
 798     _fmtFreqNode( fmtFreqNode ),
 799     _channelSpacing(channelSpacing)
 800   {
 801     _freqNode->addChangeListener( this );
 802     valueChanged(_freqNode);
 803   }
 804   ~FrequencyFormatter()
 805   {
 806     _freqNode->removeChangeListener( this );
 807   }
 808
 809   void valueChanged (SGPropertyNode * prop)
 810   {
 811     // format as fixed decimal "nnn.nn"
 812     std::ostringstream buf;
 813     buf << std::fixed
 814         << std::setw(5)
 815         << std::setfill('0')
 816         << std::setprecision(2)
 817         << getFrequency();
 818     _fmtFreqNode->setStringValue( buf.str() );
 819   }
 820
 821   double getFrequency() const
 822   {
 823     double d = SGMiscd::roundToInt(_freqNode->getDoubleValue() / _channelSpacing) * _channelSpacing;
 824     // strip last digit, do not round
 825     return ((int)(d*100))/100.0;
 826   }
 827
 828 private:
 829   SGPropertyNode_ptr _freqNode;
 830   SGPropertyNode_ptr _fmtFreqNode;
 831   double _channelSpacing;
 832 };
 833
 834
 835 /* ------------- The NavRadio implementation ---------------------- */
 836
 837 class NavRadioImpl : public NavRadio {
 838 public:
 839   NavRadioImpl( SGPropertyNode_ptr node );
 840   virtual ~NavRadioImpl();
 841
 842   virtual void update( double dt );
 843   virtual void init();
 844 private:
 845   void search();
 846
 847   class Legacy {
 848   public:
 849       Legacy( NavRadioImpl * navRadioImpl ) : _navRadioImpl( navRadioImpl ) {}
 850
 851       void init();
 852       void update( double dt );
 853   private:
 854       NavRadioImpl * _navRadioImpl;
 855       SGPropertyNode_ptr is_valid_node;
 856       SGPropertyNode_ptr nav_serviceable_node;
 857       SGPropertyNode_ptr nav_id_node;
 858       SGPropertyNode_ptr id_c1_node;
 859       SGPropertyNode_ptr id_c2_node;
 860       SGPropertyNode_ptr id_c3_node;
 861       SGPropertyNode_ptr id_c4_node;
 862   } _legacy;
 863
 864   const static int VOR_COMPONENT = 0;
 865   const static int LOC_COMPONENT = 1;
 866   const static int GS_COMPONENT  = 2;
 867
 868   std::string _name;
 869   int         _num;
 870   SGPropertyNode_ptr _rootNode;
 871   FrequencyFormatter _useFrequencyFormatter;
 872   FrequencyFormatter _stbyFrequencyFormatter;
 873   std::vector<NavRadioComponent*> _components;
 874   NavIndicator _navIndicator;
 875   double _stationTTL;
 876   double _frequency;
 877   PropertyObject<bool> _cdiDisconnected;
 878 };
 879
 880 NavRadioImpl::NavRadioImpl( SGPropertyNode_ptr node ) :
 881   _legacy( this ),
 882   _name(node->getStringValue("name", "nav")),
 883   _num(node->getIntValue("number", 0)),
 884   _rootNode(fgGetNode( string("/instrumentation/") + _name, _num, true)),
 885   _useFrequencyFormatter( _rootNode->getNode("frequencies/selected-mhz",true), _rootNode->getNode("frequencies/selected-mhz-fmt",true), 0.05 ),
 886   _stbyFrequencyFormatter( _rootNode->getNode("frequencies/standby-mhz",true), _rootNode->getNode("frequencies/standby-mhz-fmt",true), 0.05 ),
 887   _navIndicator(_rootNode),
 888   _stationTTL(0.0),
 889   _frequency(-1.0),
 890   _cdiDisconnected(_rootNode->getNode("cdi-disconnected",true))
 891 {
 892 }
 893
 894 NavRadioImpl::~NavRadioImpl()
 895 {
 896   BOOST_FOREACH( NavRadioComponent * p, _components ) {
 897     delete p;
 898   }
 899 }
 900
 901 void NavRadioImpl::init()
 902 {
 903   if( 0 < _components.size() )
 904     return;
 905
 906   _components.push_back( new VOR(_rootNode) );
 907   _components.push_back( new LOC(_rootNode) );
 908   _components.push_back( new GS(_rootNode) );
 909
 910   _legacy.init();
 911 }
 912
 913 void NavRadioImpl::search()
 914 {
 915 }
 916
 917 void NavRadioImpl::update( double dt )
 918 {
 919   if( dt < SGLimitsd::min() ) return;
 920
 921   SGGeod position;
 922
 923   try {
 924     position = globals->get_aircraft_position();
 925   }
 926   catch( std::exception & ) {
 927     return;
 928   }
 929
 930   _stationTTL -= dt;
 931   if( _frequency != _useFrequencyFormatter.getFrequency() ) {
 932       _frequency = _useFrequencyFormatter.getFrequency();
 933       _stationTTL = 0.0;
 934   }
 935
 936   BOOST_FOREACH( NavRadioComponent * p, _components ) {
 937       if( _stationTTL <= 0.0 )
 938           p->search( _frequency, position );
 939       p->update( dt, position );
 940
 941       if( false == _cdiDisconnected )
 942           p->display( _navIndicator );
 943   }
 944
 945   if( _stationTTL <= 0.0 )
 946       _stationTTL = 30.0;
 947
 948   _legacy.update( dt );
 949 }
 950
 951 void NavRadioImpl::Legacy::init()
 952 {
 953     is_valid_node = _navRadioImpl->_rootNode->getChild("data-is-valid", 0, true);
 954     nav_serviceable_node = _navRadioImpl->_rootNode->getChild("serviceable", 0, true);
 955
 956     nav_id_node = _navRadioImpl->_rootNode->getChild("nav-id", 0, true );
 957     id_c1_node = _navRadioImpl->_rootNode->getChild("nav-id_asc1", 0, true );
 958     id_c2_node = _navRadioImpl->_rootNode->getChild("nav-id_asc2", 0, true );
 959     id_c3_node = _navRadioImpl->_rootNode->getChild("nav-id_asc3", 0, true );
 960     id_c4_node = _navRadioImpl->_rootNode->getChild("nav-id_asc4", 0, true );
 961
 962 }
 963
 964 void NavRadioImpl::Legacy::update( double dt )
 965 {
 966     is_valid_node->setBoolValue(
 967         _navRadioImpl->_components[VOR_COMPONENT]->valid() || _navRadioImpl->_components[LOC_COMPONENT]->valid()
 968         );
 969
 970     string ident = _navRadioImpl->_components[VOR_COMPONENT]->getIdent();
 971     if( ident.empty() )
 972         ident = _navRadioImpl->_components[LOC_COMPONENT]->getIdent();
 973
 974     nav_id_node->setStringValue( ident );
 975
 976     ident = simgear::strutils::rpad( ident, 4, ' ' );
 977     id_c1_node->setIntValue( (int)ident[0] );
 978     id_c2_node->setIntValue( (int)ident[1] );
 979     id_c3_node->setIntValue( (int)ident[2] );
 980     id_c4_node->setIntValue( (int)ident[3] );
 981 }
 982
 983
 984 SGSubsystem * NavRadio::createInstance( SGPropertyNode_ptr rootNode )
 985 {
 986     // use old navradio code by default
 987     if( fgGetBool( "/instrumentation/use-new-navradio", false ) )
 988         return new NavRadioImpl( rootNode );
 989
 990     return new FGNavRadio( rootNode );
 991 }
 992
 993 } // namespace Instrumentation
 994