src/AIModel/AIAircraft.hxx

   1 // FGAIAircraft - AIBase derived class creates an AI aircraft
   2 //
   3 // Written by David Culp, started October 2003.
   4 //
   5 // Copyright (C) 2003  David P. Culp - davidculp2@comcast.net
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20
  21 #ifndef _FG_AIAircraft_HXX
  22 #define _FG_AIAircraft_HXX
  23
  24 #include "AIManager.hxx"
  25 #include "AIBase.hxx"
  26
  27 #include <Traffic/SchedFlight.hxx>
  28 #include <Traffic/Schedule.hxx>
  29 #include <ATC/trafficcontrol.hxx>
  30
  31 #include <string>
  32 using std::string;
  33
  34 class PerformanceData;
  35
  36 class FGAIAircraft : public FGAIBase {
  37
  38 public:
  39     FGAIAircraft(FGAISchedule *ref=0);
  40     ~FGAIAircraft();
  41
  42     virtual void readFromScenario(SGPropertyNode* scFileNode);
  43
  44     // virtual bool init(bool search_in_AI_path=false);
  45     virtual void bind();
  46     virtual void unbind();
  47     virtual void update(double dt);
  48
  49     void setPerformance(const std::string& perfString);
  50     void setPerformance(PerformanceData *ps);
  51
  52     void setFlightPlan(const std::string& fp, bool repat = false);
  53     void SetFlightPlan(FGAIFlightPlan *f);
  54     void initializeFlightPlan();
  55     FGAIFlightPlan* GetFlightPlan() const { return fp; };
  56     void ProcessFlightPlan( double dt, time_t now );
  57
  58     void AccelTo(double speed);
  59     void PitchTo(double angle);
  60     void RollTo(double angle);
  61     void YawTo(double angle);
  62     void ClimbTo(double altitude);
  63     void TurnTo(double heading);
  64
  65     void getGroundElev(double dt); //TODO these 3 really need to be public?
  66     void doGroundAltitude();
  67     bool loadNextLeg  ();
  68
  69     void setAcType(const string& ac) { acType = ac; };
  70     void setCompany(const string& comp) { company = comp;};
  71
  72     void announcePositionToController(); //TODO have to be public?
  73     void processATC(FGATCInstruction instruction);
  74     FGAISchedule * getTrafficRef() { return trafficRef; };
  75
  76     virtual const char* getTypeString(void) const { return "aircraft"; }
  77
  78     // included as performance data needs them, who else?
  79     inline PerformanceData* getPerformance() { return _performance; };
  80     inline bool onGround() const { return no_roll; };
  81     inline double getSpeed() const { return speed; };
  82     inline double getRoll() const { return roll; };
  83     inline double getPitch() const { return pitch; };
  84     inline double getAltitude() const { return altitude_ft; };
  85     inline double getVerticalSpeed() const { return vs; };
  86     inline double altitudeAGL() const { return props->getFloatValue("position/altitude-agl-ft");};
  87     inline double airspeed() const { return props->getFloatValue("velocities/airspeed-kt");};
  88     string atGate();
  89
  90 protected:
  91     void Run(double dt);
  92
  93 private:
  94     FGAISchedule *trafficRef;
  95     FGATCController *controller, *prevController;
  96
  97     bool hdg_lock;
  98     bool alt_lock;
  99     double dt_count;
 100     double dt_elev_count;
 101     double headingChangeRate;
 102     double headingError;
 103     double groundTargetSpeed;
 104     double groundOffset;
 105     double dt;
 106
 107     bool use_perf_vs;
 108     SGPropertyNode_ptr refuel_node;
 109
 110     // helpers for Run
 111     //TODO sort out which ones are better protected virtuals to allow
 112     //subclasses to override specific behaviour
 113     bool fpExecutable(time_t now);
 114     void handleFirstWaypoint(void);
 115     bool leadPointReached(FGAIFlightPlan::waypoint* curr);
 116     bool handleAirportEndPoints(FGAIFlightPlan::waypoint* prev, time_t now);
 117     bool aiTrafficVisible(void);
 118     void controlHeading(FGAIFlightPlan::waypoint* curr);
 119     void controlSpeed(FGAIFlightPlan::waypoint* curr,
 120                       FGAIFlightPlan::waypoint* next);
 121     void updatePrimaryTargetValues();
 122     void updateSecondaryTargetValues();
 123     void updatePosition();
 124     void updateHeading();
 125     void updateBankAngleTarget();
 126     void updateVerticalSpeedTarget();
 127     void updatePitchAngleTarget();
 128     void updateActualState();
 129     void handleATCRequests();
 130     void checkVisibility();
 131
 132     double sign(double x);
 133
 134     string acType;
 135     string company;
 136
 137     int spinCounter;
 138     double prevSpeed;
 139     double prev_dist_to_go;
 140
 141     bool holdPos;
 142
 143     bool _getGearDown() const;
 144
 145     bool reachedWaypoint;
 146     time_t timeElapsed;
 147
 148     PerformanceData* _performance; // the performance data for this aircraft
 149 };
 150
 151
 152 #endif  // _FG_AIAircraft_HXX