src/Instrumentation/gps.cxx

   1 // gps.cxx - distance-measuring equipment.
   2 // Written by David Megginson, started 2003.
   3 //
   4 // This file is in the Public Domain and comes with no warranty.
   5
   6 #ifdef HAVE_CONFIG_H
   7 #  include <config.h>
   8 #endif
   9
  10 #include "gps.hxx"
  11
  12 #include <boost/tuple/tuple.hpp>
  13
  14 #include <memory>
  15 #include <set>
  16 #include <cstring>
  17
  18 #include "Main/fg_props.hxx"
  19 #include "Main/globals.hxx" // for get_subsystem
  20 #include "Main/util.hxx" // for fgLowPass
  21 #include "Navaids/positioned.hxx"
  22 #include <Navaids/waypoint.hxx>
  23 #include "Navaids/navrecord.hxx"
  24 #include "Airports/simple.hxx"
  25 #include "Airports/runways.hxx"
  26 #include "Autopilot/route_mgr.hxx"
  27
  28 #include <simgear/math/sg_random.h>
  29 #include <simgear/sg_inlines.h>
  30 #include <simgear/math/sg_geodesy.hxx>
  31 #include <simgear/structure/exception.hxx>
  32
  33 using std::auto_ptr;
  34 using std::string;
  35 using namespace flightgear;
  36
  37 ///////////////////////////////////////////////////////////////////
  38
  39 void SGGeodProperty::init(SGPropertyNode* base, const char* lonStr, const char* latStr, const char* altStr)
  40 {
  41     _lon = base->getChild(lonStr, 0, true);
  42     _lat = base->getChild(latStr, 0, true);
  43     if (altStr) {
  44         _alt = base->getChild(altStr, 0, true);
  45     }
  46 }
  47
  48 void SGGeodProperty::init(const char* lonStr, const char* latStr, const char* altStr)
  49 {
  50     _lon = fgGetNode(lonStr, true);
  51     _lat = fgGetNode(latStr, true);
  52     if (altStr) {
  53         _alt = fgGetNode(altStr, true);
  54     }
  55 }
  56
  57 void SGGeodProperty::clear()
  58 {
  59     _lon = _lat = _alt = NULL;
  60 }
  61
  62 void SGGeodProperty::operator=(const SGGeod& geod)
  63 {
  64     _lon->setDoubleValue(geod.getLongitudeDeg());
  65     _lat->setDoubleValue(geod.getLatitudeDeg());
  66     if (_alt) {
  67         _alt->setDoubleValue(geod.getElevationFt());
  68     }
  69 }
  70
  71 SGGeod SGGeodProperty::get() const
  72 {
  73     double lon = _lon->getDoubleValue(),
  74         lat = _lat->getDoubleValue();
  75
  76     if (SGMisc<double>::isNaN(lon) || SGMisc<double>::isNaN(lat)) {
  77       SG_LOG(SG_INSTR, SG_WARN, "read NaN for lon/lat:" << _lon->getPath()
  78         << ", " << _lat->getPath());
  79       return SGGeod();
  80     }
  81
  82     if (_alt) {
  83         return SGGeod::fromDegFt(lon, lat, _alt->getDoubleValue());
  84     } else {
  85         return SGGeod::fromDeg(lon,lat);
  86     }
  87 }
  88
  89 static const char* makeTTWString(double TTW)
  90 {
  91   if ((TTW <= 0.0) || (TTW >= 356400.5)) { // 99 hours
  92     return "--:--:--";
  93   }
  94
  95   unsigned int TTW_seconds = (int) (TTW + 0.5);
  96   unsigned int TTW_minutes = 0;
  97   unsigned int TTW_hours   = 0;
  98   static char TTW_str[9];
  99   TTW_hours   = TTW_seconds / 3600;
 100   TTW_minutes = (TTW_seconds / 60) % 60;
 101   TTW_seconds = TTW_seconds % 60;
 102   snprintf(TTW_str, 9, "%02d:%02d:%02d",
 103     TTW_hours, TTW_minutes, TTW_seconds);
 104   return TTW_str;
 105 }
 106
 107 /////////////////////////////////////////////////////////////////////////////
 108
 109 class GPSListener : public SGPropertyChangeListener
 110 {
 111 public:
 112   GPSListener(GPS *m) :
 113     _gps(m),
 114     _guard(false) {}
 115
 116   virtual void valueChanged (SGPropertyNode * prop)
 117   {
 118     if (_guard) {
 119       return;
 120     }
 121
 122     _guard = true;
 123     if (prop == _gps->_route_current_wp_node) {
 124       _gps->routeManagerSequenced();
 125     } else if (prop == _gps->_route_active_node) {
 126       _gps->routeActivated();
 127     } else if (prop == _gps->_ref_navaid_id_node) {
 128       _gps->referenceNavaidSet(prop->getStringValue(""));
 129     } else if (prop == _gps->_routeEditedSignal) {
 130       _gps->routeEdited();
 131     } else if (prop == _gps->_routeFinishedSignal) {
 132       _gps->routeFinished();
 133     }
 134
 135     _guard = false;
 136   }
 137
 138   void setGuard(bool g) {
 139     _guard = g;
 140   }
 141 private:
 142   GPS* _gps;
 143   bool _guard; // re-entrancy guard
 144 };
 145
 146 ////////////////////////////////////////////////////////////////////////////
 147 /**
 148  * Helper to monitor for Nasal or other code accessing properties we haven't
 149  * defined. For the moment we complain about all such activites, since various
 150  * users assume all kinds of weird, wonderful and non-existent interfaces.
 151  */
 152
 153 class DeprecatedPropListener : public SGPropertyChangeListener
 154 {
 155 public:
 156   DeprecatedPropListener(SGPropertyNode* gps)
 157   {
 158     _parents.insert(gps);
 159     SGPropertyNode* wp = gps->getChild("wp", 0, true);
 160     _parents.insert(wp);
 161     _parents.insert(wp->getChild("wp", 0, true));
 162     _parents.insert(wp->getChild("wp", 1, true));
 163
 164     std::set<SGPropertyNode*>::iterator it;
 165     for (it = _parents.begin(); it != _parents.end(); ++it) {
 166       (*it)->addChangeListener(this);
 167     }
 168   }
 169
 170   virtual void valueChanged (SGPropertyNode * prop)
 171   {
 172   }
 173
 174   virtual void childAdded (SGPropertyNode * parent, SGPropertyNode * child)
 175   {
 176     if (isDeprecated(parent, child)) {
 177       SG_LOG(SG_INSTR, SG_WARN, "GPS: someone accessed a deprecated property:"
 178         << child->getPath(true));
 179     }
 180   }
 181 private:
 182   bool isDeprecated(SGPropertyNode * parent, SGPropertyNode * child) const
 183   {
 184     if (_parents.count(parent) < 1) {
 185       return false;
 186     }
 187
 188     // no child exclusions yet
 189     return true;
 190   }
 191
 192   std::set<SGPropertyNode*> _parents;
 193 };
 194
 195 ////////////////////////////////////////////////////////////////////////////
 196 // configuration helper object
 197
 198 GPS::Config::Config() :
 199   _enableTurnAnticipation(true),
 200   _turnRate(3.0), // degrees-per-second, so 180 degree turn takes 60 seconds
 201   _overflightArmDistance(1.0),
 202   _waypointAlertTime(30.0),
 203   _requireHardSurface(true),
 204   _cdiMaxDeflectionNm(3.0), // linear mode, 3nm at the peg
 205   _driveAutopilot(true),
 206   _courseSelectable(false)
 207 {
 208   _enableTurnAnticipation = false;
 209 }
 210
 211 void GPS::Config::bind(GPS* aOwner, SGPropertyNode* aCfg)
 212 {
 213   aOwner->tie(aCfg, "turn-rate-deg-sec", SGRawValuePointer<double>(&_turnRate));
 214   aOwner->tie(aCfg, "turn-anticipation", SGRawValuePointer<bool>(&_enableTurnAnticipation));
 215   aOwner->tie(aCfg, "wpt-alert-time", SGRawValuePointer<double>(&_waypointAlertTime));
 216   aOwner->tie(aCfg, "hard-surface-runways-only", SGRawValuePointer<bool>(&_requireHardSurface));
 217   aOwner->tie(aCfg, "cdi-max-deflection-nm", SGRawValuePointer<double>(&_cdiMaxDeflectionNm));
 218   aOwner->tie(aCfg, "drive-autopilot", SGRawValuePointer<bool>(&_driveAutopilot));
 219   aOwner->tie(aCfg, "course-selectable", SGRawValuePointer<bool>(&_courseSelectable));
 220 }
 221
 222 ////////////////////////////////////////////////////////////////////////////
 223
 224 GPS::GPS ( SGPropertyNode *node) :
 225   _selectedCourse(0.0),
 226   _desiredCourse(0.0),
 227   _dataValid(false),
 228   _lastPosValid(false),
 229   _mode("init"),
 230   _name(node->getStringValue("name", "gps")),
 231   _num(node->getIntValue("number", 0)),
 232   _searchResultIndex(0),
 233   _searchExact(true),
 234   _searchIsRoute(false),
 235   _searchHasNext(false),
 236   _searchNames(false),
 237   _computeTurnData(false),
 238   _anticipateTurn(false),
 239   _inTurn(false)
 240 {
 241   string branch = "/instrumentation/" + _name;
 242   _gpsNode = fgGetNode(branch.c_str(), _num, true );
 243   _scratchNode = _gpsNode->getChild("scratch", 0, true);
 244
 245   SGPropertyNode *wp_node = _gpsNode->getChild("wp", 0, true);
 246   _currentWayptNode = wp_node->getChild("wp", 1, true);
 247 }
 248
 249 GPS::~GPS ()
 250 {
 251 }
 252
 253 void
 254 GPS::init ()
 255 {
 256   _routeMgr = (FGRouteMgr*) globals->get_subsystem("route-manager");
 257   assert(_routeMgr);
 258
 259   _position.init("/position/longitude-deg", "/position/latitude-deg", "/position/altitude-ft");
 260   _magvar_node = fgGetNode("/environment/magnetic-variation-deg", true);
 261   _serviceable_node = _gpsNode->getChild("serviceable", 0, true);
 262   _serviceable_node->setBoolValue(true);
 263   _electrical_node = fgGetNode("/systems/electrical/outputs/gps", true);
 264
 265 // basic GPS outputs
 266   _raim_node = _gpsNode->getChild("raim", 0, true);
 267   _odometer_node = _gpsNode->getChild("odometer", 0, true);
 268   _trip_odometer_node = _gpsNode->getChild("trip-odometer", 0, true);
 269   _true_bug_error_node = _gpsNode->getChild("true-bug-error-deg", 0, true);
 270   _magnetic_bug_error_node = _gpsNode->getChild("magnetic-bug-error-deg", 0, true);
 271   _eastWestVelocity = _gpsNode->getChild("ew-velocity-msec", 0, true);
 272   _northSouthVelocity = _gpsNode->getChild("ns-velocity-msec", 0, true);
 273
 274 // waypoints
 275   // for compatability, alias selected course down to wp/wp[1]/desired-course-deg
 276   SGPropertyNode* wp1Crs = _currentWayptNode->getChild("desired-course-deg", 0, true);
 277   wp1Crs->alias(_gpsNode->getChild("desired-course-deg", 0, true));
 278
 279   _tracking_bug_node = _gpsNode->getChild("tracking-bug", 0, true);
 280
 281 // reference navid
 282   SGPropertyNode_ptr ref_navaid = _gpsNode->getChild("ref-navaid", 0, true);
 283   _ref_navaid_id_node = ref_navaid->getChild("id", 0, true);
 284   _ref_navaid_name_node = ref_navaid->getChild("name", 0, true);
 285   _ref_navaid_bearing_node = ref_navaid->getChild("bearing-deg", 0, true);
 286   _ref_navaid_frequency_node = ref_navaid->getChild("frequency-mhz", 0, true);
 287   _ref_navaid_distance_node = ref_navaid->getChild("distance-nm", 0, true);
 288   _ref_navaid_mag_bearing_node = ref_navaid->getChild("mag-bearing-deg", 0, true);
 289   _ref_navaid_elapsed = 0.0;
 290   _ref_navaid_set = false;
 291
 292 // route properties
 293   // should these move to the route manager?
 294   _routeDistanceNm = _gpsNode->getChild("route-distance-nm", 0, true);
 295   _routeETE = _gpsNode->getChild("ETE", 0, true);
 296   _routeEditedSignal = fgGetNode("/autopilot/route-manager/signals/edited", true);
 297   _routeFinishedSignal = fgGetNode("/autopilot/route-manager/signals/finished", true);
 298
 299 // add listener to various things
 300   _listener = new GPSListener(this);
 301   _route_current_wp_node = fgGetNode("/autopilot/route-manager/current-wp", true);
 302   _route_current_wp_node->addChangeListener(_listener);
 303   _route_active_node = fgGetNode("/autopilot/route-manager/active", true);
 304   _route_active_node->addChangeListener(_listener);
 305   _ref_navaid_id_node->addChangeListener(_listener);
 306   _routeEditedSignal->addChangeListener(_listener);
 307   _routeFinishedSignal->addChangeListener(_listener);
 308
 309 // navradio slaving properties
 310   SGPropertyNode* toFlag = _gpsNode->getChild("to-flag", 0, true);
 311   toFlag->alias(_currentWayptNode->getChild("to-flag"));
 312
 313   SGPropertyNode* fromFlag = _gpsNode->getChild("from-flag", 0, true);
 314   fromFlag->alias(_currentWayptNode->getChild("from-flag"));
 315
 316 // autopilot drive properties
 317   _apDrivingFlag = fgGetNode("/autopilot/settings/gps-driving-true-heading", true);
 318   _apTrueHeading = fgGetNode("/autopilot/settings/true-heading-deg",true);
 319   _apTargetAltitudeFt = fgGetNode("/autopilot/settings/target-altitude-ft", true);
 320   _apAltitudeLock = fgGetNode("/autopilot/locks/altitude", true);
 321
 322 // realism prop[s]
 323   _realismSimpleGps = fgGetNode("/sim/realism/simple-gps", true);
 324   if (!_realismSimpleGps->hasValue()) {
 325     _realismSimpleGps->setBoolValue(true);
 326   }
 327
 328   // last thing, add the deprecated prop watcher
 329   new DeprecatedPropListener(_gpsNode);
 330 }
 331
 332 void
 333 GPS::reinit ()
 334 {
 335   clearOutput();
 336 }
 337
 338 void
 339 GPS::bind()
 340 {
 341   _config.bind(this, _gpsNode->getChild("config", 0, true));
 342
 343 // basic GPS outputs
 344   tie(_gpsNode, "selected-course-deg", SGRawValueMethods<GPS, double>
 345     (*this, &GPS::getSelectedCourse, &GPS::setSelectedCourse));
 346
 347   tie(_gpsNode, "desired-course-deg", SGRawValueMethods<GPS, double>
 348     (*this, &GPS::getDesiredCourse, NULL));
 349   _desiredCourseNode = _gpsNode->getChild("desired-course-deg", 0, true);
 350
 351   tieSGGeodReadOnly(_gpsNode, _indicated_pos, "indicated-longitude-deg",
 352         "indicated-latitude-deg", "indicated-altitude-ft");
 353
 354   tie(_gpsNode, "indicated-vertical-speed", SGRawValueMethods<GPS, double>
 355     (*this, &GPS::getVerticalSpeed, NULL));
 356   tie(_gpsNode, "indicated-track-true-deg", SGRawValueMethods<GPS, double>
 357     (*this, &GPS::getTrueTrack, NULL));
 358   tie(_gpsNode, "indicated-track-magnetic-deg", SGRawValueMethods<GPS, double>
 359     (*this, &GPS::getMagTrack, NULL));
 360   tie(_gpsNode, "indicated-ground-speed-kt", SGRawValueMethods<GPS, double>
 361     (*this, &GPS::getGroundspeedKts, NULL));
 362
 363 // command system
 364   tie(_gpsNode, "mode", SGRawValueMethods<GPS, const char*>(*this, &GPS::getMode, NULL));
 365   tie(_gpsNode, "command", SGRawValueMethods<GPS, const char*>(*this, &GPS::getCommand, &GPS::setCommand));
 366
 367   tieSGGeod(_scratchNode, _scratchPos, "longitude-deg", "latitude-deg", "altitude-ft");
 368   tie(_scratchNode, "valid", SGRawValueMethods<GPS, bool>(*this, &GPS::getScratchValid, NULL));
 369   tie(_scratchNode, "distance-nm", SGRawValueMethods<GPS, double>(*this, &GPS::getScratchDistance, NULL));
 370   tie(_scratchNode, "true-bearing-deg", SGRawValueMethods<GPS, double>(*this, &GPS::getScratchTrueBearing, NULL));
 371   tie(_scratchNode, "mag-bearing-deg", SGRawValueMethods<GPS, double>(*this, &GPS::getScratchMagBearing, NULL));
 372   tie(_scratchNode, "has-next", SGRawValueMethods<GPS, bool>(*this, &GPS::getScratchHasNext, NULL));
 373   _scratchValid = false;
 374
 375
 376   SGPropertyNode *wp_node = _gpsNode->getChild("wp", 0, true);
 377   SGPropertyNode* wp0_node = wp_node->getChild("wp", 0, true);
 378
 379   tieSGGeodReadOnly(wp0_node, _wp0_position, "longitude-deg", "latitude-deg", "altitude-ft");
 380   tie(_currentWayptNode, "ID", SGRawValueMethods<GPS, const char*>
 381     (*this, &GPS::getWP1Ident, NULL));
 382
 383   tie(_currentWayptNode, "distance-nm", SGRawValueMethods<GPS, double>
 384     (*this, &GPS::getWP1Distance, NULL));
 385   tie(_currentWayptNode, "bearing-true-deg", SGRawValueMethods<GPS, double>
 386     (*this, &GPS::getWP1Bearing, NULL));
 387   tie(_currentWayptNode, "bearing-mag-deg", SGRawValueMethods<GPS, double>
 388     (*this, &GPS::getWP1MagBearing, NULL));
 389   tie(_currentWayptNode, "TTW-sec", SGRawValueMethods<GPS, double>
 390     (*this, &GPS::getWP1TTW, NULL));
 391   tie(_currentWayptNode, "TTW", SGRawValueMethods<GPS, const char*>
 392     (*this, &GPS::getWP1TTWString, NULL));
 393
 394   tie(_currentWayptNode, "course-deviation-deg", SGRawValueMethods<GPS, double>
 395     (*this, &GPS::getWP1CourseDeviation, NULL));
 396   tie(_currentWayptNode, "course-error-nm", SGRawValueMethods<GPS, double>
 397     (*this, &GPS::getWP1CourseErrorNm, NULL));
 398   tie(_currentWayptNode, "to-flag", SGRawValueMethods<GPS, bool>
 399     (*this, &GPS::getWP1ToFlag, NULL));
 400   tie(_currentWayptNode, "from-flag", SGRawValueMethods<GPS, bool>
 401     (*this, &GPS::getWP1FromFlag, NULL));
 402
 403 // leg properties (only valid in DTO/LEG modes, not OBS)
 404   tie(wp_node, "leg-distance-nm", SGRawValueMethods<GPS, double>(*this, &GPS::getLegDistance, NULL));
 405   tie(wp_node, "leg-true-course-deg", SGRawValueMethods<GPS, double>(*this, &GPS::getLegCourse, NULL));
 406   tie(wp_node, "leg-mag-course-deg", SGRawValueMethods<GPS, double>(*this, &GPS::getLegMagCourse, NULL));
 407
 408 // navradio slaving properties
 409   tie(_gpsNode, "cdi-deflection", SGRawValueMethods<GPS,double>
 410     (*this, &GPS::getCDIDeflection));
 411 }
 412
 413 void
 414 GPS::unbind()
 415 {
 416   _tiedProperties.Untie();
 417 }
 418
 419 void
 420 GPS::clearOutput()
 421 {
 422   _dataValid = false;
 423   _last_speed_kts = 0.0;
 424   _last_pos = SGGeod();
 425   _lastPosValid = false;
 426   _indicated_pos = SGGeod();
 427   _last_vertical_speed = 0.0;
 428   _last_true_track = 0.0;
 429   _lastEWVelocity = _lastNSVelocity = 0.0;
 430   _currentWaypt = _prevWaypt = NULL;
 431   _legDistanceNm = -1.0;
 432
 433   _raim_node->setDoubleValue(0.0);
 434   _indicated_pos = SGGeod();
 435   _odometer_node->setDoubleValue(0);
 436   _trip_odometer_node->setDoubleValue(0);
 437   _tracking_bug_node->setDoubleValue(0);
 438   _true_bug_error_node->setDoubleValue(0);
 439   _magnetic_bug_error_node->setDoubleValue(0);
 440   _northSouthVelocity->setDoubleValue(0.0);
 441   _eastWestVelocity->setDoubleValue(0.0);
 442 }
 443
 444 void
 445 GPS::update (double delta_time_sec)
 446 {
 447   if (!_realismSimpleGps->getBoolValue()) {
 448     // If it's off, don't bother.
 449     if (!_serviceable_node->getBoolValue() || !_electrical_node->getBoolValue()) {
 450       clearOutput();
 451       return;
 452     }
 453   }
 454
 455   if (delta_time_sec <= 0.0) {
 456     return; // paused, don't bother
 457   }
 458
 459   _raim_node->setDoubleValue(1.0);
 460   _indicated_pos = _position.get();
 461   updateBasicData(delta_time_sec);
 462
 463   if (_dataValid) {
 464     if (_wayptController.get()) {
 465       _wayptController->update();
 466       SGGeod p(_wayptController->position());
 467       _currentWayptNode->setDoubleValue("longitude-deg", p.getLongitudeDeg());
 468       _currentWayptNode->setDoubleValue("latitude-deg", p.getLatitudeDeg());
 469       _currentWayptNode->setDoubleValue("altitude-ft", p.getElevationFt());
 470
 471       _desiredCourse = getLegMagCourse();
 472
 473       updateTurn();
 474       updateRouteData();
 475     }
 476
 477
 478     updateTrackingBug();
 479     updateReferenceNavaid(delta_time_sec);
 480     driveAutopilot();
 481   }
 482
 483   if (_dataValid && (_mode == "init")) {
 484
 485     if (_route_active_node->getBoolValue()) {
 486       // GPS init with active route
 487       SG_LOG(SG_INSTR, SG_INFO, "GPS init with active route");
 488       selectLegMode();
 489     } else {
 490       // initialise in OBS mode, with waypt set to the nearest airport.
 491       // keep in mind at this point, _dataValid is not set
 492
 493       auto_ptr<FGPositioned::Filter> f(createFilter(FGPositioned::AIRPORT));
 494       FGPositionedRef apt = FGPositioned::findClosest(_position.get(), 20.0, f.get());
 495       if (apt) {
 496         setScratchFromPositioned(apt, 0);
 497         selectOBSMode();
 498       }
 499     }
 500
 501     if (_mode != "init")
 502     {
 503       // allow a realistic delay in the future, here
 504     }
 505   } // of init mode check
 506
 507   _last_pos = _indicated_pos;
 508   _lastPosValid = !(_last_pos == SGGeod());
 509 }
 510
 511 ///////////////////////////////////////////////////////////////////////////
 512 // implement the RNAV interface
 513 SGGeod GPS::position()
 514 {
 515   if (!_dataValid) {
 516     return SGGeod();
 517   }
 518
 519   return _indicated_pos;
 520 }
 521
 522 double GPS::trackDeg()
 523 {
 524   return _last_true_track;
 525 }
 526
 527 double GPS::groundSpeedKts()
 528 {
 529   return _last_speed_kts;
 530 }
 531
 532 double GPS::vspeedFPM()
 533 {
 534   return _last_vertical_speed;
 535 }
 536
 537 double GPS::magvarDeg()
 538 {
 539   return _magvar_node->getDoubleValue();
 540 }
 541
 542 double GPS::overflightArmDistanceM()
 543 {
 544   return _config.overflightArmDistanceNm() * SG_NM_TO_METER;
 545 }
 546
 547 double GPS::selectedMagCourse()
 548 {
 549   return _selectedCourse;
 550 }
 551
 552 ///////////////////////////////////////////////////////////////////////////
 553
 554 void
 555 GPS::updateBasicData(double dt)
 556 {
 557   if (!_lastPosValid) {
 558     return;
 559   }
 560
 561   double distance_m;
 562   double track2_deg;
 563   SGGeodesy::inverse(_last_pos, _indicated_pos, _last_true_track, track2_deg, distance_m );
 564
 565   double speed_kt = ((distance_m * SG_METER_TO_NM) * ((1 / dt) * 3600.0));
 566   double vertical_speed_mpm = ((_indicated_pos.getElevationM() - _last_pos.getElevationM()) * 60 / dt);
 567   _last_vertical_speed = vertical_speed_mpm * SG_METER_TO_FEET;
 568
 569   speed_kt = fgGetLowPass(_last_speed_kts, speed_kt, dt/10.0);
 570   _last_speed_kts = speed_kt;
 571
 572   SGGeod g = _indicated_pos;
 573   g.setLongitudeDeg(_last_pos.getLongitudeDeg());
 574   double northSouthM = SGGeodesy::distanceM(_last_pos, g);
 575   northSouthM = copysign(northSouthM, _indicated_pos.getLatitudeDeg() - _last_pos.getLatitudeDeg());
 576
 577   double nsMSec = fgGetLowPass(_lastNSVelocity, northSouthM / dt, dt/2.0);
 578   _lastNSVelocity = nsMSec;
 579   _northSouthVelocity->setDoubleValue(nsMSec);
 580
 581
 582   g = _indicated_pos;
 583   g.setLatitudeDeg(_last_pos.getLatitudeDeg());
 584   double eastWestM = SGGeodesy::distanceM(_last_pos, g);
 585   eastWestM = copysign(eastWestM, _indicated_pos.getLongitudeDeg() - _last_pos.getLongitudeDeg());
 586
 587   double ewMSec = fgGetLowPass(_lastEWVelocity, eastWestM / dt, dt/2.0);
 588   _lastEWVelocity = ewMSec;
 589   _eastWestVelocity->setDoubleValue(ewMSec);
 590
 591   double odometer = _odometer_node->getDoubleValue();
 592   _odometer_node->setDoubleValue(odometer + distance_m * SG_METER_TO_NM);
 593   odometer = _trip_odometer_node->getDoubleValue();
 594   _trip_odometer_node->setDoubleValue(odometer + distance_m * SG_METER_TO_NM);
 595
 596   if (!_dataValid) {
 597     _dataValid = true;
 598   }
 599 }
 600
 601 void
 602 GPS::updateTrackingBug()
 603 {
 604   double tracking_bug = _tracking_bug_node->getDoubleValue();
 605   double true_bug_error = tracking_bug - getTrueTrack();
 606   double magnetic_bug_error = tracking_bug - getMagTrack();
 607
 608   // Get the errors into the (-180,180) range.
 609   SG_NORMALIZE_RANGE(true_bug_error, -180.0, 180.0);
 610   SG_NORMALIZE_RANGE(magnetic_bug_error, -180.0, 180.0);
 611
 612   _true_bug_error_node->setDoubleValue(true_bug_error);
 613   _magnetic_bug_error_node->setDoubleValue(magnetic_bug_error);
 614 }
 615
 616 void GPS::updateReferenceNavaid(double dt)
 617 {
 618   if (!_ref_navaid_set) {
 619     _ref_navaid_elapsed += dt;
 620     if (_ref_navaid_elapsed > 5.0) {
 621
 622       FGPositioned::TypeFilter vorFilter(FGPositioned::VOR);
 623       FGPositionedRef nav = FGPositioned::findClosest(_indicated_pos, 400.0, &vorFilter);
 624       if (!nav) {
 625         SG_LOG(SG_INSTR, SG_DEBUG, "GPS couldn't find a reference navaid");
 626         _ref_navaid_id_node->setStringValue("");
 627         _ref_navaid_name_node->setStringValue("");
 628         _ref_navaid_bearing_node->setDoubleValue(0.0);
 629         _ref_navaid_mag_bearing_node->setDoubleValue(0.0);
 630         _ref_navaid_distance_node->setDoubleValue(0.0);
 631         _ref_navaid_frequency_node->setStringValue("");
 632       } else if (nav != _ref_navaid) {
 633         SG_LOG(SG_INSTR, SG_DEBUG, "GPS code selected new ref-navaid:" << nav->ident());
 634         _listener->setGuard(true);
 635         _ref_navaid_id_node->setStringValue(nav->ident().c_str());
 636         _ref_navaid_name_node->setStringValue(nav->name().c_str());
 637         FGNavRecord* vor = (FGNavRecord*) nav.ptr();
 638         _ref_navaid_frequency_node->setDoubleValue(vor->get_freq() / 100.0);
 639         _listener->setGuard(false);
 640       } else {
 641         // SG_LOG(SG_INSTR, SG_ALERT, "matched existing");
 642       }
 643
 644       _ref_navaid = nav;
 645       // reset elapsed time (do not do that before updating the properties above, since their
 646       // listeners may request another update (_ref_navaid_elapsed = 9999), which results in
 647       // excessive load (FGPositioned::findClosest called in every update loop...)
 648       _ref_navaid_elapsed = 0.0;
 649     }
 650   }
 651
 652   if (_ref_navaid) {
 653     double trueCourse, distanceM, az2;
 654     SGGeodesy::inverse(_indicated_pos, _ref_navaid->geod(), trueCourse, az2, distanceM);
 655     _ref_navaid_distance_node->setDoubleValue(distanceM * SG_METER_TO_NM);
 656     _ref_navaid_bearing_node->setDoubleValue(trueCourse);
 657     _ref_navaid_mag_bearing_node->setDoubleValue(trueCourse - _magvar_node->getDoubleValue());
 658   }
 659 }
 660
 661 void GPS::referenceNavaidSet(const std::string& aNavaid)
 662 {
 663   _ref_navaid = NULL;
 664   // allow setting an empty string to restore normal nearest-vor selection
 665   if (aNavaid.size() > 0) {
 666     FGPositioned::TypeFilter vorFilter(FGPositioned::VOR);
 667     _ref_navaid = FGPositioned::findClosestWithIdent(aNavaid,
 668       _position.get(), &vorFilter);
 669
 670     if (!_ref_navaid) {
 671       SG_LOG(SG_INSTR, SG_ALERT, "GPS: unknown ref navaid:" << aNavaid);
 672     }
 673   }
 674
 675   if (_ref_navaid) {
 676     _ref_navaid_set = true;
 677     SG_LOG(SG_INSTR, SG_INFO, "GPS code set explicit ref-navaid:" << _ref_navaid->ident());
 678     _ref_navaid_id_node->setStringValue(_ref_navaid->ident().c_str());
 679     _ref_navaid_name_node->setStringValue(_ref_navaid->name().c_str());
 680     FGNavRecord* vor = (FGNavRecord*) _ref_navaid.ptr();
 681     _ref_navaid_frequency_node->setDoubleValue(vor->get_freq() / 100.0);
 682   } else {
 683     _ref_navaid_set = false;
 684     _ref_navaid_elapsed = 9999.0; // update next tick
 685   }
 686 }
 687
 688 void GPS::routeActivated()
 689 {
 690   if (_route_active_node->getBoolValue()) {
 691     SG_LOG(SG_INSTR, SG_INFO, "GPS::route activated, switching to LEG mode");
 692     selectLegMode();
 693
 694     // if we've already passed the current waypoint, sequence.
 695     if (_dataValid && getWP1FromFlag()) {
 696       SG_LOG(SG_INSTR, SG_INFO, "GPS::route activated, FROM wp1, sequencing");
 697       _routeMgr->sequence();
 698     }
 699   } else if (_mode == "leg") {
 700     SG_LOG(SG_INSTR, SG_INFO, "GPS::route deactivated, switching to OBS mode");
 701     // select OBS mode, but keep current waypoint-as is
 702     _mode = "obs";
 703     wp1Changed();
 704   }
 705 }
 706
 707 void GPS::routeManagerSequenced()
 708 {
 709   if (_mode != "leg") {
 710     SG_LOG(SG_INSTR, SG_DEBUG, "GPS ignoring route sequencing, not in LEG mode");
 711     return;
 712   }
 713
 714   int index = _routeMgr->currentIndex(),
 715     count = _routeMgr->numWaypts();
 716   if ((index < 0) || (index >= count)) {
 717     _currentWaypt=NULL;
 718     _prevWaypt=NULL;
 719     // no active leg on the route
 720     return;
 721   }
 722
 723   SG_LOG(SG_INSTR, SG_DEBUG, "GPS waypoint index is now " << index);
 724
 725   if (index > 0) {
 726     _prevWaypt = _routeMgr->wayptAtIndex(index - 1);
 727     if (_prevWaypt->flag(WPT_DYNAMIC)) {
 728       _wp0_position = _indicated_pos;
 729     } else {
 730       _wp0_position = _prevWaypt->position();
 731     }
 732   }
 733
 734   _currentWaypt = _routeMgr->currentWaypt();
 735
 736   _desiredCourse = getLegMagCourse();
 737   _desiredCourseNode->fireValueChanged();
 738   wp1Changed();
 739 }
 740
 741 void GPS::routeEdited()
 742 {
 743   if (_mode != "leg") {
 744     return;
 745   }
 746
 747   SG_LOG(SG_INSTR, SG_INFO, "GPS route edited while in LEG mode, updating waypoints");
 748   routeManagerSequenced();
 749 }
 750
 751 void GPS::routeFinished()
 752 {
 753   if (_mode != "leg") {
 754     return;
 755   }
 756
 757   SG_LOG(SG_INSTR, SG_INFO, "GPS route finished, reverting to OBS");
 758   // select OBS mode, but keep current waypoint-as is
 759   _mode = "obs";
 760   wp1Changed();
 761 }
 762
 763 void GPS::updateTurn()
 764 {
 765   bool printProgress = false;
 766
 767   if (_computeTurnData) {
 768     if (_last_speed_kts < 10) {
 769       // need valid leg course and sensible ground speed to compute the turn
 770       return;
 771     }
 772
 773     computeTurnData();
 774     printProgress = true;
 775   }
 776
 777   if (!_anticipateTurn) {
 778     updateOverflight();
 779     return;
 780   }
 781
 782   updateTurnData();
 783   // find bearing to turn centre
 784   double bearing, az2, distanceM;
 785   SGGeodesy::inverse(_indicated_pos, _turnCentre, bearing, az2, distanceM);
 786   double progress = computeTurnProgress(bearing);
 787
 788   if (printProgress) {
 789     SG_LOG(SG_INSTR, SG_INFO,"turn progress=" << progress);
 790   }
 791
 792   if (!_inTurn && (progress > 0.0)) {
 793     beginTurn();
 794   }
 795
 796   if (_inTurn && !_turnSequenced && (progress > 0.5)) {
 797     _turnSequenced = true;
 798      SG_LOG(SG_INSTR, SG_INFO, "turn passed midpoint, sequencing");
 799      _routeMgr->sequence();
 800   }
 801
 802   if (_inTurn && (progress >= 1.0)) {
 803     endTurn();
 804   }
 805
 806   if (_inTurn) {
 807     // drive deviation and desired course
 808     double desiredCourse = bearing - copysign(90, _turnAngle);
 809     SG_NORMALIZE_RANGE(desiredCourse, 0.0, 360.0);
 810     double deviationNm = (distanceM * SG_METER_TO_NM) - _turnRadius;
 811     double deviationDeg = desiredCourse - getMagTrack();
 812     deviationNm = copysign(deviationNm, deviationDeg);
 813     // FIXME
 814     //_wp1_course_deviation_node->setDoubleValue(deviationDeg);
 815     //_wp1_course_error_nm_node->setDoubleValue(deviationNm);
 816     //_cdiDeflectionNode->setDoubleValue(deviationDeg);
 817   }
 818 }
 819
 820 void GPS::updateOverflight()
 821 {
 822   if (!_wayptController->isDone()) {
 823     return;
 824   }
 825
 826   if (_mode == "dto") {
 827     SG_LOG(SG_INSTR, SG_INFO, "GPS DTO reached destination point");
 828
 829     // check for wp1 being on active route - resume leg mode
 830     if (_routeMgr->isRouteActive()) {
 831       int index = _routeMgr->flightPlan()->findWayptIndex(_currentWaypt->position());
 832       if (index >= 0) {
 833         SG_LOG(SG_INSTR, SG_INFO, "GPS DTO, resuming LEG mode at wp:" << index);
 834         _mode = "leg";
 835         _routeMgr->jumpToIndex(index);
 836       }
 837     }
 838
 839     if (_mode == "dto") {
 840       // if we didn't enter leg mode, drop back to OBS mode
 841       // select OBS mode, but keep current waypoint-as is
 842       _mode = "obs";
 843       wp1Changed();
 844     }
 845   } else if (_mode == "leg") {
 846     SG_LOG(SG_INSTR, SG_DEBUG, "GPS doing overflight sequencing");
 847     _routeMgr->sequence();
 848   } else if (_mode == "obs") {
 849     // nothing to do here, TO/FROM will update but that's fine
 850   }
 851
 852   _computeTurnData = true;
 853 }
 854
 855 void GPS::beginTurn()
 856 {
 857   _inTurn = true;
 858   _turnSequenced = false;
 859   SG_LOG(SG_INSTR, SG_INFO, "beginning turn");
 860 }
 861
 862 void GPS::endTurn()
 863 {
 864   _inTurn = false;
 865   SG_LOG(SG_INSTR, SG_INFO, "ending turn");
 866   _computeTurnData = true;
 867 }
 868
 869 double GPS::computeTurnProgress(double aBearing) const
 870 {
 871   double startBearing = _turnStartBearing + copysign(90, _turnAngle);
 872   return (aBearing - startBearing) / _turnAngle;
 873 }
 874
 875 void GPS::computeTurnData()
 876 {
 877   _computeTurnData = false;
 878   int nextIndex = _routeMgr->currentIndex() + 1;
 879   if ((_mode != "leg") || (nextIndex >= _routeMgr->numWaypts())) {
 880     _anticipateTurn = false;
 881     return;
 882   }
 883
 884   WayptRef next = _routeMgr->wayptAtIndex(nextIndex);
 885   if (next->flag(WPT_DYNAMIC) || !_config.turnAnticipationEnabled()) {
 886     _anticipateTurn = false;
 887     return;
 888   }
 889
 890   _turnStartBearing = _desiredCourse;
 891 // compute next leg course
 892   double crs, dist;
 893   boost::tie(crs, dist) = next->courseAndDistanceFrom(_currentWaypt->position());
 894
 895
 896 // compute offset bearing
 897   _turnAngle = crs - _turnStartBearing;
 898   SG_NORMALIZE_RANGE(_turnAngle, -180.0, 180.0);
 899   double median = _turnStartBearing + (_turnAngle * 0.5);
 900   double offsetBearing = median + copysign(90, _turnAngle);
 901   SG_NORMALIZE_RANGE(offsetBearing, 0.0, 360.0);
 902
 903   SG_LOG(SG_INSTR, SG_INFO, "GPS computeTurnData: in=" << _turnStartBearing <<
 904     ", out=" << crs << "; turnAngle=" << _turnAngle << ", median=" << median
 905     << ", offset=" << offsetBearing);
 906
 907   SG_LOG(SG_INSTR, SG_INFO, "next leg is now:" << _currentWaypt->ident() << "->" << next->ident());
 908
 909   _turnPt = _currentWaypt->position();
 910   _anticipateTurn = true;
 911 }
 912
 913 void GPS::updateTurnData()
 914 {
 915   // depends on ground speed, so needs to be updated per-frame
 916   _turnRadius = computeTurnRadiusNm(_last_speed_kts);
 917
 918   // compute the turn centre, based on the turn radius.
 919   // key thing is to understand that we're working a right-angle triangle,
 920   // where the right-angle is the point we start the turn. From that point,
 921   // one side is the inbound course to the turn pt, and the other is the
 922   // perpendicular line, of length 'r', to the turn centre.
 923   // the triangle's hypotenuse, which we need to find, is the distance from the
 924   // turn pt to the turn center (in the direction of the offset bearing)
 925   // note that d - _turnRadius tell us how much we're 'cutting' the corner.
 926
 927   double halfTurnAngle = fabs(_turnAngle * 0.5) * SG_DEGREES_TO_RADIANS;
 928   double d = _turnRadius / cos(halfTurnAngle);
 929
 930  // SG_LOG(SG_INSTR, SG_INFO, "turnRadius=" << _turnRadius << ", d=" << d
 931  //   << " (cut distance=" << d - _turnRadius << ")");
 932
 933   double median = _turnStartBearing + (_turnAngle * 0.5);
 934   double offsetBearing = median + copysign(90, _turnAngle);
 935   SG_NORMALIZE_RANGE(offsetBearing, 0.0, 360.0);
 936
 937   double az2;
 938   SGGeodesy::direct(_turnPt, offsetBearing, d * SG_NM_TO_METER, _turnCentre, az2);
 939 }
 940
 941 double GPS::computeTurnRadiusNm(double aGroundSpeedKts) const
 942 {
 943         // turn time is seconds to execute a 360 turn.
 944   double turnTime = 360.0 / _config.turnRateDegSec();
 945
 946   // c is ground distance covered in that time (circumference of the circle)
 947         double c = turnTime * (aGroundSpeedKts / 3600.0); // convert knts to nm/sec
 948
 949   // divide by 2PI to go from circumference -> radius
 950         return c / (2 * M_PI);
 951 }
 952
 953 void GPS::updateRouteData()
 954 {
 955   double totalDistance = _wayptController->distanceToWayptM() * SG_METER_TO_NM;
 956   // walk all waypoints from wp2 to route end, and sum
 957   for (int i=_routeMgr->currentIndex()+1; i<_routeMgr->numWaypts(); ++i) {
 958     //totalDistance += _routeMgr->get_waypoint(i).get_distance();
 959   }
 960
 961   _routeDistanceNm->setDoubleValue(totalDistance * SG_METER_TO_NM);
 962   if (_last_speed_kts > 1.0) {
 963     double TTW = ((totalDistance * SG_METER_TO_NM) / _last_speed_kts) * 3600.0;
 964     _routeETE->setStringValue(makeTTWString(TTW));
 965   }
 966 }
 967
 968 void GPS::driveAutopilot()
 969 {
 970   if (!_config.driveAutopilot() || !_realismSimpleGps->getBoolValue()) {
 971     _apDrivingFlag->setBoolValue(false);
 972     return;
 973   }
 974
 975   // compatability feature - allow the route-manager / GPS to drive the
 976   // generic autopilot heading hold *in leg mode only*
 977
 978   bool drive = _mode == "leg";
 979   _apDrivingFlag->setBoolValue(drive);
 980
 981   if (drive) {
 982     // FIXME: we want to set desired track, not heading, here
 983     _apTrueHeading->setDoubleValue(getWP1Bearing());
 984   }
 985 }
 986
 987 void GPS::wp1Changed()
 988 {
 989   if (!_currentWaypt)
 990     return;
 991   if (_mode == "leg") {
 992     _wayptController.reset(WayptController::createForWaypt(this, _currentWaypt));
 993   } else if (_mode == "obs") {
 994     _wayptController.reset(new OBSController(this, _currentWaypt));
 995   } else if (_mode == "dto") {
 996     _wayptController.reset(new DirectToController(this, _currentWaypt, _wp0_position));
 997   }
 998
 999   _wayptController->init();
1000
1001   if (_mode == "obs") {
1002     _legDistanceNm = -1.0;
1003   } else {
1004     _wayptController->update();
1005     _legDistanceNm = _wayptController->distanceToWayptM() * SG_METER_TO_NM;
1006   }
1007
1008   if (!_config.driveAutopilot()) {
1009     return;
1010   }
1011
1012   RouteRestriction ar = _currentWaypt->altitudeRestriction();
1013   double restrictAlt = _currentWaypt->altitudeFt();
1014   double alt = _indicated_pos.getElevationFt();
1015   if ((ar == RESTRICT_AT) ||
1016        ((ar == RESTRICT_ABOVE) && (alt < restrictAlt)) ||
1017        ((ar == RESTRICT_BELOW) && (alt > restrictAlt)))
1018   {
1019     SG_LOG(SG_AUTOPILOT, SG_INFO, "current waypt has altitude set, setting on AP");
1020     _apTargetAltitudeFt->setDoubleValue(restrictAlt);
1021   }
1022 }
1023
1024 /////////////////////////////////////////////////////////////////////////////
1025 // property getter/setters
1026
1027 void GPS::setSelectedCourse(double crs)
1028 {
1029   if (_selectedCourse == crs) {
1030     return;
1031   }
1032
1033   _selectedCourse = crs;
1034   if ((_mode == "obs") || _config.courseSelectable()) {
1035     _desiredCourse = _selectedCourse;
1036     _desiredCourseNode->fireValueChanged();
1037   }
1038 }
1039
1040 double GPS::getLegDistance() const
1041 {
1042   if (!_dataValid || (_mode == "obs")) {
1043     return -1;
1044   }
1045
1046   return _legDistanceNm;
1047 }
1048
1049 double GPS::getLegCourse() const
1050 {
1051   if (!_dataValid || !_wayptController.get()) {
1052     return -9999.0;
1053   }
1054
1055   return _wayptController->targetTrackDeg();
1056 }
1057
1058 double GPS::getLegMagCourse() const
1059 {
1060   if (!_dataValid) {
1061     return 0.0;
1062   }
1063
1064   double m = getLegCourse() - _magvar_node->getDoubleValue();
1065   SG_NORMALIZE_RANGE(m, 0.0, 360.0);
1066   return m;
1067 }
1068
1069 double GPS::getMagTrack() const
1070 {
1071   if (!_dataValid) {
1072     return 0.0;
1073   }
1074
1075   double m = getTrueTrack() - _magvar_node->getDoubleValue();
1076   SG_NORMALIZE_RANGE(m, 0.0, 360.0);
1077   return m;
1078 }
1079
1080 double GPS::getCDIDeflection() const
1081 {
1082   if (!_dataValid) {
1083     return 0.0;
1084   }
1085
1086   double defl;
1087   if (_config.cdiDeflectionIsAngular()) {
1088     defl = getWP1CourseDeviation();
1089     SG_CLAMP_RANGE(defl, -10.0, 10.0); // as in navradio.cxx
1090   } else {
1091     double fullScale = _config.cdiDeflectionLinearPeg();
1092     double normError = getWP1CourseErrorNm() / fullScale;
1093     SG_CLAMP_RANGE(normError, -1.0, 1.0);
1094     defl = normError * 10.0; // re-scale to navradio limits, i.e [-10.0 .. 10.0]
1095   }
1096
1097   return defl;
1098 }
1099
1100 const char* GPS::getWP0Ident() const
1101 {
1102   if (!_dataValid || (_mode != "leg") || (!_prevWaypt)) {
1103     return "";
1104   }
1105
1106   return _prevWaypt->ident().c_str();
1107 }
1108
1109 const char* GPS::getWP0Name() const
1110 {
1111   return "";
1112 }
1113
1114 const char* GPS::getWP1Ident() const
1115 {
1116   if ((!_dataValid)||(!_currentWaypt)) {
1117     return "";
1118   }
1119
1120   return _currentWaypt->ident().c_str();
1121 }
1122
1123 const char* GPS::getWP1Name() const
1124 {
1125   return "";
1126 }
1127
1128 double GPS::getWP1Distance() const
1129 {
1130   if (!_dataValid || !_wayptController.get()) {
1131     return -1.0;
1132   }
1133
1134   return _wayptController->distanceToWayptM() * SG_METER_TO_NM;
1135 }
1136
1137 double GPS::getWP1TTW() const
1138 {
1139   if (!_dataValid || !_wayptController.get()) {
1140     return -1.0;
1141   }
1142
1143   return _wayptController->timeToWaypt();
1144 }
1145
1146 const char* GPS::getWP1TTWString() const
1147 {
1148   double t = getWP1TTW();
1149   if (t <= 0.0) {
1150     return "";
1151   }
1152
1153   return makeTTWString(t);
1154 }
1155
1156 double GPS::getWP1Bearing() const
1157 {
1158   if (!_dataValid || !_wayptController.get()) {
1159     return -9999.0;
1160   }
1161
1162   return _wayptController->trueBearingDeg();
1163 }
1164
1165 double GPS::getWP1MagBearing() const
1166 {
1167   if (!_dataValid || !_wayptController.get()) {
1168     return -9999.0;
1169   }
1170
1171   double magBearing =  _wayptController->trueBearingDeg() - _magvar_node->getDoubleValue();
1172   SG_NORMALIZE_RANGE(magBearing, 0.0, 360.0);
1173   return magBearing;
1174 }
1175
1176 double GPS::getWP1CourseDeviation() const
1177 {
1178   if (!_dataValid || !_wayptController.get()) {
1179     return 0.0;
1180   }
1181
1182   return _wayptController->courseDeviationDeg();
1183 }
1184
1185 double GPS::getWP1CourseErrorNm() const
1186 {
1187   if (!_dataValid || !_wayptController.get()) {
1188     return 0.0;
1189   }
1190
1191   return _wayptController->xtrackErrorNm();
1192 }
1193
1194 bool GPS::getWP1ToFlag() const
1195 {
1196   if (!_dataValid || !_wayptController.get()) {
1197     return false;
1198   }
1199
1200   return _wayptController->toFlag();
1201 }
1202
1203 bool GPS::getWP1FromFlag() const
1204 {
1205   if (!_dataValid || !_wayptController.get()) {
1206     return false;
1207   }
1208
1209   return !getWP1ToFlag();
1210 }
1211
1212 double GPS::getScratchDistance() const
1213 {
1214   if (!_scratchValid) {
1215     return 0.0;
1216   }
1217
1218   return SGGeodesy::distanceNm(_indicated_pos, _scratchPos);
1219 }
1220
1221 double GPS::getScratchTrueBearing() const
1222 {
1223   if (!_scratchValid) {
1224     return 0.0;
1225   }
1226
1227   return SGGeodesy::courseDeg(_indicated_pos, _scratchPos);
1228 }
1229
1230 double GPS::getScratchMagBearing() const
1231 {
1232   if (!_scratchValid) {
1233     return 0.0;
1234   }
1235
1236   double crs = getScratchTrueBearing() - _magvar_node->getDoubleValue();
1237   SG_NORMALIZE_RANGE(crs, 0.0, 360.0);
1238   return crs;
1239 }
1240
1241 /////////////////////////////////////////////////////////////////////////////
1242 // command / scratch / search system
1243
1244 void GPS::setCommand(const char* aCmd)
1245 {
1246   SG_LOG(SG_INSTR, SG_DEBUG, "GPS command:" << aCmd);
1247
1248   if (!strcmp(aCmd, "direct")) {
1249     directTo();
1250   } else if (!strcmp(aCmd, "obs")) {
1251     selectOBSMode();
1252   } else if (!strcmp(aCmd, "leg")) {
1253     selectLegMode();
1254   } else if (!strcmp(aCmd, "load-route-wpt")) {
1255     loadRouteWaypoint();
1256   } else if (!strcmp(aCmd, "nearest")) {
1257     loadNearest();
1258   } else if (!strcmp(aCmd, "search")) {
1259     _searchNames = false;
1260     search();
1261   } else if (!strcmp(aCmd, "search-names")) {
1262     _searchNames = true;
1263     search();
1264   } else if (!strcmp(aCmd, "next")) {
1265     nextResult();
1266   } else if (!strcmp(aCmd, "previous")) {
1267     previousResult();
1268   } else if (!strcmp(aCmd, "define-user-wpt")) {
1269     defineWaypoint();
1270   } else if (!strcmp(aCmd, "route-insert-before")) {
1271     int index = _scratchNode->getIntValue("index");
1272     if (index < 0 || (_routeMgr->numWaypts() == 0)) {
1273       index = _routeMgr->numWaypts();
1274     } else if (index >= _routeMgr->numWaypts()) {
1275       SG_LOG(SG_INSTR, SG_WARN, "GPS:route-insert-before, bad index:" << index);
1276       return;
1277     }
1278
1279     insertWaypointAtIndex(index);
1280   } else if (!strcmp(aCmd, "route-insert-after")) {
1281     int index = _scratchNode->getIntValue("index");
1282     if (index < 0 || (_routeMgr->numWaypts() == 0)) {
1283       index = _routeMgr->numWaypts();
1284     } else if (index >= _routeMgr->numWaypts()) {
1285       SG_LOG(SG_INSTR, SG_WARN, "GPS:route-insert-after, bad index:" << index);
1286       return;
1287     } else {
1288       ++index;
1289     }
1290
1291     insertWaypointAtIndex(index);
1292   } else if (!strcmp(aCmd, "route-delete")) {
1293     int index = _scratchNode->getIntValue("index");
1294     if (index < 0) {
1295       index = _routeMgr->numWaypts();
1296     } else if (index >= _routeMgr->numWaypts()) {
1297       SG_LOG(SG_INSTR, SG_WARN, "GPS:route-delete, bad index:" << index);
1298       return;
1299     }
1300
1301     removeWaypointAtIndex(index);
1302   } else {
1303     SG_LOG(SG_INSTR, SG_WARN, "GPS:unrecognized command:" << aCmd);
1304   }
1305 }
1306
1307 void GPS::clearScratch()
1308 {
1309   _scratchPos = SGGeod::fromDegFt(-9999.0, -9999.0, -9999.0);
1310   _scratchValid = false;
1311   _scratchNode->setStringValue("type", "");
1312   _scratchNode->setStringValue("query", "");
1313 }
1314
1315 bool GPS::isScratchPositionValid() const
1316 {
1317   if ((_scratchPos.getLongitudeDeg() < -9990.0) ||
1318       (_scratchPos.getLatitudeDeg() < -9990.0)) {
1319    return false;
1320   }
1321
1322   return true;
1323 }
1324
1325 void GPS::directTo()
1326 {
1327   if (!isScratchPositionValid()) {
1328     return;
1329   }
1330
1331   _prevWaypt = NULL;
1332   _wp0_position = _indicated_pos;
1333   _currentWaypt = new BasicWaypt(_scratchPos, _scratchNode->getStringValue("ident"), NULL);
1334   _mode = "dto";
1335
1336   clearScratch();
1337   wp1Changed();
1338 }
1339
1340 void GPS::loadRouteWaypoint()
1341 {
1342   _scratchValid = false;
1343 //  if (!_routeMgr->isRouteActive()) {
1344 //    SG_LOG(SG_INSTR, SG_WARN, "GPS:loadWaypoint: no active route");
1345 //    return;
1346 //  }
1347
1348   int index = _scratchNode->getIntValue("index", -9999);
1349   clearScratch();
1350
1351   if ((index < 0) || (index >= _routeMgr->numWaypts())) { // no index supplied, use current wp
1352     index = _routeMgr->currentIndex();
1353   }
1354
1355   _searchIsRoute = true;
1356   setScratchFromRouteWaypoint(index);
1357 }
1358
1359 void GPS::setScratchFromRouteWaypoint(int aIndex)
1360 {
1361   assert(_searchIsRoute);
1362   if ((aIndex < 0) || (aIndex >= _routeMgr->numWaypts())) {
1363     SG_LOG(SG_INSTR, SG_WARN, "GPS:setScratchFromRouteWaypoint: route-index out of bounds");
1364     return;
1365   }
1366
1367   _searchResultIndex = aIndex;
1368   WayptRef wp = _routeMgr->wayptAtIndex(aIndex);
1369   _scratchNode->setStringValue("ident", wp->ident());
1370   _scratchPos = wp->position();
1371   _scratchValid = true;
1372   _scratchNode->setIntValue("index", aIndex);
1373 }
1374
1375 void GPS::loadNearest()
1376 {
1377   string sty(_scratchNode->getStringValue("type"));
1378   FGPositioned::Type ty = FGPositioned::typeFromName(sty);
1379   if (ty == FGPositioned::INVALID) {
1380     SG_LOG(SG_INSTR, SG_WARN, "GPS:loadNearest: request type is invalid:" << sty);
1381     return;
1382   }
1383
1384   auto_ptr<FGPositioned::Filter> f(createFilter(ty));
1385   int limitCount = _scratchNode->getIntValue("max-results", 1);
1386   double cutoffDistance = _scratchNode->getDoubleValue("cutoff-nm", 400.0);
1387
1388   SGGeod searchPos = _indicated_pos;
1389   if (isScratchPositionValid()) {
1390     searchPos = _scratchPos;
1391   }
1392
1393   clearScratch(); // clear now, regardless of whether we find a match or not
1394
1395   _searchResults =
1396     FGPositioned::findClosestN(searchPos, limitCount, cutoffDistance, f.get());
1397   _searchResultIndex = 0;
1398   _searchIsRoute = false;
1399
1400   if (_searchResults.empty()) {
1401     return;
1402   }
1403
1404   setScratchFromCachedSearchResult();
1405 }
1406
1407 bool GPS::SearchFilter::pass(FGPositioned* aPos) const
1408 {
1409   switch (aPos->type()) {
1410   case FGPositioned::AIRPORT:
1411   // heliport and seaport too?
1412   case FGPositioned::VOR:
1413   case FGPositioned::NDB:
1414   case FGPositioned::FIX:
1415   case FGPositioned::TACAN:
1416   case FGPositioned::WAYPOINT:
1417     return true;
1418   default:
1419     return false;
1420   }
1421 }
1422
1423 FGPositioned::Type GPS::SearchFilter::minType() const
1424 {
1425   return FGPositioned::AIRPORT;
1426 }
1427
1428 FGPositioned::Type GPS::SearchFilter::maxType() const
1429 {
1430   return FGPositioned::VOR;
1431 }
1432
1433 FGPositioned::Filter* GPS::createFilter(FGPositioned::Type aTy)
1434 {
1435   if (aTy == FGPositioned::AIRPORT) {
1436     return new FGAirport::HardSurfaceFilter();
1437   }
1438
1439   // if we were passed INVALID, assume it means 'all types interesting to a GPS'
1440   if (aTy == FGPositioned::INVALID) {
1441     return new SearchFilter;
1442   }
1443
1444   return new FGPositioned::TypeFilter(aTy);
1445 }
1446
1447 void GPS::search()
1448 {
1449   // parse search terms into local members, and exec the first search
1450   string sty(_scratchNode->getStringValue("type"));
1451   _searchType = FGPositioned::typeFromName(sty);
1452   _searchQuery = _scratchNode->getStringValue("query");
1453   if (_searchQuery.empty()) {
1454     SG_LOG(SG_INSTR, SG_WARN, "empty GPS search query");
1455     clearScratch();
1456     return;
1457   }
1458
1459   _searchExact = _scratchNode->getBoolValue("exact", true);
1460   _searchResultIndex = 0;
1461   _searchIsRoute = false;
1462
1463   auto_ptr<FGPositioned::Filter> f(createFilter(_searchType));
1464   if (_searchNames) {
1465     _searchResults = FGPositioned::findAllWithName(_searchQuery, f.get(), _searchExact);
1466   } else {
1467     _searchResults = FGPositioned::findAllWithIdent(_searchQuery, f.get(), _searchExact);
1468   }
1469
1470   bool orderByRange = _scratchNode->getBoolValue("order-by-distance", true);
1471   if (orderByRange) {
1472     FGPositioned::sortByRange(_searchResults, _indicated_pos);
1473   }
1474
1475   if (_searchResults.empty()) {
1476     clearScratch();
1477     return;
1478   }
1479
1480   setScratchFromCachedSearchResult();
1481 }
1482
1483 bool GPS::getScratchHasNext() const
1484 {
1485   int lastResult;
1486   if (_searchIsRoute) {
1487     lastResult = _routeMgr->numWaypts() - 1;
1488   } else {
1489     lastResult = (int) _searchResults.size() - 1;
1490   }
1491
1492   if (lastResult < 0) { // search array might be empty
1493     return false;
1494   }
1495
1496   return (_searchResultIndex < lastResult);
1497 }
1498
1499 void GPS::setScratchFromCachedSearchResult()
1500 {
1501   int index = _searchResultIndex;
1502
1503   if ((index < 0) || (index >= (int) _searchResults.size())) {
1504     SG_LOG(SG_INSTR, SG_WARN, "GPS:setScratchFromCachedSearchResult: index out of bounds:" << index);
1505     return;
1506   }
1507
1508   setScratchFromPositioned(_searchResults[index], index);
1509 }
1510
1511 void GPS::setScratchFromPositioned(FGPositioned* aPos, int aIndex)
1512 {
1513   clearScratch();
1514   assert(aPos);
1515
1516   _scratchPos = aPos->geod();
1517   _scratchNode->setStringValue("name", aPos->name());
1518   _scratchNode->setStringValue("ident", aPos->ident());
1519   _scratchNode->setStringValue("type", FGPositioned::nameForType(aPos->type()));
1520
1521   if (aIndex >= 0) {
1522     _scratchNode->setIntValue("index", aIndex);
1523   }
1524
1525   _scratchValid = true;
1526   _scratchNode->setIntValue("result-count", _searchResults.size());
1527
1528   switch (aPos->type()) {
1529   case FGPositioned::VOR:
1530     _scratchNode->setDoubleValue("frequency-mhz", static_cast<FGNavRecord*>(aPos)->get_freq() / 100.0);
1531     break;
1532
1533   case FGPositioned::NDB:
1534     _scratchNode->setDoubleValue("frequency-khz", static_cast<FGNavRecord*>(aPos)->get_freq() / 100.0);
1535     break;
1536
1537   case FGPositioned::AIRPORT:
1538     addAirportToScratch((FGAirport*)aPos);
1539     break;
1540
1541   default:
1542       // no-op
1543       break;
1544   }
1545
1546   // look for being on the route and set?
1547 }
1548
1549 void GPS::addAirportToScratch(FGAirport* aAirport)
1550 {
1551   for (unsigned int r=0; r<aAirport->numRunways(); ++r) {
1552     SGPropertyNode* rwyNd = _scratchNode->getChild("runways", r, true);
1553     FGRunway* rwy = aAirport->getRunwayByIndex(r);
1554     // TODO - filter out unsuitable runways in the future
1555     // based on config again
1556
1557     rwyNd->setStringValue("id", rwy->ident().c_str());
1558     rwyNd->setIntValue("length-ft", rwy->lengthFt());
1559     rwyNd->setIntValue("width-ft", rwy->widthFt());
1560     rwyNd->setIntValue("heading-deg", rwy->headingDeg());
1561     // map surface code to a string
1562     // TODO - lighting information
1563
1564     if (rwy->ILS()) {
1565       rwyNd->setDoubleValue("ils-frequency-mhz", rwy->ILS()->get_freq() / 100.0);
1566     }
1567   } // of runways iteration
1568 }
1569
1570
1571 void GPS::selectOBSMode()
1572 {
1573   if (!isScratchPositionValid()) {
1574     return;
1575   }
1576
1577   _mode = "obs";
1578   _currentWaypt = new BasicWaypt(_scratchPos, _scratchNode->getStringValue("ident"), NULL);
1579   _wp0_position = _indicated_pos;
1580   wp1Changed();
1581 }
1582
1583 void GPS::selectLegMode()
1584 {
1585   if (_mode == "leg") {
1586     return;
1587   }
1588
1589   if (!_routeMgr->isRouteActive()) {
1590     SG_LOG(SG_INSTR, SG_WARN, "GPS:selectLegMode: no active route");
1591     return;
1592   }
1593
1594   _mode = "leg";
1595   // depending on the situation, this will either get over-written
1596   // in routeManagerSequenced or not; either way it does no harm to
1597   // set it here.
1598   _wp0_position = _indicated_pos;
1599
1600   // not really sequenced, but does all the work of updating wp0/1
1601   routeManagerSequenced();
1602 }
1603
1604 void GPS::nextResult()
1605 {
1606   if (!getScratchHasNext()) {
1607     return;
1608   }
1609
1610   clearScratch();
1611   if (_searchIsRoute) {
1612     setScratchFromRouteWaypoint(++_searchResultIndex);
1613   } else {
1614     ++_searchResultIndex;
1615     setScratchFromCachedSearchResult();
1616   }
1617 }
1618
1619 void GPS::previousResult()
1620 {
1621   if (_searchResultIndex <= 0) {
1622     return;
1623   }
1624
1625   clearScratch();
1626   --_searchResultIndex;
1627
1628   if (_searchIsRoute) {
1629     setScratchFromRouteWaypoint(_searchResultIndex);
1630   } else {
1631     setScratchFromCachedSearchResult();
1632   }
1633 }
1634
1635 void GPS::defineWaypoint()
1636 {
1637   if (!isScratchPositionValid()) {
1638     SG_LOG(SG_INSTR, SG_WARN, "GPS:defineWaypoint: invalid lat/lon");
1639     return;
1640   }
1641
1642   string ident = _scratchNode->getStringValue("ident");
1643   if (ident.size() < 2) {
1644     SG_LOG(SG_INSTR, SG_WARN, "GPS:defineWaypoint: waypoint identifier must be at least two characters");
1645     return;
1646   }
1647
1648 // check for duplicate idents
1649   FGPositioned::TypeFilter f(FGPositioned::WAYPOINT);
1650   FGPositioned::List dups = FGPositioned::findAllWithIdent(ident, &f);
1651   if (!dups.empty()) {
1652     SG_LOG(SG_INSTR, SG_WARN, "GPS:defineWaypoint: non-unique waypoint identifier, ho-hum");
1653   }
1654
1655   SG_LOG(SG_INSTR, SG_INFO, "GPS:defineWaypoint: creating waypoint:" << ident);
1656   FGPositionedRef wpt = FGPositioned::createUserWaypoint(ident, _scratchPos);
1657   _searchResults.clear();
1658   _searchResults.push_back(wpt);
1659   setScratchFromPositioned(wpt.get(), -1);
1660 }
1661
1662 void GPS::insertWaypointAtIndex(int aIndex)
1663 {
1664   // note we do allow index = routeMgr->size(), that's an append
1665   if ((aIndex < 0) || (aIndex > _routeMgr->numWaypts())) {
1666     throw sg_range_exception("GPS::insertWaypointAtIndex: index out of bounds");
1667   }
1668
1669   if (!isScratchPositionValid()) {
1670     SG_LOG(SG_INSTR, SG_WARN, "GPS:insertWaypointAtIndex: invalid lat/lon");
1671     return;
1672   }
1673
1674   string ident = _scratchNode->getStringValue("ident");
1675
1676   WayptRef wpt = new BasicWaypt(_scratchPos, ident, NULL);
1677   _routeMgr->flightPlan()->insertWayptAtIndex(wpt, aIndex);
1678 }
1679
1680 void GPS::removeWaypointAtIndex(int aIndex)
1681 {
1682   if ((aIndex < 0) || (aIndex >= _routeMgr->numWaypts())) {
1683     throw sg_range_exception("GPS::removeWaypointAtIndex: index out of bounds");
1684   }
1685
1686   _routeMgr->removeLegAtIndex(aIndex);
1687 }
1688
1689 void GPS::tieSGGeod(SGPropertyNode* aNode, SGGeod& aRef,
1690   const char* lonStr, const char* latStr, const char* altStr)
1691 {
1692   tie(aNode, lonStr, SGRawValueMethods<SGGeod, double>(aRef, &SGGeod::getLongitudeDeg, &SGGeod::setLongitudeDeg));
1693   tie(aNode, latStr, SGRawValueMethods<SGGeod, double>(aRef, &SGGeod::getLatitudeDeg, &SGGeod::setLatitudeDeg));
1694
1695   if (altStr) {
1696     tie(aNode, altStr, SGRawValueMethods<SGGeod, double>(aRef, &SGGeod::getElevationFt, &SGGeod::setElevationFt));
1697   }
1698 }
1699
1700 void GPS::tieSGGeodReadOnly(SGPropertyNode* aNode, SGGeod& aRef,
1701   const char* lonStr, const char* latStr, const char* altStr)
1702 {
1703   tie(aNode, lonStr, SGRawValueMethods<SGGeod, double>(aRef, &SGGeod::getLongitudeDeg, NULL));
1704   tie(aNode, latStr, SGRawValueMethods<SGGeod, double>(aRef, &SGGeod::getLatitudeDeg, NULL));
1705
1706   if (altStr) {
1707     tie(aNode, altStr, SGRawValueMethods<SGGeod, double>(aRef, &SGGeod::getElevationFt, NULL));
1708   }
1709 }
1710
1711 // end of gps.cxx