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