src/ATCDCL/AILocalTraffic.hxx

   1 // FGAILocalTraffic - AIEntity derived class with enough logic to
   2 // fly and interact with the traffic pattern.
   3 //
   4 // Written by David Luff, started March 2002.
   5 //
   6 // Copyright (C) 2002  David C. Luff - david.luff@nottingham.ac.uk
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21
  22 #ifndef _FG_AILocalTraffic_HXX
  23 #define _FG_AILocalTraffic_HXX
  24
  25 #include <simgear/math/point3d.hxx>
  26 #include <Main/fg_props.hxx>
  27
  28 #include "AIPlane.hxx"
  29 #include "ATCProjection.hxx"
  30 #include "ground.hxx"
  31
  32 class FGGround;
  33 class FGTower;
  34 struct Gate;
  35
  36 #include <string>
  37 using std::string;
  38
  39 enum TaxiState {
  40         TD_INBOUND,
  41         TD_OUTBOUND,
  42         TD_NONE,
  43         TD_LINING_UP
  44 };
  45
  46 enum OperatingState {
  47         IN_PATTERN,
  48         TAXIING,
  49         PARKED,
  50         EN_ROUTE
  51 };
  52
  53 struct StartOfDescent {
  54         PatternLeg leg;
  55         double x;       // Runway aligned orthopos
  56         double y;       // ditto
  57 };
  58
  59 class FGAILocalTraffic : public FGAIPlane {
  60
  61 public:
  62
  63         // At the moment we expect the expanded short form callsign - eventually we will just want the reg + type.
  64         FGAILocalTraffic();
  65         ~FGAILocalTraffic();
  66
  67         // Initialise
  68         bool Init(const string& callsign, const string& ICAO, OperatingState initialState = PARKED, PatternLeg initialLeg = DOWNWIND);
  69
  70         // Run the internal calculations
  71         void Update(double dt);
  72
  73         // Go out and practice circuits
  74         void FlyCircuits(int numCircuits, bool tag);
  75
  76         // Return what type of landing we're doing on this circuit
  77         LandingType GetLandingOption();
  78
  79         // TODO - this will get more complex and moved into the main class
  80         // body eventually since the position approved to taxi to will have
  81         // to be passed.
  82         inline void ApproveTaxiRequest() {taxiRequestCleared = true;}
  83
  84         inline void DenyTaxiRequest() {taxiRequestCleared = false;}
  85
  86         void RegisterTransmission(int code);
  87
  88         // Process callbacks sent by base class
  89         // (These codes are not related to the codes above)
  90         void ProcessCallback(int code);
  91
  92         // This is a hack and will probably go eventually
  93         inline bool AtHoldShort() {return holdingShort;}
  94
  95 protected:
  96
  97         // Attempt to enter the traffic pattern in a reasonably intelligent manner
  98         void EnterTrafficPattern(double dt);
  99
 100         // Set up the internal state to be consistent for a downwind entry.
 101         void DownwindEntry();
 102
 103         // Ditto for straight-in
 104         void StraightInEntry(bool des = false);
 105
 106         // Do what is necessary to land and parkup at home airport
 107         void ReturnToBase(double dt);
 108
 109         // Airport/runway/pattern details
 110         string airportID;       // The ICAO code of the airport that we're operating around
 111         double aptElev;         // Airport elevation
 112         FGGround* ground;       // A pointer to the ground control.
 113         FGTower* tower; // A pointer to the tower control.
 114         bool _controlled;       // Set true if we find tower control working for the airport, false otherwise.
 115         RunwayDetails rwy;
 116         double patternDirection;        // 1 for right, -1 for left (This is double because we multiply/divide turn rates
 117         // with it to get RH/LH turns - DON'T convert it to int under ANY circumstances!!
 118         double glideAngle;              // Assumed to be visual glidepath angle for FGAILocalTraffic - can be found at www.airnav.com
 119         // Its conceivable that patternDirection and glidePath could be moved into the RunwayDetails structure.
 120
 121         // Its possible that this might be moved out to the ground/airport class at some point.
 122         FGATCAlignedProjection ortho;   // Orthogonal mapping of the local area with the threshold at the origin
 123         // and the runway aligned with the y axis.
 124
 125         void GetAirportDetails(const string& id);
 126
 127         void GetRwyDetails(const string& id);
 128
 129         double responseCounter;         // timer in seconds to allow response to requests to be a little while after them
 130         // Will almost certainly get moved to FGAIPlane.
 131
 132 private:
 133         FGATCMgr* ATC;
 134         // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
 135
 136         // High-level stuff
 137         OperatingState operatingState;
 138         int circuitsToFly;      //Number of circuits still to do in this session NOT INCLUDING THE CURRENT ONE
 139         bool touchAndGo;        //True if circuits should be flown touch and go, false for full stop
 140         bool transmitted;       // Set true when a position report for the current leg has been transmitted.
 141
 142         // Performance characteristics of the plane in knots and ft/min - some of this might get moved out into FGAIPlane
 143         double Vr;
 144         double best_rate_of_climb_speed;
 145         double best_rate_of_climb;
 146         double nominal_climb_speed;
 147         double nominal_climb_rate;
 148         double nominal_circuit_speed;
 149         double min_circuit_speed;
 150         double max_circuit_speed;
 151         double nominal_descent_rate;
 152         double nominal_approach_speed;
 153         double nominal_final_speed;
 154         double stall_speed_landing_config;
 155         double nominal_taxi_speed;
 156
 157         // Physical/rendering stuff
 158         double wheelOffset;             // Height above ground at which we need to render the plane whilst taxiing
 159         bool elevInitGood;              // We have had at least one good elev reading
 160         bool inAir;                             // True when off the ground
 161
 162         // environment - some of this might get moved into FGAIPlane
 163         SGPropertyNode_ptr wind_from_hdg;       //degrees
 164         SGPropertyNode_ptr wind_speed_knots;            //knots
 165
 166         // Pattern details that (may) change
 167         int numInPattern;               // Number of planes in the pattern (this might get more complicated if high performance GA aircraft fly a higher pattern eventually)
 168         int numAhead;           // More importantly - how many of them are ahead of us?
 169         double distToNext;              // And even more importantly, how near are we getting to the one immediately ahead?
 170         //PatternLeg leg;               // Our current position in the pattern - now moved to FGAIPlane
 171         StartOfDescent SoD;             // Start of descent calculated wrt wind, pattern size & altitude, glideslope etc
 172         bool descending;                // We're in the coming down phase of the pattern
 173         double targetDescentRate;       // m/s
 174
 175         // Taxiing details
 176         // At the moment this assumes that all taxiing in is to gates (a loose term that includes
 177         // any permitted parking spot) and that all taxiing out is to runways.
 178         bool parked;
 179         bool taxiing;
 180         bool taxiRequestPending;
 181         bool taxiRequestCleared;
 182         TaxiState taxiState;
 183         double desiredTaxiHeading;
 184         double taxiTurnRadius;
 185         double nominalTaxiSpeed;
 186         Gate* ourGate;
 187         ground_network_path_type path;  // a path through the ground network for the plane to taxi
 188         unsigned int taxiPathPos;       // position of iterator in taxi path when applicable
 189         node* nextTaxiNode;     // next node in taxi path
 190         node* holdShortNode;
 191         //Runway out_dest; //FIXME - implement this
 192         bool holdingShort;
 193         bool reportReadyForDeparture;   // set true when ATC has requested that the plane report when ready for departure
 194         bool clearedToLineUp;
 195         bool clearedToTakeOff;
 196         bool _clearedToLand;    // also implies cleared for the option.
 197         bool liningUp;  // Set true when the turn onto the runway heading is commenced when taxiing out
 198         bool goAround;  // Set true if need to go-around
 199         bool goAroundCalled;    // Set true during go-around only after we have called our go-around on the radio
 200         bool contactTower;      // we have been told to contact tower
 201         bool contactGround;     // we have been told to contact ground
 202         bool changeFreq;        // true when we need to change frequency
 203         bool _taxiToGA;         // Temporary mega-hack indicating we are to taxi to the GA parking and disconnect from tower control.
 204         bool _removeSelf;       // Indicates that we wish to remove this instance.  The use of a variable is a hack to allow time for messages to purge before removal, due to the fagility of the current dialog system.
 205         atc_type changeFreqType;        // the service we need to change to
 206         bool freeTaxi;  // False if the airport has a facilities file with a logical taxi network defined, true if we need to calculate our own taxiing points.
 207
 208         // Hack for getting close to the runway when atan can go pear-shaped
 209         double _savedSlope;
 210
 211         void FlyTrafficPattern(double dt);
 212
 213         // TODO - need to add something to define what option we are flying - Touch and go / Stop and go / Landing properly / others?
 214
 215         void TransmitPatternPositionReport();
 216
 217         void CalculateSoD(double base_leg_pos, double downwind_leg_pos, bool pattern_direction);
 218
 219         void ExitRunway(const Point3D& orthopos);
 220
 221         void StartTaxi();
 222
 223         void Taxi(double dt);
 224
 225         void GetNextTaxiNode();
 226
 227         void DoGroundElev();
 228
 229         // Set when the plane should be invisible *regardless of distance from user*.
 230         bool _invisible;
 231 };
 232
 233 #endif  // _FG_AILocalTraffic_HXX