]> git.mxchange.org Git - flightgear.git/blobdiff - src/AIModel/AIAircraft.hxx
Merge branch 'vivian/cullsetting'
[flightgear.git] / src / AIModel / AIAircraft.hxx
index 022572563bdc9fc641b989e1880ee225c92ae738..7e65d0df51294732c4543a3dcff5c4461fc50f54 100644 (file)
@@ -16,7 +16,7 @@
 //
 // 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 Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
 #ifndef _FG_AIAircraft_HXX
 #define _FG_AIAircraft_HXX
 
 #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(FGAIManager* mgr,   FGAISchedule *ref=0);
-       ~FGAIAircraft();
-       
-       bool init();
-        virtual void bind();
-        virtual void unbind();
-       void update(double dt);
-
-        void SetPerformance(const PERF_STRUCT *ps);
-        void SetFlightPlan(FGAIFlightPlan *f);
-        FGAIFlightPlan* GetFlightPlan() { return fp; };
-        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 getGroundElev(double dt);
-  void loadNextLeg  ();
-
-  void setAcType(string ac) { acType = ac; };
-  void setCompany(string comp) { company = comp;};
-  //void setSchedule(FGAISchedule *ref) { trafficRef = ref;};
-
-        inline void SetTanker(bool setting) { isTanker = setting; };
+    FGAIAircraft(FGAISchedule *ref=0);
+    ~FGAIAircraft();
+
+    virtual void readFromScenario(SGPropertyNode* scFileNode);
+
+    // 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(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 getGroundElev(double dt); //TODO these 3 really need to be public?
+    void doGroundAltitude();
+    bool loadNextLeg  ();
+
+    void setAcType(const std::string& ac) { acType = ac; };
+    void setCompany(const std::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; };
+
+    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;
-  
-        bool hdg_lock;
-        bool alt_lock;
-        double dt_count;  
-  double dt_elev_count;
-  double headingChangeRate;
-  double groundTargetSpeed;
-  double groundOffset;
-        double dt; 
-
-        const PERF_STRUCT *performance;
-        bool use_perf_vs;
-        SGPropertyNode* refuel_node;
-        bool isTanker;
-
-       void Run(double dt);
-        double sign(double x); 
-  
-  string acType;
-  string company;
-  int spinCounter;
-  double prevSpeed;
-  double prev_dist_to_go;
-
-        bool _getGearDown() const;
-  bool reachedWaypoint;
+    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;
+
+    bool use_perf_vs;
+    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();
+
+    double sign(double x);
+
+    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;
+    bool needsTaxiClearance;
+    time_t timeElapsed;
+
+    PerformanceData* _performance; // the performance data for this aircraft
 };