]> git.mxchange.org Git - flightgear.git/blobdiff - src/AIModel/AIFlightPlan.hxx
Don't duplicate userpos in in AIObjects.
[flightgear.git] / src / AIModel / AIFlightPlan.hxx
index c70028dd3e85a3fa37b206eff29a1f19133f2d0f..bfd445b27b54ef4ff33064953c7ced2493178ac3 100644 (file)
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
 
 #ifndef _FG_AIFLIGHTPLAN_HXX
 #define _FG_AIFLIGHTPLAN_HXX
 
-#include <simgear/compiler.h>
 #include <vector>
 #include <string>
 
+#include <simgear/compiler.h>
+#include <simgear/math/SGMath.hxx>
+#include <simgear/structure/SGSharedPtr.hxx>
+#include <Navaids/positioned.hxx>
+#include <Airports/dynamics.hxx>
 
-#include <Airports/simple.hxx>
-#include <Navaids/awynet.hxx>
-
-#include "AIBase.hxx"
-
-
-
-using std::vector;
-using std::string;
-
-class FGTaxiRoute;
-class FGRunway;
-class FGAIAircraft;
-
-class FGAIFlightPlan {
-
-public:
-
-  typedef struct {
-   string name;
-   double latitude;
-   double longitude;
-   double altitude;
+class FGAIWaypoint {
+private:
+   std::string name;
+   SGGeod pos;
    double speed;
    double crossat;
    bool finished;
@@ -55,11 +40,56 @@ public:
    bool on_ground;
     int routeIndex;  // For AI/ATC purposes;
    double time_sec;
-   string time;
+   double trackLength; // distance from previous FGAIWaypoint (for AI purposes);
+   std::string time;
+
+public:
+    FGAIWaypoint();
+    ~FGAIWaypoint() {};
+    void setName        (const std::string& nam) { name        = nam; };
+    void setLatitude    (double lat);
+    void setLongitude   (double lon);
+    void setAltitude    (double alt);
+    void setPos         (const SGGeod& aPos) { pos = aPos; }
+    void setSpeed       (double spd) { speed       = spd; };
+    void setCrossat     (double val) { crossat     = val; };
+    void setFinished    (bool   fin) { finished    = fin; };
+    void setGear_down   (bool   grd) { gear_down   = grd; };
+    void setFlaps_down  (bool   fld) { flaps_down  = fld; };
+    void setOn_ground   (bool   grn) { on_ground   = grn; };
+    void setRouteIndex  (int    rte) { routeIndex  = rte; };
+    void setTime_sec    (double ts ) { time_sec    = ts;  };
+    void setTrackLength (double tl ) { trackLength = tl;  };
+    void setTime        (const std::string& tme) { time        = tme; };
+
+    bool contains(const std::string& name);
+
+    const std::string& getName() { return name;        };
+    const SGGeod& getPos () { return pos;         };
+    double getLatitude   ();
+    double getLongitude  ();
+    double getAltitude   ();
+    double getSpeed      () { return speed;       };
+
+    double getCrossat    () { return crossat;     };
+    bool   getGear_down  () { return gear_down;   };
+    bool   getFlaps_down () { return flaps_down;  };
+    bool   getOn_ground  () { return on_ground;   };
+    int    getRouteIndex () { return routeIndex;  };
+    bool   isFinished    () { return finished;    };
+    double getTime_sec   () { return time_sec;    };
+    double getTrackLength() { return trackLength; };
+    const std::string& getTime  () { return time;        };
+
+  };
+
+
+class FGAIFlightPlan {
+
+public:
 
-  } waypoint;
   FGAIFlightPlan();
-  FGAIFlightPlan(const string& filename);
+  FGAIFlightPlan(const std::string& filename);
   FGAIFlightPlan(FGAIAircraft *,
                  const std::string& p,
                 double course,
@@ -72,62 +102,78 @@ public:
                  double lat,
                  double lon,
                  double speed,
-                const string& fltType,
-                const string& acType,
-                const string& airline);
+                const std::string& fltType,
+                const std::string& acType,
+                const std::string& airline);
    ~FGAIFlightPlan();
 
-   waypoint* const getPreviousWaypoint( void ) const;
-   waypoint* const getCurrentWaypoint( void ) const;
-   waypoint* const getNextWaypoint( void ) const;
+   FGAIWaypoint* const getPreviousWaypoint( void ) const;
+   FGAIWaypoint* const getCurrentWaypoint( void ) const;
+   FGAIWaypoint* const getNextWaypoint( void ) const;
    void IncrementWaypoint( bool erase );
    void DecrementWaypoint( bool erase );
 
-   double getDistanceToGo(double lat, double lon, waypoint* wp) const;
+   double getDistanceToGo(double lat, double lon, FGAIWaypoint* wp) const;
    int getLeg () const { return leg;};
-   void setLeadDistance(double speed, double bearing, waypoint* current, waypoint* next);
+   
+   void setLeadDistance(double speed, double bearing, FGAIWaypoint* current, FGAIWaypoint* next);
    void setLeadDistance(double distance_ft);
    double getLeadDistance( void ) const {return lead_distance;}
-   double getBearing(waypoint* previous, waypoint* next) const;
-   double getBearing(double lat, double lon, waypoint* next) const;
+   double getBearing(FGAIWaypoint* previous, FGAIWaypoint* next) const;
+   double getBearing(const SGGeod& aPos, FGAIWaypoint* next) const;
+  
+   double checkTrackLength(const std::string& wptName) const;
   time_t getStartTime() const { return start_time; }
+   time_t getArrivalTime() const { return arrivalTime; }
 
-  void    create(FGAIAircraft *, FGAirport *dep, FGAirport *arr, int leg, double alt, double speed, double lat, double lon,
-                bool firstLeg, double radius, const string& fltType, const string& aircraftType, const string& airline);
+  bool    create(FGAIAircraft *, FGAirport *dep, FGAirport *arr, int leg, double alt, double speed, double lat, double lon,
+                bool firstLeg, double radius, const std::string& fltType, const std::string& aircraftType, const std::string& airline, double distance);
+  bool createPushBack(FGAIAircraft *, bool, FGAirport*, double radius, const std::string&, const std::string&, const std::string&);
+  bool createTakeOff(FGAIAircraft *, bool, FGAirport *, double, const std::string&);
 
   void setLeg(int val) { leg = val;}
   void setTime(time_t st) { start_time = st; }
-  int getGate() const { return gateId; }
+
+
   double getLeadInAngle() const { return leadInAngle; }
-  const string& getRunway() const;
+  const std::string& getRunway() const;
   
   void setRepeat(bool r) { repeat = r; }
   bool getRepeat(void) const { return repeat; }
   void restart(void);
   int getNrOfWayPoints() { return waypoints.size(); }
-  int getRouteIndex(int i); // returns the AI related index of this current routes. 
-  FGTaxiRoute *getTaxiRoute() { return taxiRoute; }
-  void deleteTaxiRoute();
-  string getRunway() { return activeRunway; }
+
+  int getRouteIndex(int i); // returns the AI related index of this current routes.
+
+  const std::string& getRunway() { return activeRunway; }
   bool isActive(time_t time) {return time >= this->getStartTime();}
 
-  void setRunway(string rwy) { activeRunway = rwy; };
-  string getRunwayClassFromTrafficType(string fltType);
+  void incrementLeg() { leg++;};
 
-  void addWaypoint(waypoint* wpt) { waypoints.push_back(wpt); };
+  void setRunway(const std::string& rwy) { activeRunway = rwy; };
+  const char* getRunwayClassFromTrafficType(const std::string& fltType);
 
-  void setName(string n) { name = n; };
-  string getName() { return name; };
+  void addWaypoint(FGAIWaypoint* wpt) { waypoints.push_back(wpt); };
+
+  void setName(const std::string& n) { name = n; };
+  const std::string& getName() { return name; };
 
   void setSID(FGAIFlightPlan* fp) { sid = fp;};
   FGAIFlightPlan* getSID() { return sid; };
+  FGAIWaypoint *getWayPoint(int i) { return waypoints[i]; };
+  FGAIWaypoint *getLastWaypoint() { return waypoints.back(); };
+  
+  void shortenToFirst(unsigned int number, std::string name);
+
+  void setGate(const ParkingAssignment& pka);
+  FGParking* getParkingGate();
 
 private:
-  FGRunway* rwy;
   FGAIFlightPlan *sid;
-  typedef vector <waypoint*> wpt_vector_type;
+  typedef std::vector <FGAIWaypoint*> wpt_vector_type;
   typedef wpt_vector_type::const_iterator wpt_vector_iterator;
 
+
   wpt_vector_type       waypoints;
   wpt_vector_iterator   wpt_iterator;
 
@@ -136,41 +182,67 @@ private:
   double lead_distance;
   double leadInAngle;
   time_t start_time;
+  time_t arrivalTime;       // For AI/ATC purposes.
   int leg;
-  int gateId, lastNodeVisited;
-  string activeRunway;
-  FGAirRoute airRoute;
-  FGTaxiRoute *taxiRoute;
-  string name;
-
-  void createPushBack(FGAIAircraft *, bool, FGAirport*, double, double, double, const string&, const string&, const string&);
-  void createPushBackFallBack(FGAIAircraft *, bool, FGAirport*, double, double, double, const string&, const string&, const string&);
-  void createTakeOff(FGAIAircraft *, bool, FGAirport *, double, const string&);
-  void createClimb(FGAIAircraft *, bool, FGAirport *, double, double, const string&);
-  void createCruise(FGAIAircraft *, bool, FGAirport*, FGAirport*, double, double, double, double, const string&);
-  void createDecent(FGAIAircraft *, FGAirport *, const string&);
-  void createLanding(FGAIAircraft *, FGAirport *, const string&);
-  void createParking(FGAIAircraft *, FGAirport *, double radius);
+  ParkingAssignment gate;
+  PositionedID lastNodeVisited;
+  std::string activeRunway;
+  std::string name;
+  bool isValid;
+  FGAirportRef departure, arrival;
+  
+  void createPushBackFallBack(FGAIAircraft *, bool, FGAirport*, double radius, const std::string&, const std::string&, const std::string&);
+  bool createClimb(FGAIAircraft *, bool, FGAirport *, FGAirport* arrival, double, double, const std::string&);
+  bool createCruise(FGAIAircraft *, bool, FGAirport*, FGAirport*, double, double, double, double, const std::string&);
+  bool createDescent(FGAIAircraft *, FGAirport *,  double latitude, double longitude, double speed, double alt,const std::string&, double distance);
+  bool createLanding(FGAIAircraft *, FGAirport *, const std::string&);
+  bool createParking(FGAIAircraft *, FGAirport *, double radius);
   void deleteWaypoints(); 
   void resetWaypoints();
+  void eraseLastWaypoint();
+  void pushBackWaypoint(FGAIWaypoint *wpt);
 
-  void createLandingTaxi(FGAIAircraft *, FGAirport *apt, double radius, const string& fltType, const string& acType, const string& airline);
+  bool createLandingTaxi(FGAIAircraft *, FGAirport *apt, double radius, const std::string& fltType, const std::string& acType, const std::string& airline);
   void createDefaultLandingTaxi(FGAIAircraft *, FGAirport* aAirport);
   void createDefaultTakeoffTaxi(FGAIAircraft *, FGAirport* aAirport, FGRunway* aRunway);
-  void createTakeoffTaxi(FGAIAircraft *, bool firstFlight, FGAirport *apt, double radius, const string& fltType, const string& acType, const string& airline);
+  bool createTakeoffTaxi(FGAIAircraft *, bool firstFlight, FGAirport *apt, double radius, const std::string& fltType, const std::string& acType, const std::string& airline);
+
+  double getTurnRadius(double, bool);
         
-  waypoint* createOnGround(FGAIAircraft *, const std::string& aName, const SGGeod& aPos, double aElev, double aSpeed);
-  waypoint* createInAir(FGAIAircraft *, const std::string& aName, const SGGeod& aPos, double aElev, double aSpeed);
-  waypoint* cloneWithPos(FGAIAircraft *, waypoint* aWpt, const std::string& aName, const SGGeod& aPos);
-  waypoint* clone(waypoint* aWpt);
+  FGAIWaypoint* createOnGround(FGAIAircraft *, const std::string& aName, const SGGeod& aPos, double aElev, double aSpeed);
+  FGAIWaypoint* createInAir(FGAIAircraft *, const std::string& aName, const SGGeod& aPos, double aElev, double aSpeed);
+  FGAIWaypoint* cloneWithPos(FGAIAircraft *, FGAIWaypoint* aWpt, const std::string& aName, const SGGeod& aPos);
+  FGAIWaypoint* clone(FGAIWaypoint* aWpt);
     
 
   //void createCruiseFallback(bool, FGAirport*, FGAirport*, double, double, double, double);
  void evaluateRoutePart(double deplat, double deplon, double arrlat, double arrlon);
+  
+  /**
+   * look for and parse an PropertyList flight-plan file - essentially
+   * a flat list waypoint objects, encoded to properties
+   */
+  bool parseProperties(const std::string& filename);
+  
+  void createWaypoints(FGAIAircraft *ac,
+                       double course,
+                       time_t start,
+                       FGAirport *dep,
+                       FGAirport *arr,
+                       bool firstLeg,
+                       double radius,
+                       double alt,
+                       double lat,
+                       double lon,
+                       double speed,
+                       const std::string& fltType,
+                       const std::string& acType,
+                       const std::string& airline);
+  
  public:
   wpt_vector_iterator getFirstWayPoint() { return waypoints.begin(); };
   wpt_vector_iterator getLastWayPoint()  { return waypoints.end(); };
-
-};    
+    bool isValidPlan() { return isValid; };
+};
 
 #endif  // _FG_AIFLIGHTPLAN_HXX