1 // route_mgr.hxx - manage a route (i.e. a collection of waypoints)
3 // Written by Curtis Olson, started January 2004.
5 // Copyright (C) 2004 Curtis L. Olson - http://www.flightgear.org/~curt
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 #ifndef _ROUTE_MGR_HXX
25 #define _ROUTE_MGR_HXX 1
27 #include <simgear/props/props.hxx>
28 #include <simgear/route/waypoint.hxx>
29 #include <simgear/structure/subsystem_mgr.hxx>
36 typedef SGSharedPtr<FGAirport> FGAirportRef;
39 * Top level route manager class
43 class FGRouteMgr : public SGSubsystem
49 time_t _touchdownTime;
50 FGAirportRef _departure;
51 FGAirportRef _destination;
54 SGPropertyNode_ptr lon;
55 SGPropertyNode_ptr lat;
56 SGPropertyNode_ptr alt;
57 SGPropertyNode_ptr magvar;
60 SGPropertyNode_ptr departure; ///< departure airport information
61 SGPropertyNode_ptr destination; ///< destination airport information
62 SGPropertyNode_ptr alternate; ///< alternate airport information
63 SGPropertyNode_ptr cruise; ///< cruise information
65 SGPropertyNode_ptr totalDistance;
66 SGPropertyNode_ptr ete;
67 SGPropertyNode_ptr elapsedFlightTime;
69 SGPropertyNode_ptr active;
70 SGPropertyNode_ptr airborne;
72 SGPropertyNode_ptr wp0;
73 SGPropertyNode_ptr wp1;
74 SGPropertyNode_ptr wpn;
77 SGPropertyNode_ptr _pathNode;
78 SGPropertyNode_ptr _currentWpt;
82 * Signal property to notify people that the route was edited
84 SGPropertyNode_ptr _edited;
87 * Signal property to notify when the last waypoint is reached
89 SGPropertyNode_ptr _finished;
91 void setETAPropertyFromDistance(SGPropertyNode_ptr aProp, double aDistance);
93 class InputListener : public SGPropertyChangeListener {
95 InputListener(FGRouteMgr *m) : mgr(m) {}
96 virtual void valueChanged (SGPropertyNode * prop);
101 SGPropertyNode_ptr input;
102 SGPropertyNode_ptr weightOnWheels;
104 InputListener *listener;
105 SGPropertyNode_ptr mirror;
108 * Create a SGWayPoint from a string in the following format:
109 * - simple identifier
110 * - decimal-lon,decimal-lat
111 * - airport-id/runway-id
112 * - navaid/radial-deg/offset-nm
114 SGWayPoint* make_waypoint(const string& target);
117 * Helper to keep various pieces of state in sync when the SGRoute is
118 * modified (waypoints added, inserted, removed). Notably, this fires the
121 void waypointsChanged();
123 void update_mirror();
125 void currentWaypointChanged();
128 * Parse a route/wp node (from a saved, property-lsit formatted route)
130 void parseRouteWaypoint(SGPropertyNode* aWP);
133 * Check if we've reached the final waypoint.
134 * Returns true if we have.
136 bool checkFinished();
139 void loadPlainTextRoute(const SGPath& path);
141 // tied getters and setters
142 const char* getDepartureICAO() const;
143 const char* getDepartureName() const;
144 void setDepartureICAO(const char* aIdent);
146 const char* getDestinationICAO() const;
147 const char* getDestinationName() const;
148 void setDestinationICAO(const char* aIdent);
159 void update (double dt);
163 void new_waypoint( const string& tgt_alt, int n = -1 );
164 void add_waypoint( const SGWayPoint& wp, int n = -1 );
165 SGWayPoint pop_waypoint( int i = 0 );
167 SGWayPoint get_waypoint( int i ) const;
170 bool isRouteActive() const;
172 int currentWaypoint() const;
175 * Find a waypoint in the route, by position, and return its index, or
176 * -1 if no matching waypoint was found in the route.
178 int findWaypoint(const SGGeod& aPos) const;
181 * Activate a built route. This checks for various mandatory pieces of
182 * data, such as departure and destination airports, and creates waypoints
183 * for them on the route structure.
185 * returns true if the route was activated successfully, or false if the
186 * route could not be activated for some reason
191 * Step to the next waypoint on the active route
198 void jumpToIndex(int index);
203 void setWaypointTargetAltitudeFt(unsigned int index, int altFt);
210 #endif // _ROUTE_MGR_HXX