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/structure/subsystem_mgr.hxx>
30 #include <Navaids/FlightPlan.hxx>
34 class PropertyWatcher;
37 * Top level route manager class
41 class FGRouteMgr : public SGSubsystem,
42 public flightgear::FlightPlan::Delegate
52 void update (double dt);
54 bool isRouteActive() const;
56 int currentIndex() const;
58 void setFlightPlan(const flightgear::FlightPlanRef& plan);
59 flightgear::FlightPlanRef flightPlan() const;
63 flightgear::Waypt* currentWaypt() const;
72 flightgear::Waypt* wayptAtIndex(int index) const;
74 SGPropertyNode_ptr wayptNodeAtIndex(int index) const;
76 void removeLegAtIndex(int aIndex);
79 * Activate a built route. This checks for various mandatory pieces of
80 * data, such as departure and destination airports, and creates waypoints
81 * for them on the route structure.
83 * returns true if the route was activated successfully, or false if the
84 * route could not be activated for some reason
89 * deactivate the route if active
94 * Set the current waypoint to the specified index.
96 void jumpToIndex(int index);
98 bool saveRoute(const SGPath& p);
99 bool loadRoute(const SGPath& p);
101 flightgear::WayptRef waypointFromString(const std::string& target);
104 bool commandDefineUserWaypoint(const SGPropertyNode* arg);
105 bool commandDeleteUserWaypoint(const SGPropertyNode* arg);
107 flightgear::FlightPlanRef _plan;
110 time_t _touchdownTime;
113 SGPropertyNode_ptr magvar;
116 SGPropertyNode_ptr departure; ///< departure airport information
117 SGPropertyNode_ptr destination; ///< destination airport information
118 SGPropertyNode_ptr alternate; ///< alternate airport information
119 SGPropertyNode_ptr cruise; ///< cruise information
121 SGPropertyNode_ptr totalDistance;
122 SGPropertyNode_ptr distanceToGo;
123 SGPropertyNode_ptr ete;
124 SGPropertyNode_ptr elapsedFlightTime;
126 SGPropertyNode_ptr active;
127 SGPropertyNode_ptr airborne;
129 SGPropertyNode_ptr wp0;
130 SGPropertyNode_ptr wp1;
131 SGPropertyNode_ptr wpn;
134 SGPropertyNode_ptr _pathNode;
135 SGPropertyNode_ptr _currentWpt;
139 * Signal property to notify people that the route was edited
141 SGPropertyNode_ptr _edited;
144 * Signal property to notify when the last waypoint is reached
146 SGPropertyNode_ptr _finished;
148 SGPropertyNode_ptr _flightplanChanged;
150 void setETAPropertyFromDistance(SGPropertyNode_ptr aProp, double aDistance);
153 * retrieve the cached path distance along a leg
155 double cachedLegPathDistanceM(int index) const;
156 double cachedWaypointPathTotalDistance(int index) const;
158 class InputListener : public SGPropertyChangeListener {
160 InputListener(FGRouteMgr *m) : mgr(m) {}
161 virtual void valueChanged (SGPropertyNode * prop);
166 SGPropertyNode_ptr input;
167 SGPropertyNode_ptr weightOnWheels;
168 SGPropertyNode_ptr groundSpeed;
170 InputListener *listener;
171 SGPropertyNode_ptr mirror;
174 * Helper to keep various pieces of state in sync when the route is
175 * modified (waypoints added, inserted, removed). Notably, this fires the
178 virtual void waypointsChanged();
180 void update_mirror();
182 virtual void currentWaypointChanged();
184 // tied getters and setters
185 const char* getDepartureICAO() const;
186 const char* getDepartureName() const;
187 void setDepartureICAO(const char* aIdent);
189 const char* getDepartureRunway() const;
190 void setDepartureRunway(const char* aIdent);
192 const char* getSID() const;
193 void setSID(const char* aIdent);
195 const char* getDestinationICAO() const;
196 const char* getDestinationName() const;
197 void setDestinationICAO(const char* aIdent);
199 const char* getDestinationRunway() const;
200 void setDestinationRunway(const char* aIdent);
202 const char* getApproach() const;
203 void setApproach(const char* aIdent);
205 const char* getSTAR() const;
206 void setSTAR(const char* aIdent);
208 double getDepartureFieldElevation() const;
209 double getDestinationFieldElevation() const;
213 #endif // _ROUTE_MGR_HXX