src/Autopilot/route_mgr.hxx

   1 // route_mgr.hxx - manage a route (i.e. a collection of waypoints)
   2 //
   3 // Written by Curtis Olson, started January 2004.
   4 //
   5 // Copyright (C) 2004  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _ROUTE_MGR_HXX
  25 #define _ROUTE_MGR_HXX 1
  26
  27 #include <simgear/props/props.hxx>
  28 #include <simgear/route/waypoint.hxx>
  29 #include <simgear/structure/subsystem_mgr.hxx>
  30
  31 // forward decls
  32 class SGRoute;
  33 class SGPath;
  34
  35 /**
  36  * Top level route manager class
  37  *
  38  */
  39
  40 class FGRouteMgr : public SGSubsystem
  41 {
  42
  43 private:
  44     SGRoute* _route;
  45     time_t _takeoffTime;
  46     time_t _touchdownTime;
  47
  48     // automatic inputs
  49     SGPropertyNode_ptr lon;
  50     SGPropertyNode_ptr lat;
  51     SGPropertyNode_ptr alt;
  52     SGPropertyNode_ptr magvar;
  53
  54     // automatic outputs
  55     SGPropertyNode_ptr departure; ///< departure airport information
  56     SGPropertyNode_ptr destination; ///< destination airport information
  57     SGPropertyNode_ptr alternate; ///< alternate airport information
  58     SGPropertyNode_ptr cruise; ///< cruise information
  59
  60     SGPropertyNode_ptr totalDistance;
  61     SGPropertyNode_ptr ete;
  62     SGPropertyNode_ptr elapsedFlightTime;
  63
  64     SGPropertyNode_ptr active;
  65     SGPropertyNode_ptr airborne;
  66
  67     SGPropertyNode_ptr wp0;
  68     SGPropertyNode_ptr wp1;
  69     SGPropertyNode_ptr wpn;
  70
  71
  72     SGPropertyNode_ptr _pathNode;
  73     SGPropertyNode_ptr _currentWpt;
  74
  75
  76     /**
  77      * Signal property to notify people that the route was edited
  78      */
  79     SGPropertyNode_ptr _edited;
  80
  81     /**
  82      * Signal property to notify when the last waypoint is reached
  83      */
  84     SGPropertyNode_ptr _finished;
  85
  86     void setETAPropertyFromDistance(SGPropertyNode_ptr aProp, double aDistance);
  87
  88     class InputListener : public SGPropertyChangeListener {
  89     public:
  90         InputListener(FGRouteMgr *m) : mgr(m) {}
  91         virtual void valueChanged (SGPropertyNode * prop);
  92     private:
  93         FGRouteMgr *mgr;
  94     };
  95
  96     SGPropertyNode_ptr input;
  97     SGPropertyNode_ptr weightOnWheels;
  98
  99     InputListener *listener;
 100     SGPropertyNode_ptr mirror;
 101
 102     /**
 103      * Create a SGWayPoint from a string in the following format:
 104      *  - simple identifier
 105      *  - decimal-lon,decimal-lat
 106      *  - airport-id/runway-id
 107      *  - navaid/radial-deg/offset-nm
 108      */
 109     SGWayPoint* make_waypoint(const string& target);
 110
 111
 112     void update_mirror();
 113
 114     void currentWaypointChanged();
 115
 116     /**
 117      * Parse a route/wp node (from a saved, property-lsit formatted route)
 118      */
 119     void parseRouteWaypoint(SGPropertyNode* aWP);
 120
 121     /**
 122      * Check if we've reached the final waypoint.
 123      * Returns true if we have.
 124      */
 125     bool checkFinished();
 126 public:
 127
 128     FGRouteMgr();
 129     ~FGRouteMgr();
 130
 131     void init ();
 132     void postinit ();
 133     void bind ();
 134     void unbind ();
 135     void update (double dt);
 136
 137     bool build ();
 138
 139     void new_waypoint( const string& tgt_alt, int n = -1 );
 140     void add_waypoint( const SGWayPoint& wp, int n = -1 );
 141     SGWayPoint pop_waypoint( int i = 0 );
 142
 143     SGWayPoint get_waypoint( int i ) const;
 144     int size() const;
 145
 146     bool isRouteActive() const;
 147
 148     int currentWaypoint() const;
 149
 150     /**
 151      * Find a waypoint in the route, by position, and return its index, or
 152      * -1 if no matching waypoint was found in the route.
 153      */
 154     int findWaypoint(const SGGeod& aPos) const;
 155
 156     /**
 157      * Activate a built route. This checks for various mandatory pieces of
 158      * data, such as departure and destination airports, and creates waypoints
 159      * for them on the route structure.
 160      *
 161      * returns true if the route was activated successfully, or false if the
 162      * route could not be activated for some reason
 163      */
 164     bool activate();
 165
 166     /**
 167      * Step to the next waypoint on the active route
 168      */
 169     void sequence();
 170
 171     /**
 172      *
 173      */
 174     void jumpToIndex(int index);
 175
 176     void saveRoute();
 177     void loadRoute();
 178 };
 179
 180
 181 #endif // _ROUTE_MGR_HXX