Merge branch 'vivian/cullsetting'

[flightgear.git] / src / AIModel / AIAircraft.hxx

diff --git a/src/AIModel/AIAircraft.hxx b/src/AIModel/AIAircraft.hxx
index e8197667467fe270488e0b1f2e1bb3c90dc9ba02..7e65d0df51294732c4543a3dcff5c4461fc50f54 100644 (file)
--- a/src/AIModel/AIAircraft.hxx
+++ b/src/AIModel/AIAircraft.hxx
@@ -26,97 +26,136 @@
 
 #include <Traffic/SchedFlight.hxx>
 #include <Traffic/Schedule.hxx>
+#include <ATC/trafficcontrol.hxx>
 
 #include <string>
-SG_USING_STD(string);
 
+class PerformanceData;
 
 class FGAIAircraft : public FGAIBase {
 
-private:
-    typedef struct {
-        double accel;
-        double decel;
-        double climb_rate;
-        double descent_rate;
-        double takeoff_speed;
-        double climb_speed;
-        double cruise_speed;
-        double descent_speed;
-        double land_speed;
-    } PERF_STRUCT;
-
 public:
-    enum aircraft_e {LIGHT=0, WW2_FIGHTER, JET_TRANSPORT, JET_FIGHTER, TANKER};
-    static const PERF_STRUCT settings[];
-
     FGAIAircraft(FGAISchedule *ref=0);
     ~FGAIAircraft();
 
     virtual void readFromScenario(SGPropertyNode* scFileNode);
 
-    virtual bool init();
+    // virtual bool init(bool search_in_AI_path=false);
     virtual void bind();
     virtual void unbind();
     virtual void update(double dt);
 
     void setPerformance(const std::string& perfString);
-    void SetPerformance(const PERF_STRUCT *ps);
+    void setPerformance(PerformanceData *ps);
+
     void setFlightPlan(const std::string& fp, bool repat = false);
     void SetFlightPlan(FGAIFlightPlan *f);
+    void initializeFlightPlan();
     FGAIFlightPlan* GetFlightPlan() const { return fp; };
+    void ProcessFlightPlan( double dt, time_t now );
+    
     void AccelTo(double speed);
     void PitchTo(double angle);
     void RollTo(double angle);
     void YawTo(double angle);
     void ClimbTo(double altitude);
     void TurnTo(double heading);
-    void ProcessFlightPlan( double dt, time_t now );
-    void setCallSign(const string& );
-    void setTACANChannelID(const string& );
-
-    void getGroundElev(double dt);
+    
+    void getGroundElev(double dt); //TODO these 3 really need to be public?
     void doGroundAltitude();
-    void loadNextLeg  ();
+    bool loadNextLeg  ();
+
+    void setAcType(const std::string& ac) { acType = ac; };
+    void setCompany(const std::string& comp) { company = comp;};
 
-    void setAcType(const string& ac) { acType = ac; };
-    void setCompany(const string& comp) { company = comp;};
+    void announcePositionToController(); //TODO have to be public?
+    void processATC(FGATCInstruction instruction);
+    void setTaxiClearanceRequest(bool arg) { needsTaxiClearance = arg; };
+    bool getTaxiClearanceRequest() { return needsTaxiClearance; };
+    FGAISchedule * getTrafficRef() { return trafficRef; };
 
-    inline void SetTanker(bool setting) { isTanker = setting; };
     virtual const char* getTypeString(void) const { return "aircraft"; }
 
+    std::string GetTransponderCode() { return transponderCode; };
+    void SetTransponderCode(const std::string& tc) { transponderCode = tc;};
+
+    // included as performance data needs them, who else?
+    inline PerformanceData* getPerformance() { return _performance; };
+    inline bool onGround() const { return no_roll; };
+    inline double getSpeed() const { return speed; };
+    inline double getRoll() const { return roll; };
+    inline double getPitch() const { return pitch; };
+    inline double getAltitude() const { return altitude_ft; };
+    inline double getVerticalSpeed() const { return vs; };
+    inline double altitudeAGL() const { return props->getFloatValue("position/altitude-agl-ft");};
+    inline double airspeed() const { return props->getFloatValue("velocities/airspeed-kt");};
+    std::string atGate();
+    
+protected:
+    void Run(double dt);
+
 private:
     FGAISchedule *trafficRef;
+    FGATCController *controller, *prevController; 
 
     bool hdg_lock;
     bool alt_lock;
     double dt_count;
     double dt_elev_count;
     double headingChangeRate;
+    double headingError;
     double groundTargetSpeed;
     double groundOffset;
     double dt;
 
-    const PERF_STRUCT *performance;
     bool use_perf_vs;
-    SGPropertyNode* refuel_node;
-    bool isTanker;
+    SGPropertyNode_ptr refuel_node;
+
+    // helpers for Run
+    //TODO sort out which ones are better protected virtuals to allow
+    //subclasses to override specific behaviour
+    bool fpExecutable(time_t now);
+    void handleFirstWaypoint(void);
+    bool leadPointReached(FGAIFlightPlan::waypoint* curr);
+    bool handleAirportEndPoints(FGAIFlightPlan::waypoint* prev, time_t now);
+    bool aiTrafficVisible(void);
+    void controlHeading(FGAIFlightPlan::waypoint* curr);
+    void controlSpeed(FGAIFlightPlan::waypoint* curr,
+                      FGAIFlightPlan::waypoint* next);
+    
+    void updatePrimaryTargetValues(bool& flightplanActive, bool& aiOutOfSight);
+    
+    void updateSecondaryTargetValues();
+    void updatePosition();
+    void updateHeading();
+    void updateBankAngleTarget();
+    void updateVerticalSpeedTarget();
+    void updatePitchAngleTarget();
+    void updateActualState();
+    void handleATCRequests();
+    void checkVisibility();
 
-    void Run(double dt);
     double sign(double x);
 
-    string acType;
-    string company;
+    std::string acType;
+    std::string company;
+    std::string transponderCode;
 
     int spinCounter;
     double prevSpeed;
     double prev_dist_to_go;
 
+    bool holdPos;
+
     bool _getGearDown() const;
+
+    const char * _getTransponderCode() const;
+
     bool reachedWaypoint;
-    string callsign;             // The callsign of this tanker.
-    string TACAN_channel_id;     // The TACAN channel of this tanker
-    bool contact;                // set if this tanker is within fuelling range
+    bool needsTaxiClearance;
+    time_t timeElapsed;
+
+    PerformanceData* _performance; // the performance data for this aircraft
 };