1 // route_mgr.cxx - manage a route (i.e. a collection of waypoints)
3 // Written by Curtis Olson, started January 2004.
7 // Copyright (C) 2004 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
34 #include <simgear/compiler.h>
36 #include "route_mgr.hxx"
38 #include <boost/algorithm/string/case_conv.hpp>
39 #include <boost/tuple/tuple.hpp>
41 #include <simgear/misc/strutils.hxx>
42 #include <simgear/structure/exception.hxx>
43 #include <simgear/structure/commands.hxx>
44 #include <simgear/misc/sgstream.hxx>
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>
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"
59 #define RM "/autopilot/route-manager/"
61 #include <GUI/new_gui.hxx>
62 #include <GUI/dialog.hxx>
64 using namespace flightgear;
66 class PropertyWatcher : public SGPropertyChangeListener
69 void watch(SGPropertyNode* p)
71 p->addChangeListener(this, false);
74 virtual void valueChanged(SGPropertyNode*)
79 virtual void fire() = 0;
83 * Template adapter, created by convenience helper below
86 class MethodPropertyWatcher : public PropertyWatcher
89 typedef void (T::*fire_method)();
91 MethodPropertyWatcher(T* obj, fire_method m) :
98 { // dispatch to the object method we're helping
99 (_object->*_method)();
108 PropertyWatcher* createWatcher(T* obj, void (T::*m)())
110 return new MethodPropertyWatcher<T>(obj, m);
113 static bool commandLoadFlightPlan(const SGPropertyNode* arg)
115 FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
116 SGPath path(arg->getStringValue("path"));
117 return self->loadRoute(path);
120 static bool commandSaveFlightPlan(const SGPropertyNode* arg)
122 FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
123 SGPath path(arg->getStringValue("path"));
124 return self->saveRoute(path);
127 static bool commandActivateFlightPlan(const SGPropertyNode* arg)
129 FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
130 bool activate = arg->getBoolValue("activate", true);
140 static bool commandClearFlightPlan(const SGPropertyNode*)
142 FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
147 static bool commandSetActiveWaypt(const SGPropertyNode* arg)
149 FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
150 int index = arg->getIntValue("index");
151 if ((index < 0) || (index >= self->numWaypts())) {
155 self->jumpToIndex(index);
159 static bool commandInsertWaypt(const SGPropertyNode* arg)
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);
168 // lat/lon may be supplied to narrow down navaid search, or to specify
171 if (arg->hasChild("longitude-deg")) {
172 pos = SGGeod::fromDeg(arg->getDoubleValue("longitude-deg"),
173 arg->getDoubleValue("latitude-deg"));
176 if (arg->hasChild("navaid")) {
177 FGPositionedRef p = FGPositioned::findClosestWithIdent(arg->getStringValue("navaid"), pos);
179 if (arg->hasChild("navaid", 1)) {
180 // intersection of two radials
181 FGPositionedRef p2 = FGPositioned::findClosestWithIdent(arg->getStringValue("navaid[1]"), pos);
183 SG_LOG( SG_AUTOPILOT, SG_INFO, "Unable to find FGPositioned with ident:" << arg->getStringValue("navaid[1]"));
187 double r1 = arg->getDoubleValue("radial"),
188 r2 = arg->getDoubleValue("radial[1]");
191 bool ok = SGGeodesy::radialIntersection(p->geod(), r1, p2->geod(), r2, intersection);
193 SG_LOG(SG_AUTOPILOT, SG_INFO, "no valid intersection for:" << p->ident()
194 << "," << p2->ident());
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);
207 wp = new NavaidWaypoint(p, NULL);
209 } else if (arg->hasChild("airport")) {
210 const FGAirport* apt = fgFindAirportID(arg->getStringValue("airport"));
212 SG_LOG(SG_AUTOPILOT, SG_INFO, "no such airport" << arg->getStringValue("airport"));
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());
222 FGRunway* runway = apt->getRunwayByIdent(arg->getStringValue("runway"));
223 wp = new RunwayWaypt(runway, NULL);
225 wp = new NavaidWaypoint((FGAirport*) apt, NULL);
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);
233 return false; // failed to build waypoint
237 wp->setAltitude(alt, flightgear::RESTRICT_AT);
241 wp->setSpeed(ias, flightgear::RESTRICT_AT);
244 self->insertWayptAtIndex(wp, index);
248 static bool commandDeleteWaypt(const SGPropertyNode* arg)
250 FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
251 int index = arg->getIntValue("index");
252 self->removeWayptAtIndex(index);
256 /////////////////////////////////////////////////////////////////////////////
258 FGRouteMgr::FGRouteMgr() :
260 input(fgGetNode( RM "input", true )),
261 mirror(fgGetNode( RM "route", true )),
262 _departureWatcher(NULL),
263 _arrivalWatcher(NULL)
265 listener = new InputListener(this);
266 input->setStringValue("");
267 input->addChangeListener(listener);
269 SGCommandMgr::instance()->addCommand("load-flightplan", commandLoadFlightPlan);
270 SGCommandMgr::instance()->addCommand("save-flightplan", commandSaveFlightPlan);
271 SGCommandMgr::instance()->addCommand("activate-flightplan", commandActivateFlightPlan);
272 SGCommandMgr::instance()->addCommand("clear-flightplan", commandClearFlightPlan);
273 SGCommandMgr::instance()->addCommand("set-active-waypt", commandSetActiveWaypt);
274 SGCommandMgr::instance()->addCommand("insert-waypt", commandInsertWaypt);
275 SGCommandMgr::instance()->addCommand("delete-waypt", commandDeleteWaypt);
279 FGRouteMgr::~FGRouteMgr()
281 input->removeChangeListener(listener);
283 delete _departureWatcher;
284 delete _arrivalWatcher;
288 void FGRouteMgr::init() {
289 SGPropertyNode_ptr rm(fgGetNode(RM));
291 lon = fgGetNode( "/position/longitude-deg", true );
292 lat = fgGetNode( "/position/latitude-deg", true );
293 alt = fgGetNode( "/position/altitude-ft", true );
294 magvar = fgGetNode("/environment/magnetic-variation-deg", true);
296 departure = fgGetNode(RM "departure", true);
297 departure->tie("airport", SGRawValueMethods<FGRouteMgr, const char*>(*this,
298 &FGRouteMgr::getDepartureICAO, &FGRouteMgr::setDepartureICAO));
299 departure->tie("name", SGRawValueMethods<FGRouteMgr, const char*>(*this,
300 &FGRouteMgr::getDepartureName, NULL));
301 departure->setStringValue("runway", "");
303 delete _departureWatcher;
304 _departureWatcher = createWatcher(this, &FGRouteMgr::departureChanged);
305 _departureWatcher->watch(departure->getChild("runway"));
307 departure->getChild("etd", 0, true);
308 _departureWatcher->watch(departure->getChild("sid", 0, true));
309 departure->getChild("takeoff-time", 0, true);
311 destination = fgGetNode(RM "destination", true);
312 destination->getChild("airport", 0, true);
314 destination->tie("airport", SGRawValueMethods<FGRouteMgr, const char*>(*this,
315 &FGRouteMgr::getDestinationICAO, &FGRouteMgr::setDestinationICAO));
316 destination->tie("name", SGRawValueMethods<FGRouteMgr, const char*>(*this,
317 &FGRouteMgr::getDestinationName, NULL));
319 delete _arrivalWatcher;
320 _arrivalWatcher = createWatcher(this, &FGRouteMgr::arrivalChanged);
321 _arrivalWatcher->watch(destination->getChild("runway", 0, true));
323 destination->getChild("eta", 0, true);
324 _arrivalWatcher->watch(destination->getChild("star", 0, true));
325 _arrivalWatcher->watch(destination->getChild("transition", 0, true));
326 destination->getChild("touchdown-time", 0, true);
328 alternate = fgGetNode(RM "alternate", true);
329 alternate->getChild("airport", 0, true);
330 alternate->getChild("runway", 0, true);
332 cruise = fgGetNode(RM "cruise", true);
333 cruise->getChild("altitude-ft", 0, true);
334 cruise->setDoubleValue("altitude-ft", 10000.0);
335 cruise->getChild("flight-level", 0, true);
336 cruise->getChild("speed-kts", 0, true);
337 cruise->setDoubleValue("speed-kts", 160.0);
339 _routingType = cruise->getChild("routing", 0, true);
340 _routingType->setIntValue(ROUTE_HIGH_AIRWAYS);
342 totalDistance = fgGetNode(RM "total-distance", true);
343 totalDistance->setDoubleValue(0.0);
345 ete = fgGetNode(RM "ete", true);
346 ete->setDoubleValue(0.0);
348 elapsedFlightTime = fgGetNode(RM "flight-time", true);
349 elapsedFlightTime->setDoubleValue(0.0);
351 active = fgGetNode(RM "active", true);
352 active->setBoolValue(false);
354 airborne = fgGetNode(RM "airborne", true);
355 airborne->setBoolValue(false);
357 _edited = fgGetNode(RM "signals/edited", true);
358 _finished = fgGetNode(RM "signals/finished", true);
360 _currentWpt = fgGetNode(RM "current-wp", true);
361 _currentWpt->tie(SGRawValueMethods<FGRouteMgr, int>
362 (*this, &FGRouteMgr::currentIndex, &FGRouteMgr::jumpToIndex));
364 // temporary distance / eta calculations, for backward-compatability
365 wp0 = fgGetNode(RM "wp", 0, true);
366 wp0->getChild("id", 0, true);
367 wp0->getChild("dist", 0, true);
368 wp0->getChild("eta", 0, true);
369 wp0->getChild("bearing-deg", 0, true);
371 wp1 = fgGetNode(RM "wp", 1, true);
372 wp1->getChild("id", 0, true);
373 wp1->getChild("dist", 0, true);
374 wp1->getChild("eta", 0, true);
376 wpn = fgGetNode(RM "wp-last", 0, true);
377 wpn->getChild("dist", 0, true);
378 wpn->getChild("eta", 0, true);
381 _pathNode = fgGetNode(RM "file-path", 0, true);
385 void FGRouteMgr::postinit()
387 SGPath path(_pathNode->getStringValue());
388 if (!path.isNull()) {
389 SG_LOG(SG_AUTOPILOT, SG_INFO, "loading flight-plan from: " << path.str());
393 // this code only matters for the --wp option now - perhaps the option
394 // should be deprecated in favour of an explicit flight-plan file?
395 // then the global initial waypoint list could die.
396 string_list *waypoints = globals->get_initial_waypoints();
398 string_list::iterator it;
399 for (it = waypoints->begin(); it != waypoints->end(); ++it) {
400 WayptRef w = waypointFromString(*it);
406 SG_LOG(SG_AUTOPILOT, SG_INFO, "loaded initial waypoints:" << _route.size());
410 weightOnWheels = fgGetNode("/gear/gear[0]/wow", true);
411 // check airbone flag agrees with presets
414 void FGRouteMgr::bind() { }
415 void FGRouteMgr::unbind() { }
417 bool FGRouteMgr::isRouteActive() const
419 return active->getBoolValue();
422 void FGRouteMgr::update( double dt )
425 return; // paused, nothing to do here
428 double groundSpeed = fgGetDouble("/velocities/groundspeed-kt", 0.0);
429 if (airborne->getBoolValue()) {
430 time_t now = time(NULL);
431 elapsedFlightTime->setDoubleValue(difftime(now, _takeoffTime));
432 } else { // not airborne
433 if (weightOnWheels->getBoolValue() || (groundSpeed < 40)) {
437 airborne->setBoolValue(true);
438 _takeoffTime = time(NULL); // start the clock
439 departure->setIntValue("takeoff-time", _takeoffTime);
442 if (!active->getBoolValue()) {
446 // basic course/distance information
447 SGGeod currentPos = SGGeod::fromDegFt(lon->getDoubleValue(),
448 lat->getDoubleValue(),alt->getDoubleValue());
450 Waypt* curWpt = currentWaypt();
457 boost::tie(courseDeg, distanceM) = curWpt->courseAndDistanceFrom(currentPos);
459 // update wp0 / wp1 / wp-last for legacy users
460 wp0->setDoubleValue("dist", distanceM * SG_METER_TO_NM);
461 courseDeg -= magvar->getDoubleValue(); // expose magnetic bearing
462 wp0->setDoubleValue("bearing-deg", courseDeg);
463 setETAPropertyFromDistance(wp0->getChild("eta"), distanceM);
465 double totalDistanceRemaining = distanceM; // distance to current waypoint
467 Waypt* nextWpt = nextWaypt();
469 boost::tie(courseDeg, distanceM) = nextWpt->courseAndDistanceFrom(currentPos);
471 wp1->setDoubleValue("dist", distanceM * SG_METER_TO_NM);
472 courseDeg -= magvar->getDoubleValue(); // expose magnetic bearing
473 wp1->setDoubleValue("bearing-deg", courseDeg);
474 setETAPropertyFromDistance(wp1->getChild("eta"), distanceM);
477 Waypt* prev = curWpt;
478 for (unsigned int i=_currentIndex + 1; i<_route.size(); ++i) {
479 Waypt* w = _route[i];
480 if (w->flag(WPT_DYNAMIC)) continue;
481 totalDistanceRemaining += SGGeodesy::distanceM(prev->position(), w->position());
487 wpn->setDoubleValue("dist", totalDistanceRemaining * SG_METER_TO_NM);
488 ete->setDoubleValue(totalDistanceRemaining * SG_METER_TO_NM / groundSpeed * 3600.0);
489 setETAPropertyFromDistance(wpn->getChild("eta"), totalDistanceRemaining);
492 void FGRouteMgr::setETAPropertyFromDistance(SGPropertyNode_ptr aProp, double aDistance)
494 double speed = fgGetDouble("/velocities/groundspeed-kt", 0.0);
496 aProp->setStringValue("--:--");
501 double eta = aDistance * SG_METER_TO_NM / speed;
502 if ( eta >= 100.0 ) {
503 eta = 99.999; // clamp
506 if ( eta < (1.0/6.0) ) {
507 eta *= 60.0; // within 10 minutes, bump up to min/secs
510 int major = (int)eta,
511 minor = (int)((eta - (int)eta) * 60.0);
512 snprintf( eta_str, 64, "%d:%02d", major, minor );
513 aProp->setStringValue( eta_str );
516 flightgear::WayptRef FGRouteMgr::removeWayptAtIndex(int aIndex)
519 if (aIndex < 0) { // negative indices count the the end
520 index = _route.size() + index;
523 if ((index < 0) || (index >= numWaypts())) {
524 SG_LOG(SG_AUTOPILOT, SG_WARN, "removeWayptAtIndex with invalid index:" << aIndex);
527 WayptVec::iterator it = _route.begin();
530 WayptRef w = *it; // hold a ref now, in case _route is the only other owner
535 if (_currentIndex == index) {
536 currentWaypointChanged(); // current waypoint was removed
539 if (_currentIndex > index) {
540 --_currentIndex; // shift current index down if necessary
543 _edited->fireValueChanged();
549 struct NotGeneratedWayptPredicate : public std::unary_function<const Waypt*, bool>
551 bool operator() (const Waypt* w) const
553 return (w->flag(WPT_GENERATED) == false);
558 void FGRouteMgr::clearRoute()
560 // erase all non-generated waypoints
561 WayptVec::iterator r =
562 std::remove_if(_route.begin(), _route.end(), NotGeneratedWayptPredicate());
563 _route.erase(r, _route.end());
568 active->setBoolValue(false);
569 _edited->fireValueChanged();
573 * route between index-1 and index, using airways.
575 bool FGRouteMgr::routeToIndex(int index, RouteType aRouteType)
581 index = _route.size(); // can still be zero, of course
586 SG_LOG(SG_AUTOPILOT, SG_WARN, "routeToIndex: no departure set");
590 wp1 = new NavaidWaypoint(_departure.get(), NULL);
592 wp1 = wayptAtIndex(index - 1);
595 if (index >= numWaypts()) {
597 SG_LOG(SG_AUTOPILOT, SG_WARN, "routeToIndex: no destination set");
601 wp2 = new NavaidWaypoint(_destination.get(), NULL);
603 wp2 = wayptAtIndex(index);
606 double distNm = SGGeodesy::distanceNm(wp1->position(), wp2->position());
607 if (distNm < 100.0) {
608 SG_LOG(SG_AUTOPILOT, SG_INFO, "routeToIndex: existing waypoints are nearby, direct route");
613 switch (aRouteType) {
614 case ROUTE_HIGH_AIRWAYS:
615 Airway::highLevel()->route(wp1, wp2, r);
618 case ROUTE_LOW_AIRWAYS:
619 Airway::lowLevel()->route(wp1, wp2, r);
623 throw sg_exception("VOR routing not supported yet");
627 SG_LOG(SG_AUTOPILOT, SG_INFO, "routeToIndex: no route found");
631 WayptVec::iterator it = _route.begin();
633 _route.insert(it, r.begin(), r.end());
636 _edited->fireValueChanged();
640 void FGRouteMgr::autoRoute()
642 if (!_departure || !_destination) {
646 string runwayId(departure->getStringValue("runway"));
647 FGRunway* runway = NULL;
648 if (_departure->hasRunwayWithIdent(runwayId)) {
649 runway = _departure->getRunwayByIdent(runwayId);
652 FGRunway* dstRunway = NULL;
653 runwayId = destination->getStringValue("runway");
654 if (_destination->hasRunwayWithIdent(runwayId)) {
655 dstRunway = _destination->getRunwayByIdent(runwayId);
658 _route.clear(); // clear out the existing, first
660 flightgear::SID* sid;
663 boost::tie(sid, sidTrans) = _departure->selectSID(_destination->geod(), runway);
665 SG_LOG(SG_AUTOPILOT, SG_INFO, "selected SID " << sid->ident());
667 SG_LOG(SG_AUTOPILOT, SG_INFO, "\tvia " << sidTrans->ident() << " transition");
670 sid->route(runway, sidTrans, _route);
671 departure->setStringValue("sid", sid->ident());
673 // use airport location for airway search
674 sidTrans = new NavaidWaypoint(_departure.get(), NULL);
675 departure->setStringValue("sid", "");
679 destination->setStringValue("transition", "");
680 destination->setStringValue("star", "");
684 boost::tie(star, starTrans) = _destination->selectSTAR(_departure->geod(), dstRunway);
686 SG_LOG(SG_AUTOPILOT, SG_INFO, "selected STAR " << star->ident());
688 SG_LOG(SG_AUTOPILOT, SG_INFO, "\tvia " << starTrans->ident() << " transition");
689 destination->setStringValue("transition", starTrans->ident());
691 destination->setStringValue("star", star->ident());
693 // use airport location for search
694 starTrans = new NavaidWaypoint(_destination.get(), NULL);
697 // route between them
698 WayptVec airwayRoute;
699 if (Airway::highLevel()->route(sidTrans, starTrans, airwayRoute)) {
700 _route.insert(_route.end(), airwayRoute.begin(), airwayRoute.end());
703 // add the STAR if we have one
705 _destination->buildApproach(starTrans, star, dstRunway, _route);
709 _edited->fireValueChanged();
712 void FGRouteMgr::departureChanged()
714 // remove existing departure waypoints
715 WayptVec::iterator it = _route.begin();
716 for (; it != _route.end(); ++it) {
717 if (!(*it)->flag(WPT_DEPARTURE)) {
722 // erase() invalidates iterators, so grab now
724 if (it == _route.end()) {
726 enroute = new NavaidWaypoint(_destination.get(), NULL);
732 _route.erase(_route.begin(), it);
739 buildDeparture(enroute, wps);
740 for (it = wps.begin(); it != wps.end(); ++it) {
741 (*it)->setFlag(WPT_DEPARTURE);
742 (*it)->setFlag(WPT_GENERATED);
744 _route.insert(_route.begin(), wps.begin(), wps.end());
750 void FGRouteMgr::buildDeparture(WayptRef enroute, WayptVec& wps)
752 string runwayId(departure->getStringValue("runway"));
753 if (!_departure->hasRunwayWithIdent(runwayId)) {
754 // valid airport, but no runway selected, so just the airport noide itself
755 wps.push_back(new NavaidWaypoint(_departure.get(), NULL));
759 FGRunway* r = _departure->getRunwayByIdent(runwayId);
760 string sidId = departure->getStringValue("sid");
761 flightgear::SID* sid = _departure->findSIDWithIdent(sidId);
763 // valid runway, but no SID selected/found, so just the runway node for now
764 if (!sidId.empty() && (sidId != "(none)")) {
765 SG_LOG(SG_AUTOPILOT, SG_INFO, "SID not found:" << sidId);
768 wps.push_back(new RunwayWaypt(r, NULL));
772 // we have a valid SID, awesome
773 string trans(departure->getStringValue("transition"));
774 WayptRef t = sid->findTransitionByName(trans);
776 t = sid->findBestTransition(enroute->position());
779 sid->route(r, t, wps);
780 if (!wps.empty() && wps.front()->flag(WPT_DYNAMIC)) {
781 // ensure first waypoint is static, to simplify other computations
782 wps.insert(wps.begin(), new RunwayWaypt(r, NULL));
786 void FGRouteMgr::arrivalChanged()
788 // remove existing arrival waypoints
789 WayptVec::reverse_iterator rit = _route.rbegin();
790 for (; rit != _route.rend(); ++rit) {
791 if (!(*rit)->flag(WPT_ARRIVAL)) {
796 // erase() invalidates iterators, so grab now
798 WayptVec::iterator it;
800 if (rit != _route.rend()) {
802 it = rit.base(); // convert to fwd iterator
807 _route.erase(it, _route.end());
810 buildArrival(enroute, wps);
811 for (it = wps.begin(); it != wps.end(); ++it) {
812 (*it)->setFlag(WPT_ARRIVAL);
813 (*it)->setFlag(WPT_GENERATED);
815 _route.insert(_route.end(), wps.begin(), wps.end());
821 void FGRouteMgr::buildArrival(WayptRef enroute, WayptVec& wps)
827 string runwayId(destination->getStringValue("runway"));
828 if (!_destination->hasRunwayWithIdent(runwayId)) {
829 // valid airport, but no runway selected, so just the airport node itself
830 wps.push_back(new NavaidWaypoint(_destination.get(), NULL));
834 FGRunway* r = _destination->getRunwayByIdent(runwayId);
835 string starId = destination->getStringValue("star");
836 STAR* star = _destination->findSTARWithIdent(starId);
838 // valid runway, but no STAR selected/found, so just the runway node for now
839 wps.push_back(new RunwayWaypt(r, NULL));
843 // we have a valid STAR
844 string trans(destination->getStringValue("transition"));
845 WayptRef t = star->findTransitionByName(trans);
847 t = star->findBestTransition(enroute->position());
850 _destination->buildApproach(t, star, r, wps);
853 void FGRouteMgr::waypointsChanged()
858 void FGRouteMgr::insertWayptAtIndex(Waypt* aWpt, int aIndex)
865 if ((aIndex == -1) || (aIndex > (int) _route.size())) {
866 index = _route.size();
869 WayptVec::iterator it = _route.begin();
872 if (_currentIndex >= index) {
876 _route.insert(it, aWpt);
879 _edited->fireValueChanged();
882 WayptRef FGRouteMgr::waypointFromString(const string& tgt )
884 string target(boost::to_upper_copy(tgt));
888 double altFt = cruise->getDoubleValue("altitude-ft");
889 RouteRestriction altSetting = RESTRICT_NONE;
891 size_t pos = target.find( '@' );
892 if ( pos != string::npos ) {
893 altFt = atof( target.c_str() + pos + 1 );
894 target = target.substr( 0, pos );
895 if ( !strcmp(fgGetString("/sim/startup/units"), "meter") )
896 altFt *= SG_METER_TO_FEET;
897 altSetting = RESTRICT_AT;
901 pos = target.find( ',' );
902 if ( pos != string::npos ) {
903 double lon = atof( target.substr(0, pos).c_str());
904 double lat = atof( target.c_str() + pos + 1);
906 char ew = (lon < 0.0) ? 'W' : 'E';
907 char ns = (lat < 0.0) ? 'S' : 'N';
908 snprintf(buf, 32, "%c%03d%c%03d", ew, (int) fabs(lon), ns, (int)fabs(lat));
910 wpt = new BasicWaypt(SGGeod::fromDeg(lon, lat), buf, NULL);
911 if (altSetting != RESTRICT_NONE) {
912 wpt->setAltitude(altFt, altSetting);
918 if (_route.empty()) {
919 // route is empty, use current position
920 basePosition = SGGeod::fromDeg(lon->getDoubleValue(), lat->getDoubleValue());
922 basePosition = _route.back()->position();
925 string_list pieces(simgear::strutils::split(target, "/"));
926 FGPositionedRef p = FGPositioned::findClosestWithIdent(pieces.front(), basePosition);
928 SG_LOG( SG_AUTOPILOT, SG_INFO, "Unable to find FGPositioned with ident:" << pieces.front());
932 if (pieces.size() == 1) {
933 wpt = new NavaidWaypoint(p, NULL);
934 } else if (pieces.size() == 3) {
935 // navaid/radial/distance-nm notation
936 double radial = atof(pieces[1].c_str()),
937 distanceNm = atof(pieces[2].c_str());
938 radial += magvar->getDoubleValue(); // convert to true bearing
939 wpt = new OffsetNavaidWaypoint(p, NULL, radial, distanceNm);
940 } else if (pieces.size() == 2) {
941 FGAirport* apt = dynamic_cast<FGAirport*>(p.ptr());
943 SG_LOG(SG_AUTOPILOT, SG_INFO, "Waypoint is not an airport:" << pieces.front());
947 if (!apt->hasRunwayWithIdent(pieces[1])) {
948 SG_LOG(SG_AUTOPILOT, SG_INFO, "No runway: " << pieces[1] << " at " << pieces[0]);
952 FGRunway* runway = apt->getRunwayByIdent(pieces[1]);
953 wpt = new NavaidWaypoint(runway, NULL);
954 } else if (pieces.size() == 4) {
955 // navid/radial/navid/radial notation
956 FGPositionedRef p2 = FGPositioned::findClosestWithIdent(pieces[2], basePosition);
958 SG_LOG( SG_AUTOPILOT, SG_INFO, "Unable to find FGPositioned with ident:" << pieces[2]);
962 double r1 = atof(pieces[1].c_str()),
963 r2 = atof(pieces[3].c_str());
964 r1 += magvar->getDoubleValue();
965 r2 += magvar->getDoubleValue();
968 bool ok = SGGeodesy::radialIntersection(p->geod(), r1, p2->geod(), r2, intersection);
970 SG_LOG(SG_AUTOPILOT, SG_INFO, "no valid intersection for:" << target);
974 std::string name = p->ident() + "-" + p2->ident();
975 wpt = new BasicWaypt(intersection, name, NULL);
979 SG_LOG(SG_AUTOPILOT, SG_INFO, "Unable to parse waypoint:" << target);
983 if (altSetting != RESTRICT_NONE) {
984 wpt->setAltitude(altFt, altSetting);
989 // mirror internal route to the property system for inspection by other subsystems
990 void FGRouteMgr::update_mirror()
992 mirror->removeChildren("wp");
994 int num = numWaypts();
995 for (int i = 0; i < num; i++) {
996 Waypt* wp = _route[i];
997 SGPropertyNode *prop = mirror->getChild("wp", i, 1);
999 const SGGeod& pos(wp->position());
1000 prop->setStringValue("id", wp->ident().c_str());
1001 prop->setDoubleValue("longitude-deg", pos.getLongitudeDeg());
1002 prop->setDoubleValue("latitude-deg",pos.getLatitudeDeg());
1004 // leg course+distance
1005 if (i < (num - 1)) {
1006 Waypt* next = _route[i+1];
1007 std::pair<double, double> crsDist =
1008 next->courseAndDistanceFrom(pos);
1009 prop->setDoubleValue("leg-bearing-true-deg", crsDist.first);
1010 prop->setDoubleValue("leg-distance-nm", crsDist.second * SG_METER_TO_NM);
1013 if (wp->altitudeRestriction() != RESTRICT_NONE) {
1014 double ft = wp->altitudeFt();
1015 prop->setDoubleValue("altitude-m", ft * SG_FEET_TO_METER);
1016 prop->setDoubleValue("altitude-ft", ft);
1017 prop->setIntValue("flight-level", static_cast<int>(ft / 1000) * 10);
1019 prop->setDoubleValue("altitude-m", -9999.9);
1020 prop->setDoubleValue("altitude-ft", -9999.9);
1023 if (wp->speedRestriction() == SPEED_RESTRICT_MACH) {
1024 prop->setDoubleValue("speed-mach", wp->speedMach());
1025 } else if (wp->speedRestriction() != RESTRICT_NONE) {
1026 prop->setDoubleValue("speed-kts", wp->speedKts());
1029 if (wp->flag(WPT_ARRIVAL)) {
1030 prop->setBoolValue("arrival", true);
1033 if (wp->flag(WPT_DEPARTURE)) {
1034 prop->setBoolValue("departure", true);
1037 if (wp->flag(WPT_MISS)) {
1038 prop->setBoolValue("missed-approach", true);
1041 prop->setBoolValue("generated", wp->flag(WPT_GENERATED));
1042 } // of waypoint iteration
1044 // set number as listener attachment point
1045 mirror->setIntValue("num", _route.size());
1047 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1048 FGDialog* rmDlg = gui->getDialog("route-manager");
1050 rmDlg->updateValues();
1054 // command interface /autopilot/route-manager/input:
1056 // @CLEAR ... clear route
1057 // @POP ... remove first entry
1058 // @DELETE3 ... delete 4th entry
1059 // @INSERT2:KSFO@900 ... insert "KSFO@900" as 3rd entry
1060 // KSFO@900 ... append "KSFO@900"
1062 void FGRouteMgr::InputListener::valueChanged(SGPropertyNode *prop)
1064 const char *s = prop->getStringValue();
1065 if (strlen(s) == 0) {
1069 if (!strcmp(s, "@CLEAR"))
1071 else if (!strcmp(s, "@ACTIVATE"))
1073 else if (!strcmp(s, "@LOAD")) {
1074 SGPath path(mgr->_pathNode->getStringValue());
1075 mgr->loadRoute(path);
1076 } else if (!strcmp(s, "@SAVE")) {
1077 SGPath path(mgr->_pathNode->getStringValue());
1078 mgr->saveRoute(path);
1079 } else if (!strcmp(s, "@NEXT")) {
1080 mgr->jumpToIndex(mgr->_currentIndex + 1);
1081 } else if (!strcmp(s, "@PREVIOUS")) {
1082 mgr->jumpToIndex(mgr->_currentIndex - 1);
1083 } else if (!strncmp(s, "@JUMP", 5)) {
1084 mgr->jumpToIndex(atoi(s + 5));
1085 } else if (!strncmp(s, "@DELETE", 7))
1086 mgr->removeWayptAtIndex(atoi(s + 7));
1087 else if (!strncmp(s, "@INSERT", 7)) {
1089 int pos = strtol(s + 7, &r, 10);
1095 mgr->insertWayptAtIndex(mgr->waypointFromString(r), pos);
1096 } else if (!strncmp(s, "@ROUTE", 6)) {
1098 int endIndex = strtol(s + 6, &r, 10);
1099 RouteType rt = (RouteType) mgr->_routingType->getIntValue();
1100 mgr->routeToIndex(endIndex, rt);
1101 } else if (!strcmp(s, "@AUTOROUTE")) {
1103 } else if (!strcmp(s, "@POSINIT")) {
1104 mgr->initAtPosition();
1106 mgr->insertWayptAtIndex(mgr->waypointFromString(s), -1);
1109 void FGRouteMgr::initAtPosition()
1111 if (isRouteActive()) {
1112 return; // don't mess with the active route
1115 if (haveUserWaypoints()) {
1116 // user has already defined, loaded or entered a route, again
1117 // don't interfere with it
1121 if (airborne->getBoolValue()) {
1122 SG_LOG(SG_AUTOPILOT, SG_INFO, "initAtPosition: airborne, clearing departure info");
1124 departure->setStringValue("runway", "");
1129 SGGeod pos = SGGeod::fromDegFt(lon->getDoubleValue(),
1130 lat->getDoubleValue(), alt->getDoubleValue());
1132 _departure = FGAirport::findClosest(pos, 20.0);
1134 SG_LOG(SG_AUTOPILOT, SG_INFO, "initAtPosition: couldn't find an airport within 20nm");
1135 departure->setStringValue("runway", "");
1140 std::string rwy = departure->getStringValue("runway");
1142 // runway already set, fine
1146 FGRunway* r = _departure->findBestRunwayForPos(pos);
1151 departure->setStringValue("runway", r->ident().c_str());
1152 SG_LOG(SG_AUTOPILOT, SG_INFO, "initAtPosition: starting at "
1153 << _departure->ident() << " on runway " << r->ident());
1156 bool FGRouteMgr::haveUserWaypoints() const
1158 return std::find_if(_route.begin(), _route.end(), NotGeneratedWayptPredicate()) != _route.end();
1161 bool FGRouteMgr::activate()
1163 if (isRouteActive()) {
1164 SG_LOG(SG_AUTOPILOT, SG_WARN, "duplicate route-activation, no-op");
1169 currentWaypointChanged();
1171 /* double routeDistanceNm = _route->total_distance() * SG_METER_TO_NM;
1172 totalDistance->setDoubleValue(routeDistanceNm);
1173 double cruiseSpeedKts = cruise->getDoubleValue("speed", 0.0);
1174 if (cruiseSpeedKts > 1.0) {
1175 // very very crude approximation, doesn't allow for climb / descent
1176 // performance or anything else at all
1177 ete->setDoubleValue(routeDistanceNm / cruiseSpeedKts * (60.0 * 60.0));
1180 active->setBoolValue(true);
1181 SG_LOG(SG_AUTOPILOT, SG_INFO, "route-manager, activate route ok");
1186 void FGRouteMgr::sequence()
1188 if (!active->getBoolValue()) {
1189 SG_LOG(SG_AUTOPILOT, SG_ALERT, "trying to sequence waypoints with no active route");
1193 if (checkFinished()) {
1198 currentWaypointChanged();
1201 bool FGRouteMgr::checkFinished()
1203 if (_currentIndex < (int) _route.size()) {
1207 SG_LOG(SG_AUTOPILOT, SG_INFO, "reached end of active route");
1208 _finished->fireValueChanged();
1209 active->setBoolValue(false);
1213 void FGRouteMgr::jumpToIndex(int index)
1215 if ((index < 0) || (index >= (int) _route.size())) {
1216 SG_LOG(SG_AUTOPILOT, SG_ALERT, "passed invalid index (" <<
1217 index << ") to FGRouteMgr::jumpToIndex");
1221 if (_currentIndex == index) {
1225 // all the checks out the way, go ahead and update state
1226 _currentIndex = index;
1227 currentWaypointChanged();
1228 _currentWpt->fireValueChanged();
1231 void FGRouteMgr::currentWaypointChanged()
1233 Waypt* cur = currentWaypt();
1234 Waypt* next = nextWaypt();
1236 wp0->getChild("id")->setStringValue(cur ? cur->ident() : "");
1237 wp1->getChild("id")->setStringValue(next ? next->ident() : "");
1239 _currentWpt->fireValueChanged();
1240 SG_LOG(SG_AUTOPILOT, SG_INFO, "route manager, current-wp is now " << _currentIndex);
1243 int FGRouteMgr::findWayptIndex(const SGGeod& aPos) const
1245 for (int i=0; i<numWaypts(); ++i) {
1246 if (_route[i]->matches(aPos)) {
1254 Waypt* FGRouteMgr::currentWaypt() const
1256 if ((_currentIndex < 0) || (_currentIndex >= numWaypts()))
1258 return wayptAtIndex(_currentIndex);
1261 Waypt* FGRouteMgr::previousWaypt() const
1263 if (_currentIndex == 0) {
1267 return wayptAtIndex(_currentIndex - 1);
1270 Waypt* FGRouteMgr::nextWaypt() const
1272 if ((_currentIndex < 0) || ((_currentIndex + 1) >= numWaypts())) {
1276 return wayptAtIndex(_currentIndex + 1);
1279 Waypt* FGRouteMgr::wayptAtIndex(int index) const
1281 if ((index < 0) || (index >= numWaypts())) {
1282 throw sg_range_exception("waypt index out of range", "FGRouteMgr::wayptAtIndex");
1285 return _route[index];
1288 SGPropertyNode_ptr FGRouteMgr::wayptNodeAtIndex(int index) const
1290 if ((index < 0) || (index >= numWaypts())) {
1291 throw sg_range_exception("waypt index out of range", "FGRouteMgr::wayptAtIndex");
1294 return mirror->getChild("wp", index);
1297 bool FGRouteMgr::saveRoute(const SGPath& path)
1299 SG_LOG(SG_IO, SG_INFO, "Saving route to " << path.str());
1301 SGPropertyNode_ptr d(new SGPropertyNode);
1302 SGPath path(_pathNode->getStringValue());
1303 d->setIntValue("version", 2);
1306 d->setStringValue("departure/airport", _departure->ident());
1307 d->setStringValue("departure/sid", departure->getStringValue("sid"));
1308 d->setStringValue("departure/runway", departure->getStringValue("runway"));
1312 d->setStringValue("destination/airport", _destination->ident());
1313 d->setStringValue("destination/star", destination->getStringValue("star"));
1314 d->setStringValue("destination/transition", destination->getStringValue("transition"));
1315 d->setStringValue("destination/runway", destination->getStringValue("runway"));
1319 SGPropertyNode* routeNode = d->getChild("route", 0, true);
1320 for (unsigned int i=0; i<_route.size(); ++i) {
1321 Waypt* wpt = _route[i];
1322 wpt->saveAsNode(routeNode->getChild("wp", i, true));
1323 } // of waypoint iteration
1324 writeProperties(path.str(), d, true /* write-all */);
1326 } catch (sg_exception& e) {
1327 SG_LOG(SG_IO, SG_ALERT, "Failed to save flight-plan '" << path.str() << "'. " << e.getMessage());
1332 bool FGRouteMgr::loadRoute(const SGPath& path)
1336 SG_LOG(SG_IO, SG_ALERT, "Failed to load flight-plan '" << path.str()
1337 << "'. The file does not exist.");
1341 // deactivate route first
1342 active->setBoolValue(false);
1344 SGPropertyNode_ptr routeData(new SGPropertyNode);
1346 SG_LOG(SG_IO, SG_INFO, "going to read flight-plan from:" << path.str());
1348 bool Status = false;
1350 readProperties(path.str(), routeData);
1351 } catch (sg_exception& ) {
1352 // if XML parsing fails, the file might be simple textual list of waypoints
1353 Status = loadPlainTextRoute(path);
1357 if (routeData.valid())
1360 int version = routeData->getIntValue("version", 1);
1362 loadVersion1XMLRoute(routeData);
1363 } else if (version == 2) {
1364 loadVersion2XMLRoute(routeData);
1366 throw sg_io_exception("unsupported XML route version");
1369 } catch (sg_exception& e) {
1370 SG_LOG(SG_IO, SG_ALERT, "Failed to load flight-plan '" << e.getOrigin()
1371 << "'. " << e.getMessage());
1381 void FGRouteMgr::loadXMLRouteHeader(SGPropertyNode_ptr routeData)
1384 SGPropertyNode* dep = routeData->getChild("departure");
1386 string depIdent = dep->getStringValue("airport");
1387 _departure = (FGAirport*) fgFindAirportID(depIdent);
1388 departure->setStringValue("runway", dep->getStringValue("runway"));
1389 departure->setStringValue("sid", dep->getStringValue("sid"));
1390 departure->setStringValue("transition", dep->getStringValue("transition"));
1394 SGPropertyNode* dst = routeData->getChild("destination");
1396 _destination = (FGAirport*) fgFindAirportID(dst->getStringValue("airport"));
1397 destination->setStringValue("runway", dst->getStringValue("runway"));
1398 destination->setStringValue("star", dst->getStringValue("star"));
1399 destination->setStringValue("transition", dst->getStringValue("transition"));
1403 SGPropertyNode* alt = routeData->getChild("alternate");
1405 alternate->setStringValue(alt->getStringValue("airport"));
1406 } // of cruise data loading
1409 SGPropertyNode* crs = routeData->getChild("cruise");
1411 cruise->setDoubleValue("speed-kts", crs->getDoubleValue("speed-kts"));
1412 cruise->setDoubleValue("mach", crs->getDoubleValue("mach"));
1413 cruise->setDoubleValue("altitude-ft", crs->getDoubleValue("altitude-ft"));
1414 } // of cruise data loading
1418 void FGRouteMgr::loadVersion2XMLRoute(SGPropertyNode_ptr routeData)
1420 loadXMLRouteHeader(routeData);
1424 SGPropertyNode_ptr routeNode = routeData->getChild("route", 0);
1425 for (int i=0; i<routeNode->nChildren(); ++i) {
1426 SGPropertyNode_ptr wpNode = routeNode->getChild("wp", i);
1427 WayptRef wpt = Waypt::createFromProperties(NULL, wpNode);
1428 wpts.push_back(wpt);
1429 } // of route iteration
1434 void FGRouteMgr::loadVersion1XMLRoute(SGPropertyNode_ptr routeData)
1436 loadXMLRouteHeader(routeData);
1440 SGPropertyNode_ptr routeNode = routeData->getChild("route", 0);
1441 for (int i=0; i<routeNode->nChildren(); ++i) {
1442 SGPropertyNode_ptr wpNode = routeNode->getChild("wp", i);
1443 WayptRef wpt = parseVersion1XMLWaypt(wpNode);
1444 wpts.push_back(wpt);
1445 } // of route iteration
1450 WayptRef FGRouteMgr::parseVersion1XMLWaypt(SGPropertyNode* aWP)
1453 if (!_route.empty()) {
1454 lastPos = _route.back()->position();
1455 } else if (_departure) {
1456 lastPos = _departure->geod();
1460 string ident(aWP->getStringValue("ident"));
1461 if (aWP->hasChild("longitude-deg")) {
1462 // explicit longitude/latitude
1463 w = new BasicWaypt(SGGeod::fromDeg(aWP->getDoubleValue("longitude-deg"),
1464 aWP->getDoubleValue("latitude-deg")), ident, NULL);
1467 string nid = aWP->getStringValue("navid", ident.c_str());
1468 FGPositionedRef p = FGPositioned::findClosestWithIdent(nid, lastPos);
1470 throw sg_io_exception("bad route file, unknown navid:" + nid);
1473 SGGeod pos(p->geod());
1474 if (aWP->hasChild("offset-nm") && aWP->hasChild("offset-radial")) {
1475 double radialDeg = aWP->getDoubleValue("offset-radial");
1476 // convert magnetic radial to a true radial!
1477 radialDeg += magvar->getDoubleValue();
1478 double offsetNm = aWP->getDoubleValue("offset-nm");
1480 SGGeodesy::direct(p->geod(), radialDeg, offsetNm * SG_NM_TO_METER, pos, az2);
1483 w = new BasicWaypt(pos, ident, NULL);
1486 double altFt = aWP->getDoubleValue("altitude-ft", -9999.9);
1487 if (altFt > -9990.0) {
1488 w->setAltitude(altFt, RESTRICT_AT);
1494 bool FGRouteMgr::loadPlainTextRoute(const SGPath& path)
1497 sg_gzifstream in(path.str().c_str());
1498 if (!in.is_open()) {
1499 throw sg_io_exception("Cannot open file for reading.");
1505 getline(in, line, '\n');
1506 // trim CR from end of line, if found
1507 if (line[line.size() - 1] == '\r') {
1508 line.erase(line.size() - 1, 1);
1511 line = simgear::strutils::strip(line);
1512 if (line.empty() || (line[0] == '#')) {
1513 continue; // ignore empty/comment lines
1516 WayptRef w = waypointFromString(line);
1518 throw sg_io_exception("Failed to create waypoint from line '" + line + "'.");
1522 } // of line iteration
1526 } catch (sg_exception& e) {
1527 SG_LOG(SG_IO, SG_ALERT, "Failed to load route from: '" << path.str() << "'. " << e.getMessage());
1532 const char* FGRouteMgr::getDepartureICAO() const
1538 return _departure->ident().c_str();
1541 const char* FGRouteMgr::getDepartureName() const
1547 return _departure->name().c_str();
1550 void FGRouteMgr::setDepartureICAO(const char* aIdent)
1552 if ((aIdent == NULL) || (strlen(aIdent) < 4)) {
1555 _departure = FGAirport::findByIdent(aIdent);
1561 const char* FGRouteMgr::getDestinationICAO() const
1563 if (!_destination) {
1567 return _destination->ident().c_str();
1570 const char* FGRouteMgr::getDestinationName() const
1572 if (!_destination) {
1576 return _destination->name().c_str();
1579 void FGRouteMgr::setDestinationICAO(const char* aIdent)
1581 if ((aIdent == NULL) || (strlen(aIdent) < 4)) {
1582 _destination = NULL;
1584 _destination = FGAirport::findByIdent(aIdent);
1590 FGAirportRef FGRouteMgr::departureAirport() const
1595 FGAirportRef FGRouteMgr::destinationAirport() const
1597 return _destination;
1600 FGRunway* FGRouteMgr::departureRunway() const
1606 string runwayId(departure->getStringValue("runway"));
1607 if (!_departure->hasRunwayWithIdent(runwayId)) {
1611 return _departure->getRunwayByIdent(runwayId);
1614 FGRunway* FGRouteMgr::destinationRunway() const
1616 if (!_destination) {
1620 string runwayId(destination->getStringValue("runway"));
1621 if (!_destination->hasRunwayWithIdent(runwayId)) {
1625 return _destination->getRunwayByIdent(runwayId);