src/AIModel/AIFlightPlan.hxx

   1 // FGAIFlightPlan - class for loading and storing  AI flight plans
   2 // Written by David Culp, started May 2004
   3 // - davidculp2@comcast.net
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 #ifndef _FG_AIFLIGHTPLAN_HXX
  20 #define _FG_AIFLIGHTPLAN_HXX
  21
  22 #include <simgear/compiler.h>
  23 #include <vector>
  24 #include <string>
  25
  26
  27 #include <Airports/simple.hxx>
  28 #include <Navaids/awynet.hxx>
  29
  30 #include "AIBase.hxx"
  31
  32
  33
  34 using std::vector;
  35 using std::string;
  36
  37 class FGTaxiRoute;
  38 class FGRunway;
  39 class FGAIAircraft;
  40
  41 class FGAIFlightPlan {
  42
  43 public:
  44
  45   typedef struct {
  46    string name;
  47    double latitude;
  48    double longitude;
  49    double altitude;
  50    double speed;
  51    double crossat;
  52    bool finished;
  53    bool gear_down;
  54    bool flaps_down;
  55    bool on_ground;
  56     int routeIndex;  // For AI/ATC purposes;
  57    double time_sec;
  58    string time;
  59
  60   } waypoint;
  61   FGAIFlightPlan();
  62   FGAIFlightPlan(const string& filename);
  63   FGAIFlightPlan(FGAIAircraft *,
  64                  const std::string& p,
  65                  double course,
  66                  time_t start,
  67                  FGAirport *dep,
  68                  FGAirport *arr,
  69                  bool firstLeg,
  70                  double radius,
  71                  double alt,
  72                  double lat,
  73                  double lon,
  74                  double speed,
  75                  const string& fltType,
  76                  const string& acType,
  77                  const string& airline);
  78    ~FGAIFlightPlan();
  79
  80    waypoint* const getPreviousWaypoint( void ) const;
  81    waypoint* const getCurrentWaypoint( void ) const;
  82    waypoint* const getNextWaypoint( void ) const;
  83    void IncrementWaypoint( bool erase );
  84    void DecrementWaypoint( bool erase );
  85
  86    double getDistanceToGo(double lat, double lon, waypoint* wp) const;
  87    int getLeg () const { return leg;};
  88    void setLeadDistance(double speed, double bearing, waypoint* current, waypoint* next);
  89    void setLeadDistance(double distance_ft);
  90    double getLeadDistance( void ) const {return lead_distance;}
  91    double getBearing(waypoint* previous, waypoint* next) const;
  92    double getBearing(double lat, double lon, waypoint* next) const;
  93   time_t getStartTime() const { return start_time; }
  94
  95   void    create(FGAIAircraft *, FGAirport *dep, FGAirport *arr, int leg, double alt, double speed, double lat, double lon,
  96                  bool firstLeg, double radius, const string& fltType, const string& aircraftType, const string& airline);
  97
  98   void setLeg(int val) { leg = val;}
  99   void setTime(time_t st) { start_time = st; }
 100   int getGate() const { return gateId; }
 101   double getLeadInAngle() const { return leadInAngle; }
 102   const string& getRunway() const;
 103
 104   void setRepeat(bool r) { repeat = r; }
 105   bool getRepeat(void) const { return repeat; }
 106   void restart(void);
 107   int getNrOfWayPoints() { return waypoints.size(); }
 108   int getRouteIndex(int i); // returns the AI related index of this current routes.
 109   FGTaxiRoute *getTaxiRoute() { return taxiRoute; }
 110   void deleteTaxiRoute();
 111   string getRunway() { return activeRunway; }
 112   bool isActive(time_t time) {return time >= this->getStartTime();}
 113
 114   void setRunway(string rwy) { activeRunway = rwy; };
 115   string getRunwayClassFromTrafficType(string fltType);
 116
 117   void addWaypoint(waypoint* wpt) { waypoints.push_back(wpt); };
 118
 119   void setName(string n) { name = n; };
 120   string getName() { return name; };
 121
 122   void setSID(FGAIFlightPlan* fp) { sid = fp;};
 123   FGAIFlightPlan* getSID() { return sid; };
 124
 125 private:
 126   FGRunway* rwy;
 127   FGAIFlightPlan *sid;
 128   typedef vector <waypoint*> wpt_vector_type;
 129   typedef wpt_vector_type::const_iterator wpt_vector_iterator;
 130
 131   wpt_vector_type       waypoints;
 132   wpt_vector_iterator   wpt_iterator;
 133
 134   bool repeat;
 135   double distance_to_go;
 136   double lead_distance;
 137   double leadInAngle;
 138   time_t start_time;
 139   int leg;
 140   int gateId, lastNodeVisited;
 141   string activeRunway;
 142   FGAirRoute airRoute;
 143   FGTaxiRoute *taxiRoute;
 144   string name;
 145
 146   void createPushBack(FGAIAircraft *, bool, FGAirport*, double, double, double, const string&, const string&, const string&);
 147   void createPushBackFallBack(FGAIAircraft *, bool, FGAirport*, double, double, double, const string&, const string&, const string&);
 148   void createTakeOff(FGAIAircraft *, bool, FGAirport *, double, const string&);
 149   void createClimb(FGAIAircraft *, bool, FGAirport *, double, double, const string&);
 150   void createCruise(FGAIAircraft *, bool, FGAirport*, FGAirport*, double, double, double, double, const string&);
 151   void createDecent(FGAIAircraft *, FGAirport *, const string&);
 152   void createLanding(FGAIAircraft *, FGAirport *);
 153   void createParking(FGAIAircraft *, FGAirport *, double radius);
 154   void deleteWaypoints();
 155   void resetWaypoints();
 156
 157   void createLandingTaxi(FGAIAircraft *, FGAirport *apt, double radius, const string& fltType, const string& acType, const string& airline);
 158   void createDefaultLandingTaxi(FGAIAircraft *, FGAirport* aAirport);
 159   void createDefaultTakeoffTaxi(FGAIAircraft *, FGAirport* aAirport, FGRunway* aRunway);
 160   void createTakeoffTaxi(FGAIAircraft *, bool firstFlight, FGAirport *apt, double radius, const string& fltType, const string& acType, const string& airline);
 161
 162   waypoint* createOnGround(FGAIAircraft *, const std::string& aName, const SGGeod& aPos, double aElev, double aSpeed);
 163   waypoint* createInAir(FGAIAircraft *, const std::string& aName, const SGGeod& aPos, double aElev, double aSpeed);
 164   waypoint* cloneWithPos(FGAIAircraft *, waypoint* aWpt, const std::string& aName, const SGGeod& aPos);
 165   waypoint* clone(waypoint* aWpt);
 166
 167
 168   //void createCruiseFallback(bool, FGAirport*, FGAirport*, double, double, double, double);
 169  void evaluateRoutePart(double deplat, double deplon, double arrlat, double arrlon);
 170  public:
 171   wpt_vector_iterator getFirstWayPoint() { return waypoints.begin(); };
 172   wpt_vector_iterator getLastWayPoint()  { return waypoints.end(); };
 173
 174 };
 175
 176 #endif  // _FG_AIFLIGHTPLAN_HXX