src/Autopilot/route_mgr.cxx

   1 // route_mgr.cxx - manage a route (i.e. a collection of waypoints)
   2 //
   3 // Written by Curtis Olson, started January 2004.
   4 //            Norman Vine
   5 //            Melchior FRANZ
   6 //
   7 // Copyright (C) 2004  Curtis L. Olson  - http://www.flightgear.org/~curt
   8 //
   9 // This program is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU General Public License as
  11 // published by the Free Software Foundation; either version 2 of the
  12 // License, or (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful, but
  15 // WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23 // $Id$
  24
  25
  26 #ifdef HAVE_CONFIG_H
  27 #  include <config.h>
  28 #endif
  29
  30 #ifdef HAVE_WINDOWS_H
  31 #include <time.h>
  32 #endif
  33
  34 #include <simgear/compiler.h>
  35
  36 #include "route_mgr.hxx"
  37
  38 #include <boost/algorithm/string/case_conv.hpp>
  39 #include <boost/tuple/tuple.hpp>
  40
  41 #include <simgear/misc/strutils.hxx>
  42 #include <simgear/structure/exception.hxx>
  43 #include <simgear/structure/commands.hxx>
  44 #include <simgear/misc/sgstream.hxx>
  45
  46 #include <simgear/props/props_io.hxx>
  47 #include <simgear/misc/sg_path.hxx>
  48 #include <simgear/route/route.hxx>
  49 #include <simgear/sg_inlines.h>
  50
  51 #include "Main/fg_props.hxx"
  52 #include "Navaids/positioned.hxx"
  53 #include <Navaids/waypoint.hxx>
  54 #include <Navaids/airways.hxx>
  55 #include <Navaids/procedure.hxx>
  56 #include "Airports/simple.hxx"
  57 #include "Airports/runways.hxx"
  58
  59 #define RM "/autopilot/route-manager/"
  60
  61 #include <GUI/new_gui.hxx>
  62 #include <GUI/dialog.hxx>
  63
  64 using namespace flightgear;
  65
  66 class PropertyWatcher : public SGPropertyChangeListener
  67 {
  68 public:
  69   void watch(SGPropertyNode* p)
  70   {
  71     p->addChangeListener(this, false);
  72   }
  73
  74   virtual void valueChanged(SGPropertyNode*)
  75   {
  76     fire();
  77   }
  78 protected:
  79   virtual void fire() = 0;
  80 };
  81
  82 /**
  83  * Template adapter, created by convenience helper below
  84  */
  85 template <class T>
  86 class MethodPropertyWatcher : public PropertyWatcher
  87 {
  88 public:
  89   typedef void (T::*fire_method)();
  90
  91   MethodPropertyWatcher(T* obj, fire_method m) :
  92     _object(obj),
  93     _method(m)
  94   { ; }
  95
  96 protected:
  97   virtual void fire()
  98   { // dispatch to the object method we're helping
  99     (_object->*_method)();
 100   }
 101
 102 private:
 103   T* _object;
 104   fire_method _method;
 105 };
 106
 107 template <class T>
 108 PropertyWatcher* createWatcher(T* obj, void (T::*m)())
 109 {
 110   return new MethodPropertyWatcher<T>(obj, m);
 111 }
 112
 113 static bool commandLoadFlightPlan(const SGPropertyNode* arg)
 114 {
 115   FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
 116   SGPath path(arg->getStringValue("path"));
 117   return self->loadRoute(path);
 118 }
 119
 120 static bool commandSaveFlightPlan(const SGPropertyNode* arg)
 121 {
 122   FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
 123   SGPath path(arg->getStringValue("path"));
 124   return self->saveRoute(path);
 125 }
 126
 127 static bool commandActivateFlightPlan(const SGPropertyNode* arg)
 128 {
 129   FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
 130   bool activate = arg->getBoolValue("activate", true);
 131   if (activate) {
 132     self->activate();
 133   } else {
 134
 135   }
 136
 137   return true;
 138 }
 139
 140 static bool commandClearFlightPlan(const SGPropertyNode*)
 141 {
 142   FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
 143   self->clearRoute();
 144   return true;
 145 }
 146
 147 static bool commandSetActiveWaypt(const SGPropertyNode* arg)
 148 {
 149   FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
 150   int index = arg->getIntValue("index");
 151   if ((index < 0) || (index >= self->numWaypts())) {
 152     return false;
 153   }
 154
 155   self->jumpToIndex(index);
 156   return true;
 157 }
 158
 159 static bool commandInsertWaypt(const SGPropertyNode* arg)
 160 {
 161   FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
 162   int index = arg->getIntValue("index");
 163   std::string ident(arg->getStringValue("id"));
 164   int alt = arg->getIntValue("altitude-ft", -999);
 165   int ias = arg->getIntValue("speed-knots", -999);
 166
 167   WayptRef wp;
 168 // lat/lon may be supplied to narrow down navaid search, or to specify
 169 // a raw waypoint
 170   SGGeod pos;
 171   if (arg->hasChild("longitude-deg")) {
 172     pos = SGGeod::fromDeg(arg->getDoubleValue("longitude-deg"),
 173                                arg->getDoubleValue("latitude-deg"));
 174   }
 175
 176   if (arg->hasChild("navaid")) {
 177     FGPositionedRef p = FGPositioned::findClosestWithIdent(arg->getStringValue("navaid"), pos);
 178
 179     if (arg->hasChild("navaid", 1)) {
 180       // intersection of two radials
 181       FGPositionedRef p2 = FGPositioned::findClosestWithIdent(arg->getStringValue("navaid[1]"), pos);
 182       if (!p2) {
 183         SG_LOG( SG_AUTOPILOT, SG_INFO, "Unable to find FGPositioned with ident:" << arg->getStringValue("navaid[1]"));
 184         return false;
 185       }
 186
 187       double r1 = arg->getDoubleValue("radial"),
 188         r2 = arg->getDoubleValue("radial[1]");
 189
 190       SGGeod intersection;
 191       bool ok = SGGeodesy::radialIntersection(p->geod(), r1, p2->geod(), r2, intersection);
 192       if (!ok) {
 193         SG_LOG(SG_AUTOPILOT, SG_INFO, "no valid intersection for:" << p->ident()
 194                 << "," << p2->ident());
 195         return false;
 196       }
 197
 198       std::string name = p->ident() + "-" + p2->ident();
 199       wp = new BasicWaypt(intersection, name, NULL);
 200     } else if (arg->hasChild("offset-nm") && arg->hasChild("radial")) {
 201       // offset radial from navaid
 202       double radial = arg->getDoubleValue("radial");
 203       double distanceNm = arg->getDoubleValue("offset-nm");
 204       //radial += magvar->getDoubleValue(); // convert to true bearing
 205       wp = new OffsetNavaidWaypoint(p, NULL, radial, distanceNm);
 206     } else {
 207       wp = new NavaidWaypoint(p, NULL);
 208     }
 209   } else if (arg->hasChild("airport")) {
 210     const FGAirport* apt = fgFindAirportID(arg->getStringValue("airport"));
 211     if (!apt) {
 212       SG_LOG(SG_AUTOPILOT, SG_INFO, "no such airport" << arg->getStringValue("airport"));
 213       return false;
 214     }
 215
 216     if (arg->hasChild("runway")) {
 217       if (!apt->hasRunwayWithIdent(arg->getStringValue("runway"))) {
 218         SG_LOG(SG_AUTOPILOT, SG_INFO, "No runway: " << arg->getStringValue("runway") << " at " << apt->ident());
 219         return false;
 220       }
 221
 222       FGRunway* runway = apt->getRunwayByIdent(arg->getStringValue("runway"));
 223       wp = new RunwayWaypt(runway, NULL);
 224     } else {
 225       wp = new NavaidWaypoint((FGAirport*) apt, NULL);
 226     }
 227   } else if (arg->hasChild("text")) {
 228     wp = self->waypointFromString(arg->getStringValue("text"));
 229   } else if (!(pos == SGGeod())) {
 230     // just a raw lat/lon
 231     wp = new BasicWaypt(pos, ident, NULL);
 232   } else {
 233     return false; // failed to build waypoint
 234   }
 235
 236   if (alt >= 0) {
 237     wp->setAltitude(alt, flightgear::RESTRICT_AT);
 238   }
 239
 240   if (ias > 0) {
 241     wp->setSpeed(ias, flightgear::RESTRICT_AT);
 242   }
 243
 244   self->insertWayptAtIndex(wp, index);
 245   return true;
 246 }
 247
 248 static bool commandDeleteWaypt(const SGPropertyNode* arg)
 249 {
 250   FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
 251   int index = arg->getIntValue("index");
 252   self->removeWayptAtIndex(index);
 253   return true;
 254 }
 255
 256 /////////////////////////////////////////////////////////////////////////////
 257
 258 FGRouteMgr::FGRouteMgr() :
 259   _currentIndex(0),
 260   input(fgGetNode( RM "input", true )),
 261   mirror(fgGetNode( RM "route", true ))
 262 {
 263   listener = new InputListener(this);
 264   input->setStringValue("");
 265   input->addChangeListener(listener);
 266
 267   SGCommandMgr::instance()->addCommand("load-flightplan", commandLoadFlightPlan);
 268   SGCommandMgr::instance()->addCommand("save-flightplan", commandSaveFlightPlan);
 269   SGCommandMgr::instance()->addCommand("activate-flightplan", commandActivateFlightPlan);
 270   SGCommandMgr::instance()->addCommand("clear-flightplan", commandClearFlightPlan);
 271   SGCommandMgr::instance()->addCommand("set-active-waypt", commandSetActiveWaypt);
 272   SGCommandMgr::instance()->addCommand("insert-waypt", commandInsertWaypt);
 273   SGCommandMgr::instance()->addCommand("delete-waypt", commandDeleteWaypt);
 274 }
 275
 276
 277 FGRouteMgr::~FGRouteMgr()
 278 {
 279   input->removeChangeListener(listener);
 280   delete listener;
 281 }
 282
 283
 284 void FGRouteMgr::init() {
 285   SGPropertyNode_ptr rm(fgGetNode(RM));
 286
 287   lon = fgGetNode( "/position/longitude-deg", true );
 288   lat = fgGetNode( "/position/latitude-deg", true );
 289   alt = fgGetNode( "/position/altitude-ft", true );
 290   magvar = fgGetNode("/environment/magnetic-variation-deg", true);
 291
 292   departure = fgGetNode(RM "departure", true);
 293   departure->tie("airport", SGRawValueMethods<FGRouteMgr, const char*>(*this,
 294     &FGRouteMgr::getDepartureICAO, &FGRouteMgr::setDepartureICAO));
 295   departure->tie("name", SGRawValueMethods<FGRouteMgr, const char*>(*this,
 296     &FGRouteMgr::getDepartureName, NULL));
 297   departure->setStringValue("runway", "");
 298
 299   _departureWatcher = createWatcher(this, &FGRouteMgr::departureChanged);
 300   _departureWatcher->watch(departure->getChild("runway"));
 301
 302   departure->getChild("etd", 0, true);
 303   _departureWatcher->watch(departure->getChild("sid", 0, true));
 304   departure->getChild("takeoff-time", 0, true);
 305
 306   destination = fgGetNode(RM "destination", true);
 307   destination->getChild("airport", 0, true);
 308
 309   destination->tie("airport", SGRawValueMethods<FGRouteMgr, const char*>(*this,
 310     &FGRouteMgr::getDestinationICAO, &FGRouteMgr::setDestinationICAO));
 311   destination->tie("name", SGRawValueMethods<FGRouteMgr, const char*>(*this,
 312     &FGRouteMgr::getDestinationName, NULL));
 313
 314   _arrivalWatcher = createWatcher(this, &FGRouteMgr::arrivalChanged);
 315   _arrivalWatcher->watch(destination->getChild("runway", 0, true));
 316
 317   destination->getChild("eta", 0, true);
 318   _arrivalWatcher->watch(destination->getChild("star", 0, true));
 319   _arrivalWatcher->watch(destination->getChild("transition", 0, true));
 320   destination->getChild("touchdown-time", 0, true);
 321
 322   alternate = fgGetNode(RM "alternate", true);
 323   alternate->getChild("airport", 0, true);
 324   alternate->getChild("runway", 0, true);
 325
 326   cruise = fgGetNode(RM "cruise", true);
 327   cruise->getChild("altitude-ft", 0, true);
 328   cruise->setDoubleValue("altitude-ft", 10000.0);
 329   cruise->getChild("flight-level", 0, true);
 330   cruise->getChild("speed-kts", 0, true);
 331   cruise->setDoubleValue("speed-kts", 160.0);
 332
 333   _routingType = cruise->getChild("routing", 0, true);
 334   _routingType->setIntValue(ROUTE_HIGH_AIRWAYS);
 335
 336   totalDistance = fgGetNode(RM "total-distance", true);
 337   totalDistance->setDoubleValue(0.0);
 338
 339   ete = fgGetNode(RM "ete", true);
 340   ete->setDoubleValue(0.0);
 341
 342   elapsedFlightTime = fgGetNode(RM "flight-time", true);
 343   elapsedFlightTime->setDoubleValue(0.0);
 344
 345   active = fgGetNode(RM "active", true);
 346   active->setBoolValue(false);
 347
 348   airborne = fgGetNode(RM "airborne", true);
 349   airborne->setBoolValue(false);
 350
 351   _edited = fgGetNode(RM "signals/edited", true);
 352   _finished = fgGetNode(RM "signals/finished", true);
 353
 354   _currentWpt = fgGetNode(RM "current-wp", true);
 355   _currentWpt->tie(SGRawValueMethods<FGRouteMgr, int>
 356     (*this, &FGRouteMgr::currentIndex, &FGRouteMgr::jumpToIndex));
 357
 358   // temporary distance / eta calculations, for backward-compatability
 359   wp0 = fgGetNode(RM "wp", 0, true);
 360   wp0->getChild("id", 0, true);
 361   wp0->getChild("dist", 0, true);
 362   wp0->getChild("eta", 0, true);
 363   wp0->getChild("bearing-deg", 0, true);
 364
 365   wp1 = fgGetNode(RM "wp", 1, true);
 366   wp1->getChild("id", 0, true);
 367   wp1->getChild("dist", 0, true);
 368   wp1->getChild("eta", 0, true);
 369
 370   wpn = fgGetNode(RM "wp-last", 0, true);
 371   wpn->getChild("dist", 0, true);
 372   wpn->getChild("eta", 0, true);
 373
 374   update_mirror();
 375   _pathNode = fgGetNode(RM "file-path", 0, true);
 376 }
 377
 378
 379 void FGRouteMgr::postinit()
 380 {
 381   SGPath path(_pathNode->getStringValue());
 382   if (!path.isNull()) {
 383     SG_LOG(SG_AUTOPILOT, SG_INFO, "loading flight-plan from: " << path.str());
 384     loadRoute(path);
 385   }
 386
 387 // this code only matters for the --wp option now - perhaps the option
 388 // should be deprecated in favour of an explicit flight-plan file?
 389 // then the global initial waypoint list could die.
 390   string_list *waypoints = globals->get_initial_waypoints();
 391   if (waypoints) {
 392     string_list::iterator it;
 393     for (it = waypoints->begin(); it != waypoints->end(); ++it) {
 394       WayptRef w = waypointFromString(*it);
 395       if (w) {
 396         _route.push_back(w);
 397       }
 398     }
 399
 400     SG_LOG(SG_AUTOPILOT, SG_INFO, "loaded initial waypoints:" << _route.size());
 401   }
 402
 403   weightOnWheels = fgGetNode("/gear/gear[0]/wow", true);
 404   // check airbone flag agrees with presets
 405 }
 406
 407 void FGRouteMgr::bind() { }
 408 void FGRouteMgr::unbind() { }
 409
 410 bool FGRouteMgr::isRouteActive() const
 411 {
 412   return active->getBoolValue();
 413 }
 414
 415 void FGRouteMgr::update( double dt )
 416 {
 417   if (dt <= 0.0) {
 418     return; // paused, nothing to do here
 419   }
 420
 421   double groundSpeed = fgGetDouble("/velocities/groundspeed-kt", 0.0);
 422   if (airborne->getBoolValue()) {
 423     time_t now = time(NULL);
 424     elapsedFlightTime->setDoubleValue(difftime(now, _takeoffTime));
 425   } else { // not airborne
 426     if (weightOnWheels->getBoolValue() || (groundSpeed < 40)) {
 427       return;
 428     }
 429
 430     airborne->setBoolValue(true);
 431     _takeoffTime = time(NULL); // start the clock
 432     departure->setIntValue("takeoff-time", _takeoffTime);
 433   }
 434
 435   if (!active->getBoolValue()) {
 436     return;
 437   }
 438
 439 // basic course/distance information
 440   SGGeod currentPos = SGGeod::fromDegFt(lon->getDoubleValue(),
 441     lat->getDoubleValue(),alt->getDoubleValue());
 442
 443   Waypt* curWpt = currentWaypt();
 444   if (!curWpt) {
 445     return;
 446   }
 447
 448   double courseDeg;
 449   double distanceM;
 450   boost::tie(courseDeg, distanceM) = curWpt->courseAndDistanceFrom(currentPos);
 451
 452 // update wp0 / wp1 / wp-last for legacy users
 453   wp0->setDoubleValue("dist", distanceM * SG_METER_TO_NM);
 454   courseDeg -= magvar->getDoubleValue(); // expose magnetic bearing
 455   wp0->setDoubleValue("bearing-deg", courseDeg);
 456   setETAPropertyFromDistance(wp0->getChild("eta"), distanceM);
 457
 458   double totalDistanceRemaining = distanceM; // distance to current waypoint
 459
 460   Waypt* nextWpt = nextWaypt();
 461   if (nextWpt) {
 462     boost::tie(courseDeg, distanceM) = nextWpt->courseAndDistanceFrom(currentPos);
 463
 464     wp1->setDoubleValue("dist", distanceM * SG_METER_TO_NM);
 465     courseDeg -= magvar->getDoubleValue(); // expose magnetic bearing
 466     wp1->setDoubleValue("bearing-deg", courseDeg);
 467     setETAPropertyFromDistance(wp1->getChild("eta"), distanceM);
 468   }
 469
 470   Waypt* prev = curWpt;
 471   for (unsigned int i=_currentIndex + 1; i<_route.size(); ++i) {
 472     Waypt* w = _route[i];
 473     if (w->flag(WPT_DYNAMIC)) continue;
 474     totalDistanceRemaining += SGGeodesy::distanceM(prev->position(), w->position());
 475     prev = w;
 476
 477
 478   }
 479
 480   wpn->setDoubleValue("dist", totalDistanceRemaining * SG_METER_TO_NM);
 481   ete->setDoubleValue(totalDistanceRemaining * SG_METER_TO_NM / groundSpeed * 3600.0);
 482   setETAPropertyFromDistance(wpn->getChild("eta"), totalDistanceRemaining);
 483 }
 484
 485 void FGRouteMgr::setETAPropertyFromDistance(SGPropertyNode_ptr aProp, double aDistance)
 486 {
 487   double speed = fgGetDouble("/velocities/groundspeed-kt", 0.0);
 488   if (speed < 1.0) {
 489     aProp->setStringValue("--:--");
 490     return;
 491   }
 492
 493   char eta_str[64];
 494   double eta = aDistance * SG_METER_TO_NM / speed;
 495   if ( eta >= 100.0 ) {
 496       eta = 99.999; // clamp
 497   }
 498
 499   if ( eta < (1.0/6.0) ) {
 500     eta *= 60.0; // within 10 minutes, bump up to min/secs
 501   }
 502
 503   int major = (int)eta,
 504       minor = (int)((eta - (int)eta) * 60.0);
 505   snprintf( eta_str, 64, "%d:%02d", major, minor );
 506   aProp->setStringValue( eta_str );
 507 }
 508
 509 flightgear::WayptRef FGRouteMgr::removeWayptAtIndex(int aIndex)
 510 {
 511   int index = aIndex;
 512   if (aIndex < 0) { // negative indices count the the end
 513     index = _route.size() + index;
 514   }
 515
 516   if ((index < 0) || (index >= numWaypts())) {
 517     SG_LOG(SG_AUTOPILOT, SG_WARN, "removeWayptAtIndex with invalid index:" << aIndex);
 518     return NULL;
 519   }
 520   WayptVec::iterator it = _route.begin();
 521   it += index;
 522
 523   WayptRef w = *it; // hold a ref now, in case _route is the only other owner
 524   _route.erase(it);
 525
 526   update_mirror();
 527
 528   if (_currentIndex == index) {
 529     currentWaypointChanged(); // current waypoint was removed
 530   }
 531   else
 532   if (_currentIndex > index) {
 533     --_currentIndex; // shift current index down if necessary
 534   }
 535
 536   _edited->fireValueChanged();
 537   checkFinished();
 538
 539   return w;
 540 }
 541
 542 void FGRouteMgr::clearRoute()
 543 {
 544   _route.clear();
 545   _currentIndex = -1;
 546
 547   update_mirror();
 548   active->setBoolValue(false);
 549   _edited->fireValueChanged();
 550 }
 551
 552 /**
 553  * route between index-1 and index, using airways.
 554  */
 555 bool FGRouteMgr::routeToIndex(int index, RouteType aRouteType)
 556 {
 557   WayptRef wp1;
 558   WayptRef wp2;
 559
 560   if (index == -1) {
 561     index = _route.size(); // can still be zero, of course
 562   }
 563
 564   if (index == 0) {
 565     if (!_departure) {
 566       SG_LOG(SG_AUTOPILOT, SG_WARN, "routeToIndex: no departure set");
 567       return false;
 568     }
 569
 570     wp1 = new NavaidWaypoint(_departure.get(), NULL);
 571   } else {
 572     wp1 = wayptAtIndex(index - 1);
 573   }
 574
 575   if (index >= numWaypts()) {
 576     if (!_destination) {
 577       SG_LOG(SG_AUTOPILOT, SG_WARN, "routeToIndex: no destination set");
 578       return false;
 579     }
 580
 581     wp2 = new NavaidWaypoint(_destination.get(), NULL);
 582   } else {
 583     wp2 = wayptAtIndex(index);
 584   }
 585
 586   double distNm = SGGeodesy::distanceNm(wp1->position(), wp2->position());
 587   if (distNm < 100.0) {
 588     SG_LOG(SG_AUTOPILOT, SG_INFO, "routeToIndex: existing waypoints are nearby, direct route");
 589     return true;
 590   }
 591
 592   WayptVec r;
 593   switch (aRouteType) {
 594   case ROUTE_HIGH_AIRWAYS:
 595     Airway::highLevel()->route(wp1, wp2, r);
 596     break;
 597
 598   case ROUTE_LOW_AIRWAYS:
 599     Airway::lowLevel()->route(wp1, wp2, r);
 600     break;
 601
 602   case ROUTE_VOR:
 603     throw sg_exception("VOR routing not supported yet");
 604   }
 605
 606   if (r.empty()) {
 607     SG_LOG(SG_AUTOPILOT, SG_INFO, "routeToIndex: no route found");
 608     return false;
 609   }
 610
 611   WayptVec::iterator it = _route.begin();
 612   it += index;
 613   _route.insert(it, r.begin(), r.end());
 614
 615   update_mirror();
 616   _edited->fireValueChanged();
 617   return true;
 618 }
 619
 620 void FGRouteMgr::autoRoute()
 621 {
 622   if (!_departure || !_destination) {
 623     return;
 624   }
 625
 626   string runwayId(departure->getStringValue("runway"));
 627   FGRunway* runway = NULL;
 628   if (_departure->hasRunwayWithIdent(runwayId)) {
 629     runway = _departure->getRunwayByIdent(runwayId);
 630   }
 631
 632   FGRunway* dstRunway = NULL;
 633   runwayId = destination->getStringValue("runway");
 634   if (_destination->hasRunwayWithIdent(runwayId)) {
 635     dstRunway = _destination->getRunwayByIdent(runwayId);
 636   }
 637
 638   _route.clear(); // clear out the existing, first
 639 // SID
 640   flightgear::SID* sid;
 641   WayptRef sidTrans;
 642
 643   boost::tie(sid, sidTrans) = _departure->selectSID(_destination->geod(), runway);
 644   if (sid) {
 645     SG_LOG(SG_AUTOPILOT, SG_INFO, "selected SID " << sid->ident());
 646     if (sidTrans) {
 647       SG_LOG(SG_AUTOPILOT, SG_INFO, "\tvia " << sidTrans->ident() << " transition");
 648     }
 649
 650     sid->route(runway, sidTrans, _route);
 651     departure->setStringValue("sid", sid->ident());
 652   } else {
 653     // use airport location for airway search
 654     sidTrans = new NavaidWaypoint(_departure.get(), NULL);
 655     departure->setStringValue("sid", "");
 656   }
 657
 658 // STAR
 659   destination->setStringValue("transition", "");
 660   destination->setStringValue("star", "");
 661
 662   STAR* star;
 663   WayptRef starTrans;
 664   boost::tie(star, starTrans) = _destination->selectSTAR(_departure->geod(), dstRunway);
 665   if (star) {
 666     SG_LOG(SG_AUTOPILOT, SG_INFO, "selected STAR " << star->ident());
 667     if (starTrans) {
 668       SG_LOG(SG_AUTOPILOT, SG_INFO, "\tvia " << starTrans->ident() << " transition");
 669       destination->setStringValue("transition", starTrans->ident());
 670     }
 671     destination->setStringValue("star", star->ident());
 672   } else {
 673     // use airport location for search
 674     starTrans = new NavaidWaypoint(_destination.get(), NULL);
 675   }
 676
 677 // route between them
 678   WayptVec airwayRoute;
 679   if (Airway::highLevel()->route(sidTrans, starTrans, airwayRoute)) {
 680     _route.insert(_route.end(), airwayRoute.begin(), airwayRoute.end());
 681   }
 682
 683 // add the STAR if we have one
 684   if (star) {
 685     _destination->buildApproach(starTrans, star, dstRunway, _route);
 686   }
 687
 688   update_mirror();
 689   _edited->fireValueChanged();
 690 }
 691
 692 void FGRouteMgr::departureChanged()
 693 {
 694 // remove existing departure waypoints
 695   WayptVec::iterator it = _route.begin();
 696   for (; it != _route.end(); ++it) {
 697     if (!(*it)->flag(WPT_DEPARTURE)) {
 698       break;
 699     }
 700   }
 701
 702   // erase() invalidates iterators, so grab now
 703   WayptRef enroute;
 704   if (it == _route.end()) {
 705     if (_destination) {
 706       enroute = new NavaidWaypoint(_destination.get(), NULL);
 707     }
 708   } else {
 709     enroute = *it;
 710   }
 711
 712   _route.erase(_route.begin(), it);
 713   if (!_departure) {
 714     waypointsChanged();
 715     return;
 716   }
 717
 718   WayptVec wps;
 719   buildDeparture(enroute, wps);
 720   for (it = wps.begin(); it != wps.end(); ++it) {
 721     (*it)->setFlag(WPT_DEPARTURE);
 722     (*it)->setFlag(WPT_GENERATED);
 723   }
 724   _route.insert(_route.begin(), wps.begin(), wps.end());
 725
 726   update_mirror();
 727   waypointsChanged();
 728 }
 729
 730 void FGRouteMgr::buildDeparture(WayptRef enroute, WayptVec& wps)
 731 {
 732   string runwayId(departure->getStringValue("runway"));
 733   if (!_departure->hasRunwayWithIdent(runwayId)) {
 734 // valid airport, but no runway selected, so just the airport noide itself
 735     wps.push_back(new NavaidWaypoint(_departure.get(), NULL));
 736     return;
 737   }
 738
 739   FGRunway* r = _departure->getRunwayByIdent(runwayId);
 740   string sidId = departure->getStringValue("sid");
 741   flightgear::SID* sid = _departure->findSIDWithIdent(sidId);
 742   if (!sid) {
 743 // valid runway, but no SID selected/found, so just the runway node for now
 744     if (!sidId.empty() && (sidId != "(none)")) {
 745       SG_LOG(SG_AUTOPILOT, SG_INFO, "SID not found:" << sidId);
 746     }
 747
 748     wps.push_back(new RunwayWaypt(r, NULL));
 749     return;
 750   }
 751
 752 // we have a valid SID, awesome
 753   string trans(departure->getStringValue("transition"));
 754   WayptRef t = sid->findTransitionByName(trans);
 755   if (!t && enroute) {
 756     t = sid->findBestTransition(enroute->position());
 757   }
 758
 759   sid->route(r, t, wps);
 760   if (!wps.empty() && wps.front()->flag(WPT_DYNAMIC)) {
 761     // ensure first waypoint is static, to simplify other computations
 762     wps.insert(wps.begin(), new RunwayWaypt(r, NULL));
 763   }
 764 }
 765
 766 void FGRouteMgr::arrivalChanged()
 767 {
 768   // remove existing arrival waypoints
 769   WayptVec::reverse_iterator rit = _route.rbegin();
 770   for (; rit != _route.rend(); ++rit) {
 771     if (!(*rit)->flag(WPT_ARRIVAL)) {
 772       break;
 773     }
 774   }
 775
 776   // erase() invalidates iterators, so grab now
 777   WayptRef enroute;
 778   WayptVec::iterator it;
 779
 780   if (rit != _route.rend()) {
 781     enroute = *rit;
 782     it = rit.base(); // convert to fwd iterator
 783   } else {
 784     it = _route.begin();
 785   }
 786
 787   _route.erase(it, _route.end());
 788
 789   WayptVec wps;
 790   buildArrival(enroute, wps);
 791   for (it = wps.begin(); it != wps.end(); ++it) {
 792     (*it)->setFlag(WPT_ARRIVAL);
 793     (*it)->setFlag(WPT_GENERATED);
 794   }
 795   _route.insert(_route.end(), wps.begin(), wps.end());
 796
 797   update_mirror();
 798   waypointsChanged();
 799 }
 800
 801 void FGRouteMgr::buildArrival(WayptRef enroute, WayptVec& wps)
 802 {
 803   if (!_destination) {
 804     return;
 805   }
 806
 807   string runwayId(destination->getStringValue("runway"));
 808   if (!_destination->hasRunwayWithIdent(runwayId)) {
 809 // valid airport, but no runway selected, so just the airport node itself
 810     wps.push_back(new NavaidWaypoint(_destination.get(), NULL));
 811     return;
 812   }
 813
 814   FGRunway* r = _destination->getRunwayByIdent(runwayId);
 815   string starId = destination->getStringValue("star");
 816   STAR* star = _destination->findSTARWithIdent(starId);
 817   if (!star) {
 818 // valid runway, but no STAR selected/found, so just the runway node for now
 819     wps.push_back(new RunwayWaypt(r, NULL));
 820     return;
 821   }
 822
 823 // we have a valid STAR
 824   string trans(destination->getStringValue("transition"));
 825   WayptRef t = star->findTransitionByName(trans);
 826   if (!t && enroute) {
 827     t = star->findBestTransition(enroute->position());
 828   }
 829
 830   _destination->buildApproach(t, star, r, wps);
 831 }
 832
 833 void FGRouteMgr::waypointsChanged()
 834 {
 835
 836 }
 837
 838 void FGRouteMgr::insertWayptAtIndex(Waypt* aWpt, int aIndex)
 839 {
 840   if (!aWpt) {
 841     return;
 842   }
 843
 844   int index = aIndex;
 845   if ((aIndex == -1) || (aIndex > (int) _route.size())) {
 846     index = _route.size();
 847   }
 848
 849   WayptVec::iterator it = _route.begin();
 850   it += index;
 851
 852   if (_currentIndex >= index) {
 853     ++_currentIndex;
 854   }
 855
 856   _route.insert(it, aWpt);
 857
 858   update_mirror();
 859   _edited->fireValueChanged();
 860 }
 861
 862 WayptRef FGRouteMgr::waypointFromString(const string& tgt )
 863 {
 864   string target(boost::to_upper_copy(tgt));
 865   WayptRef wpt;
 866
 867 // extract altitude
 868   double altFt = cruise->getDoubleValue("altitude-ft");
 869   RouteRestriction altSetting = RESTRICT_NONE;
 870
 871   size_t pos = target.find( '@' );
 872   if ( pos != string::npos ) {
 873     altFt = atof( target.c_str() + pos + 1 );
 874     target = target.substr( 0, pos );
 875     if ( !strcmp(fgGetString("/sim/startup/units"), "meter") )
 876       altFt *= SG_METER_TO_FEET;
 877     altSetting = RESTRICT_AT;
 878   }
 879
 880 // check for lon,lat
 881   pos = target.find( ',' );
 882   if ( pos != string::npos ) {
 883     double lon = atof( target.substr(0, pos).c_str());
 884     double lat = atof( target.c_str() + pos + 1);
 885     char buf[32];
 886     char ew = (lon < 0.0) ? 'W' : 'E';
 887     char ns = (lat < 0.0) ? 'S' : 'N';
 888     snprintf(buf, 32, "%c%03d%c%03d", ew, (int) fabs(lon), ns, (int)fabs(lat));
 889
 890     wpt = new BasicWaypt(SGGeod::fromDeg(lon, lat), buf, NULL);
 891     if (altSetting != RESTRICT_NONE) {
 892       wpt->setAltitude(altFt, altSetting);
 893     }
 894     return wpt;
 895   }
 896
 897   SGGeod basePosition;
 898   if (_route.empty()) {
 899     // route is empty, use current position
 900     basePosition = SGGeod::fromDeg(lon->getDoubleValue(), lat->getDoubleValue());
 901   } else {
 902     basePosition = _route.back()->position();
 903   }
 904
 905   string_list pieces(simgear::strutils::split(target, "/"));
 906   FGPositionedRef p = FGPositioned::findClosestWithIdent(pieces.front(), basePosition);
 907   if (!p) {
 908     SG_LOG( SG_AUTOPILOT, SG_INFO, "Unable to find FGPositioned with ident:" << pieces.front());
 909     return NULL;
 910   }
 911
 912   if (pieces.size() == 1) {
 913     wpt = new NavaidWaypoint(p, NULL);
 914   } else if (pieces.size() == 3) {
 915     // navaid/radial/distance-nm notation
 916     double radial = atof(pieces[1].c_str()),
 917       distanceNm = atof(pieces[2].c_str());
 918     radial += magvar->getDoubleValue(); // convert to true bearing
 919     wpt = new OffsetNavaidWaypoint(p, NULL, radial, distanceNm);
 920   } else if (pieces.size() == 2) {
 921     FGAirport* apt = dynamic_cast<FGAirport*>(p.ptr());
 922     if (!apt) {
 923       SG_LOG(SG_AUTOPILOT, SG_INFO, "Waypoint is not an airport:" << pieces.front());
 924       return NULL;
 925     }
 926
 927     if (!apt->hasRunwayWithIdent(pieces[1])) {
 928       SG_LOG(SG_AUTOPILOT, SG_INFO, "No runway: " << pieces[1] << " at " << pieces[0]);
 929       return NULL;
 930     }
 931
 932     FGRunway* runway = apt->getRunwayByIdent(pieces[1]);
 933     wpt = new NavaidWaypoint(runway, NULL);
 934   } else if (pieces.size() == 4) {
 935     // navid/radial/navid/radial notation
 936     FGPositionedRef p2 = FGPositioned::findClosestWithIdent(pieces[2], basePosition);
 937     if (!p2) {
 938       SG_LOG( SG_AUTOPILOT, SG_INFO, "Unable to find FGPositioned with ident:" << pieces[2]);
 939       return NULL;
 940     }
 941
 942     double r1 = atof(pieces[1].c_str()),
 943       r2 = atof(pieces[3].c_str());
 944     r1 += magvar->getDoubleValue();
 945     r2 += magvar->getDoubleValue();
 946
 947     SGGeod intersection;
 948     bool ok = SGGeodesy::radialIntersection(p->geod(), r1, p2->geod(), r2, intersection);
 949     if (!ok) {
 950       SG_LOG(SG_AUTOPILOT, SG_INFO, "no valid intersection for:" << target);
 951       return NULL;
 952     }
 953
 954     std::string name = p->ident() + "-" + p2->ident();
 955     wpt = new BasicWaypt(intersection, name, NULL);
 956   }
 957
 958   if (!wpt) {
 959     SG_LOG(SG_AUTOPILOT, SG_INFO, "Unable to parse waypoint:" << target);
 960     return NULL;
 961   }
 962
 963   if (altSetting != RESTRICT_NONE) {
 964     wpt->setAltitude(altFt, altSetting);
 965   }
 966   return wpt;
 967 }
 968
 969 // mirror internal route to the property system for inspection by other subsystems
 970 void FGRouteMgr::update_mirror()
 971 {
 972   mirror->removeChildren("wp");
 973
 974   int num = numWaypts();
 975   for (int i = 0; i < num; i++) {
 976     Waypt* wp = _route[i];
 977     SGPropertyNode *prop = mirror->getChild("wp", i, 1);
 978
 979     const SGGeod& pos(wp->position());
 980     prop->setStringValue("id", wp->ident().c_str());
 981     //prop->setStringValue("name", wp.get_name().c_str());
 982     prop->setDoubleValue("longitude-deg", pos.getLongitudeDeg());
 983     prop->setDoubleValue("latitude-deg",pos.getLatitudeDeg());
 984
 985     // leg course+distance
 986     if (i < (num - 1)) {
 987       Waypt* next = _route[i+1];
 988       std::pair<double, double> crsDist =
 989         next->courseAndDistanceFrom(pos);
 990       prop->setDoubleValue("leg-bearing-true-deg", crsDist.first);
 991       prop->setDoubleValue("leg-distance-nm", crsDist.second * SG_METER_TO_NM);
 992     }
 993
 994     if (wp->altitudeRestriction() != RESTRICT_NONE) {
 995       double ft = wp->altitudeFt();
 996       prop->setDoubleValue("altitude-m", ft * SG_FEET_TO_METER);
 997       prop->setDoubleValue("altitude-ft", ft);
 998     } else {
 999       prop->setDoubleValue("altitude-m", -9999.9);
1000       prop->setDoubleValue("altitude-ft", -9999.9);
1001     }
1002
1003     if (wp->speedRestriction() == SPEED_RESTRICT_MACH) {
1004       prop->setDoubleValue("speed-mach", wp->speedMach());
1005     } else if (wp->speedRestriction() != RESTRICT_NONE) {
1006       prop->setDoubleValue("speed-kts", wp->speedKts());
1007     }
1008
1009     if (wp->flag(WPT_ARRIVAL)) {
1010       prop->setBoolValue("arrival", true);
1011     }
1012
1013     if (wp->flag(WPT_DEPARTURE)) {
1014       prop->setBoolValue("departure", true);
1015     }
1016
1017     if (wp->flag(WPT_MISS)) {
1018       prop->setBoolValue("missed-approach", true);
1019     }
1020
1021     prop->setBoolValue("generated", wp->flag(WPT_GENERATED));
1022   } // of waypoint iteration
1023
1024   // set number as listener attachment point
1025   mirror->setIntValue("num", _route.size());
1026
1027   NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1028   FGDialog* rmDlg = gui->getDialog("route-manager");
1029   if (rmDlg) {
1030     rmDlg->updateValues();
1031   }
1032 }
1033
1034 // command interface /autopilot/route-manager/input:
1035 //
1036 //   @CLEAR             ... clear route
1037 //   @POP               ... remove first entry
1038 //   @DELETE3           ... delete 4th entry
1039 //   @INSERT2:KSFO@900  ... insert "KSFO@900" as 3rd entry
1040 //   KSFO@900           ... append "KSFO@900"
1041 //
1042 void FGRouteMgr::InputListener::valueChanged(SGPropertyNode *prop)
1043 {
1044     const char *s = prop->getStringValue();
1045     if (strlen(s) == 0) {
1046       return;
1047     }
1048
1049     if (!strcmp(s, "@CLEAR"))
1050         mgr->clearRoute();
1051     else if (!strcmp(s, "@ACTIVATE"))
1052         mgr->activate();
1053     else if (!strcmp(s, "@LOAD")) {
1054       SGPath path(mgr->_pathNode->getStringValue());
1055       mgr->loadRoute(path);
1056     } else if (!strcmp(s, "@SAVE")) {
1057       SGPath path(mgr->_pathNode->getStringValue());
1058       mgr->saveRoute(path);
1059     } else if (!strcmp(s, "@NEXT")) {
1060       mgr->jumpToIndex(mgr->_currentIndex + 1);
1061     } else if (!strcmp(s, "@PREVIOUS")) {
1062       mgr->jumpToIndex(mgr->_currentIndex - 1);
1063     } else if (!strncmp(s, "@JUMP", 5)) {
1064       mgr->jumpToIndex(atoi(s + 5));
1065     } else if (!strncmp(s, "@DELETE", 7))
1066         mgr->removeWayptAtIndex(atoi(s + 7));
1067     else if (!strncmp(s, "@INSERT", 7)) {
1068         char *r;
1069         int pos = strtol(s + 7, &r, 10);
1070         if (*r++ != ':')
1071             return;
1072         while (isspace(*r))
1073             r++;
1074         if (*r)
1075             mgr->insertWayptAtIndex(mgr->waypointFromString(r), pos);
1076     } else if (!strncmp(s, "@ROUTE", 6)) {
1077       char* r;
1078       int endIndex = strtol(s + 6, &r, 10);
1079       RouteType rt = (RouteType) mgr->_routingType->getIntValue();
1080       mgr->routeToIndex(endIndex, rt);
1081     } else if (!strcmp(s, "@AUTOROUTE")) {
1082       mgr->autoRoute();
1083     } else if (!strcmp(s, "@POSINIT")) {
1084       mgr->initAtPosition();
1085     } else
1086       mgr->insertWayptAtIndex(mgr->waypointFromString(s), -1);
1087 }
1088
1089 void FGRouteMgr::initAtPosition()
1090 {
1091   if (isRouteActive()) {
1092     return; // don't mess with the active route
1093   }
1094
1095   if (haveUserWaypoints()) {
1096     // user has already defined, loaded or entered a route, again
1097     // don't interfere with it
1098     return;
1099   }
1100
1101   if (airborne->getBoolValue()) {
1102     SG_LOG(SG_AUTOPILOT, SG_INFO, "initAtPosition: airborne, clearing departure info");
1103     _departure = NULL;
1104     departure->setStringValue("runway", "");
1105     return;
1106   }
1107
1108 // on the ground
1109   SGGeod pos = SGGeod::fromDegFt(lon->getDoubleValue(),
1110     lat->getDoubleValue(), alt->getDoubleValue());
1111   if (!_departure) {
1112     _departure = FGAirport::findClosest(pos, 20.0);
1113     if (!_departure) {
1114       SG_LOG(SG_AUTOPILOT, SG_INFO, "initAtPosition: couldn't find an airport within 20nm");
1115       departure->setStringValue("runway", "");
1116       return;
1117     }
1118   }
1119
1120   std::string rwy = departure->getStringValue("runway");
1121   if (!rwy.empty()) {
1122     // runway already set, fine
1123     return;
1124   }
1125
1126   FGRunway* r = _departure->findBestRunwayForPos(pos);
1127   if (!r) {
1128     return;
1129   }
1130
1131   departure->setStringValue("runway", r->ident().c_str());
1132   SG_LOG(SG_AUTOPILOT, SG_INFO, "initAtPosition: starting at "
1133     << _departure->ident() << " on runway " << r->ident());
1134 }
1135
1136 bool FGRouteMgr::haveUserWaypoints() const
1137 {
1138   for (int i = 0; i < numWaypts(); i++) {
1139     if (!_route[i]->flag(WPT_GENERATED)) {
1140       // have a non-generated waypoint, we're done
1141       return true;
1142     }
1143   }
1144
1145   // all waypoints are generated
1146   return false;
1147 }
1148
1149 bool FGRouteMgr::activate()
1150 {
1151   if (isRouteActive()) {
1152     SG_LOG(SG_AUTOPILOT, SG_WARN, "duplicate route-activation, no-op");
1153     return false;
1154   }
1155
1156   _currentIndex = 0;
1157   currentWaypointChanged();
1158
1159  /* double routeDistanceNm = _route->total_distance() * SG_METER_TO_NM;
1160   totalDistance->setDoubleValue(routeDistanceNm);
1161   double cruiseSpeedKts = cruise->getDoubleValue("speed", 0.0);
1162   if (cruiseSpeedKts > 1.0) {
1163     // very very crude approximation, doesn't allow for climb / descent
1164     // performance or anything else at all
1165     ete->setDoubleValue(routeDistanceNm / cruiseSpeedKts * (60.0 * 60.0));
1166   }
1167   */
1168   active->setBoolValue(true);
1169   SG_LOG(SG_AUTOPILOT, SG_INFO, "route-manager, activate route ok");
1170   return true;
1171 }
1172
1173
1174 void FGRouteMgr::sequence()
1175 {
1176   if (!active->getBoolValue()) {
1177     SG_LOG(SG_AUTOPILOT, SG_ALERT, "trying to sequence waypoints with no active route");
1178     return;
1179   }
1180
1181   if (checkFinished()) {
1182     return;
1183   }
1184
1185   _currentIndex++;
1186   currentWaypointChanged();
1187 }
1188
1189 bool FGRouteMgr::checkFinished()
1190 {
1191   if (_currentIndex < (int) _route.size()) {
1192     return false;
1193   }
1194
1195   SG_LOG(SG_AUTOPILOT, SG_INFO, "reached end of active route");
1196   _finished->fireValueChanged();
1197   active->setBoolValue(false);
1198   return true;
1199 }
1200
1201 void FGRouteMgr::jumpToIndex(int index)
1202 {
1203   if ((index < 0) || (index >= (int) _route.size())) {
1204     SG_LOG(SG_AUTOPILOT, SG_ALERT, "passed invalid index (" <<
1205       index << ") to FGRouteMgr::jumpToIndex");
1206     return;
1207   }
1208
1209   if (_currentIndex == index) {
1210     return; // no-op
1211   }
1212
1213 // all the checks out the way, go ahead and update state
1214   _currentIndex = index;
1215   currentWaypointChanged();
1216   _currentWpt->fireValueChanged();
1217 }
1218
1219 void FGRouteMgr::currentWaypointChanged()
1220 {
1221   Waypt* cur = currentWaypt();
1222   Waypt* next = nextWaypt();
1223
1224   wp0->getChild("id")->setStringValue(cur ? cur->ident() : "");
1225   wp1->getChild("id")->setStringValue(next ? next->ident() : "");
1226
1227   _currentWpt->fireValueChanged();
1228   SG_LOG(SG_AUTOPILOT, SG_INFO, "route manager, current-wp is now " << _currentIndex);
1229 }
1230
1231 int FGRouteMgr::findWayptIndex(const SGGeod& aPos) const
1232 {
1233   for (int i=0; i<numWaypts(); ++i) {
1234     if (_route[i]->matches(aPos)) {
1235       return i;
1236     }
1237   }
1238
1239   return -1;
1240 }
1241
1242 Waypt* FGRouteMgr::currentWaypt() const
1243 {
1244   if ((_currentIndex < 0) || (_currentIndex >= numWaypts()))
1245       return NULL;
1246   return wayptAtIndex(_currentIndex);
1247 }
1248
1249 Waypt* FGRouteMgr::previousWaypt() const
1250 {
1251   if (_currentIndex == 0) {
1252     return NULL;
1253   }
1254
1255   return wayptAtIndex(_currentIndex - 1);
1256 }
1257
1258 Waypt* FGRouteMgr::nextWaypt() const
1259 {
1260   if ((_currentIndex < 0) || ((_currentIndex + 1) >= numWaypts())) {
1261     return NULL;
1262   }
1263
1264   return wayptAtIndex(_currentIndex + 1);
1265 }
1266
1267 Waypt* FGRouteMgr::wayptAtIndex(int index) const
1268 {
1269   if ((index < 0) || (index >= numWaypts())) {
1270     throw sg_range_exception("waypt index out of range", "FGRouteMgr::wayptAtIndex");
1271   }
1272
1273   return _route[index];
1274 }
1275
1276 bool FGRouteMgr::saveRoute(const SGPath& path)
1277 {
1278   SG_LOG(SG_IO, SG_INFO, "Saving route to " << path.str());
1279   try {
1280     SGPropertyNode_ptr d(new SGPropertyNode);
1281     SGPath path(_pathNode->getStringValue());
1282     d->setIntValue("version", 2);
1283
1284     if (_departure) {
1285       d->setStringValue("departure/airport", _departure->ident());
1286       d->setStringValue("departure/sid", departure->getStringValue("sid"));
1287       d->setStringValue("departure/runway", departure->getStringValue("runway"));
1288     }
1289
1290     if (_destination) {
1291       d->setStringValue("destination/airport", _destination->ident());
1292       d->setStringValue("destination/star", destination->getStringValue("star"));
1293       d->setStringValue("destination/transition", destination->getStringValue("transition"));
1294       d->setStringValue("destination/runway", destination->getStringValue("runway"));
1295     }
1296
1297   // route nodes
1298     SGPropertyNode* routeNode = d->getChild("route", 0, true);
1299     for (unsigned int i=0; i<_route.size(); ++i) {
1300       Waypt* wpt = _route[i];
1301       wpt->saveAsNode(routeNode->getChild("wp", i, true));
1302     } // of waypoint iteration
1303     writeProperties(path.str(), d, true /* write-all */);
1304     return true;
1305   } catch (sg_exception& e) {
1306     SG_LOG(SG_IO, SG_ALERT, "Failed to save flight-plan '" << path.str() << "'. " << e.getMessage());
1307     return false;
1308   }
1309 }
1310
1311 bool FGRouteMgr::loadRoute(const SGPath& path)
1312 {
1313   if (!path.exists())
1314   {
1315       SG_LOG(SG_IO, SG_ALERT, "Failed to load flight-plan '" << path.str()
1316               << "'. The file does not exist.");
1317       return false;
1318   }
1319
1320   // deactivate route first
1321   active->setBoolValue(false);
1322
1323   SGPropertyNode_ptr routeData(new SGPropertyNode);
1324
1325   SG_LOG(SG_IO, SG_INFO, "going to read flight-plan from:" << path.str());
1326
1327   try {
1328     readProperties(path.str(), routeData);
1329   } catch (sg_exception& ) {
1330     // if XML parsing fails, the file might be simple textual list of waypoints
1331     return loadPlainTextRoute(path);
1332   }
1333
1334   try {
1335     int version = routeData->getIntValue("version", 1);
1336     if (version == 1) {
1337       loadVersion1XMLRoute(routeData);
1338     } else if (version == 2) {
1339       loadVersion2XMLRoute(routeData);
1340     } else {
1341       throw sg_io_exception("unsupported XML route version");
1342     }
1343     return true;
1344   } catch (sg_exception& e) {
1345     SG_LOG(SG_IO, SG_ALERT, "Failed to load flight-plan '" << e.getOrigin()
1346       << "'. " << e.getMessage());
1347     return false;
1348   }
1349 }
1350
1351 void FGRouteMgr::loadXMLRouteHeader(SGPropertyNode_ptr routeData)
1352 {
1353   // departure nodes
1354   SGPropertyNode* dep = routeData->getChild("departure");
1355   if (dep) {
1356     string depIdent = dep->getStringValue("airport");
1357     _departure = (FGAirport*) fgFindAirportID(depIdent);
1358     departure->setStringValue("runway", dep->getStringValue("runway"));
1359     departure->setStringValue("sid", dep->getStringValue("sid"));
1360     departure->setStringValue("transition", dep->getStringValue("transition"));
1361   }
1362
1363 // destination
1364   SGPropertyNode* dst = routeData->getChild("destination");
1365   if (dst) {
1366     _destination = (FGAirport*) fgFindAirportID(dst->getStringValue("airport"));
1367     destination->setStringValue("runway", dst->getStringValue("runway"));
1368     destination->setStringValue("star", dst->getStringValue("star"));
1369     destination->setStringValue("transition", dst->getStringValue("transition"));
1370   }
1371
1372 // alternate
1373   SGPropertyNode* alt = routeData->getChild("alternate");
1374   if (alt) {
1375     alternate->setStringValue(alt->getStringValue("airport"));
1376   } // of cruise data loading
1377
1378 // cruise
1379   SGPropertyNode* crs = routeData->getChild("cruise");
1380   if (crs) {
1381     cruise->setDoubleValue("speed-kts", crs->getDoubleValue("speed-kts"));
1382     cruise->setDoubleValue("mach", crs->getDoubleValue("mach"));
1383     cruise->setDoubleValue("altitude-ft", crs->getDoubleValue("altitude-ft"));
1384   } // of cruise data loading
1385
1386 }
1387
1388 void FGRouteMgr::loadVersion2XMLRoute(SGPropertyNode_ptr routeData)
1389 {
1390   loadXMLRouteHeader(routeData);
1391
1392 // route nodes
1393   WayptVec wpts;
1394   SGPropertyNode_ptr routeNode = routeData->getChild("route", 0);
1395   for (int i=0; i<routeNode->nChildren(); ++i) {
1396     SGPropertyNode_ptr wpNode = routeNode->getChild("wp", i);
1397     WayptRef wpt = Waypt::createFromProperties(NULL, wpNode);
1398     wpts.push_back(wpt);
1399   } // of route iteration
1400
1401   _route = wpts;
1402 }
1403
1404 void FGRouteMgr::loadVersion1XMLRoute(SGPropertyNode_ptr routeData)
1405 {
1406   loadXMLRouteHeader(routeData);
1407
1408 // route nodes
1409   WayptVec wpts;
1410   SGPropertyNode_ptr routeNode = routeData->getChild("route", 0);
1411   for (int i=0; i<routeNode->nChildren(); ++i) {
1412     SGPropertyNode_ptr wpNode = routeNode->getChild("wp", i);
1413     WayptRef wpt = parseVersion1XMLWaypt(wpNode);
1414     wpts.push_back(wpt);
1415   } // of route iteration
1416
1417   _route = wpts;
1418 }
1419
1420 WayptRef FGRouteMgr::parseVersion1XMLWaypt(SGPropertyNode* aWP)
1421 {
1422   SGGeod lastPos;
1423   if (!_route.empty()) {
1424     lastPos = _route.back()->position();
1425   } else if (_departure) {
1426     lastPos = _departure->geod();
1427   }
1428
1429   WayptRef w;
1430   string ident(aWP->getStringValue("ident"));
1431   if (aWP->hasChild("longitude-deg")) {
1432     // explicit longitude/latitude
1433     w = new BasicWaypt(SGGeod::fromDeg(aWP->getDoubleValue("longitude-deg"),
1434       aWP->getDoubleValue("latitude-deg")), ident, NULL);
1435
1436   } else {
1437     string nid = aWP->getStringValue("navid", ident.c_str());
1438     FGPositionedRef p = FGPositioned::findClosestWithIdent(nid, lastPos);
1439     if (!p) {
1440       throw sg_io_exception("bad route file, unknown navid:" + nid);
1441     }
1442
1443     SGGeod pos(p->geod());
1444     if (aWP->hasChild("offset-nm") && aWP->hasChild("offset-radial")) {
1445       double radialDeg = aWP->getDoubleValue("offset-radial");
1446       // convert magnetic radial to a true radial!
1447       radialDeg += magvar->getDoubleValue();
1448       double offsetNm = aWP->getDoubleValue("offset-nm");
1449       double az2;
1450       SGGeodesy::direct(p->geod(), radialDeg, offsetNm * SG_NM_TO_METER, pos, az2);
1451     }
1452
1453     w = new BasicWaypt(pos, ident, NULL);
1454   }
1455
1456   double altFt = aWP->getDoubleValue("altitude-ft", -9999.9);
1457   if (altFt > -9990.0) {
1458     w->setAltitude(altFt, RESTRICT_AT);
1459   }
1460
1461   return w;
1462 }
1463
1464 bool FGRouteMgr::loadPlainTextRoute(const SGPath& path)
1465 {
1466   try {
1467     sg_gzifstream in(path.str().c_str());
1468     if (!in.is_open()) {
1469         throw sg_io_exception("Cannot open file for reading.");
1470     }
1471
1472     WayptVec wpts;
1473     while (!in.eof()) {
1474       string line;
1475       getline(in, line, '\n');
1476     // trim CR from end of line, if found
1477       if (line[line.size() - 1] == '\r') {
1478         line.erase(line.size() - 1, 1);
1479       }
1480
1481       line = simgear::strutils::strip(line);
1482       if (line.empty() || (line[0] == '#')) {
1483         continue; // ignore empty/comment lines
1484       }
1485
1486       WayptRef w = waypointFromString(line);
1487       if (!w) {
1488         throw sg_io_exception("Failed to create waypoint from line '" + line + "'.");
1489       }
1490
1491       wpts.push_back(w);
1492     } // of line iteration
1493
1494     _route = wpts;
1495     return true;
1496   } catch (sg_exception& e) {
1497     SG_LOG(SG_IO, SG_ALERT, "Failed to load route from: '" << path.str() << "'. " << e.getMessage());
1498     return false;
1499   }
1500 }
1501
1502 const char* FGRouteMgr::getDepartureICAO() const
1503 {
1504   if (!_departure) {
1505     return "";
1506   }
1507
1508   return _departure->ident().c_str();
1509 }
1510
1511 const char* FGRouteMgr::getDepartureName() const
1512 {
1513   if (!_departure) {
1514     return "";
1515   }
1516
1517   return _departure->name().c_str();
1518 }
1519
1520 void FGRouteMgr::setDepartureICAO(const char* aIdent)
1521 {
1522   if ((aIdent == NULL) || (strlen(aIdent) < 4)) {
1523     _departure = NULL;
1524   } else {
1525     _departure = FGAirport::findByIdent(aIdent);
1526   }
1527
1528   departureChanged();
1529 }
1530
1531 const char* FGRouteMgr::getDestinationICAO() const
1532 {
1533   if (!_destination) {
1534     return "";
1535   }
1536
1537   return _destination->ident().c_str();
1538 }
1539
1540 const char* FGRouteMgr::getDestinationName() const
1541 {
1542   if (!_destination) {
1543     return "";
1544   }
1545
1546   return _destination->name().c_str();
1547 }
1548
1549 void FGRouteMgr::setDestinationICAO(const char* aIdent)
1550 {
1551   if ((aIdent == NULL) || (strlen(aIdent) < 4)) {
1552     _destination = NULL;
1553   } else {
1554     _destination = FGAirport::findByIdent(aIdent);
1555   }
1556
1557   arrivalChanged();
1558 }