1 // FGAIAircraft - AIBase derived class creates an AI aircraft
3 // Written by David Culp, started October 2003.
5 // Copyright (C) 2003 David P. Culp - davidculp2@comcast.net
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.
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.
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.
21 #ifndef _FG_AIAircraft_HXX
22 #define _FG_AIAircraft_HXX
24 #include "AIManager.hxx"
27 #include <Traffic/SchedFlight.hxx>
28 #include <Traffic/Schedule.hxx>
29 #include <ATC/trafficcontrol.hxx>
33 class PerformanceData;
35 class FGAIAircraft : public FGAIBase {
38 FGAIAircraft(FGAISchedule *ref=0);
41 virtual void readFromScenario(SGPropertyNode* scFileNode);
43 // virtual bool init(bool search_in_AI_path=false);
45 virtual void unbind();
46 virtual void update(double dt);
48 void setPerformance(const std::string& perfString);
49 void setPerformance(PerformanceData *ps);
51 void setFlightPlan(const std::string& fp, bool repat = false);
52 void SetFlightPlan(FGAIFlightPlan *f);
53 void initializeFlightPlan();
54 FGAIFlightPlan* GetFlightPlan() const { return fp; };
55 void ProcessFlightPlan( double dt, time_t now );
57 void AccelTo(double speed);
58 void PitchTo(double angle);
59 void RollTo(double angle);
60 void YawTo(double angle);
61 void ClimbTo(double altitude);
62 void TurnTo(double heading);
64 void getGroundElev(double dt); //TODO these 3 really need to be public?
65 void doGroundAltitude();
68 void setAcType(const std::string& ac) { acType = ac; };
69 void setCompany(const std::string& comp) { company = comp;};
71 void announcePositionToController(); //TODO have to be public?
72 void processATC(FGATCInstruction instruction);
73 void setTaxiClearanceRequest(bool arg) { needsTaxiClearance = arg; };
74 bool getTaxiClearanceRequest() { return needsTaxiClearance; };
75 FGAISchedule * getTrafficRef() { return trafficRef; };
77 virtual const char* getTypeString(void) const { return "aircraft"; }
79 std::string GetTransponderCode() { return transponderCode; };
80 void SetTransponderCode(const std::string& tc) { transponderCode = tc;};
82 // included as performance data needs them, who else?
83 inline PerformanceData* getPerformance() { return _performance; };
84 inline bool onGround() const { return no_roll; };
85 inline double getSpeed() const { return speed; };
86 inline double getRoll() const { return roll; };
87 inline double getPitch() const { return pitch; };
88 inline double getAltitude() const { return altitude_ft; };
89 inline double getVerticalSpeed() const { return vs; };
90 inline double altitudeAGL() const { return props->getFloatValue("position/altitude-agl-ft");};
91 inline double airspeed() const { return props->getFloatValue("velocities/airspeed-kt");};
98 FGAISchedule *trafficRef;
99 FGATCController *controller, *prevController;
104 double dt_elev_count;
105 double headingChangeRate;
107 double groundTargetSpeed;
112 SGPropertyNode_ptr refuel_node;
115 //TODO sort out which ones are better protected virtuals to allow
116 //subclasses to override specific behaviour
117 bool fpExecutable(time_t now);
118 void handleFirstWaypoint(void);
119 bool leadPointReached(FGAIFlightPlan::waypoint* curr);
120 bool handleAirportEndPoints(FGAIFlightPlan::waypoint* prev, time_t now);
121 bool aiTrafficVisible(void);
122 void controlHeading(FGAIFlightPlan::waypoint* curr);
123 void controlSpeed(FGAIFlightPlan::waypoint* curr,
124 FGAIFlightPlan::waypoint* next);
126 void updatePrimaryTargetValues(bool& flightplanActive, bool& aiOutOfSight);
128 void updateSecondaryTargetValues();
129 void updatePosition();
130 void updateHeading();
131 void updateBankAngleTarget();
132 void updateVerticalSpeedTarget();
133 void updatePitchAngleTarget();
134 void updateActualState();
135 void handleATCRequests();
136 void checkVisibility();
138 double sign(double x);
142 std::string transponderCode;
146 double prev_dist_to_go;
150 bool _getGearDown() const;
152 const char * _getTransponderCode() const;
154 bool reachedWaypoint;
155 bool needsTaxiClearance;
158 PerformanceData* _performance; // the performance data for this aircraft
162 #endif // _FG_AIAircraft_HXX