src/ATC/tower.hxx

   1 // FGTower - a class to provide tower control at towered airports.
   2 //
   3 // Written by David Luff, started March 2002.
   4 //
   5 // Copyright (C) 2002  David C. Luff - david.luff@nottingham.ac.uk
   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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 #ifndef _FG_TOWER_HXX
  22 #define _FG_TOWER_HXX
  23
  24 #include <simgear/compiler.h>
  25 #include <simgear/math/point3d.hxx>
  26 #include <simgear/misc/sgstream.hxx>
  27 //#include <simgear/math/sg_geodesy.hxx>
  28 #include <plib/sg.h>
  29 //#include <Airports/runways.hxx>
  30
  31 #include STL_IOSTREAM
  32 #include STL_STRING
  33
  34 SG_USING_STD(string);
  35 SG_USING_STD(ios);
  36
  37 #include "ATC.hxx"
  38 //#include "ATCmgr.hxx"
  39 #include "ground.hxx"
  40 #include "ATCProjection.hxx"
  41 #include "AIPlane.hxx"
  42
  43 //DCL - a complete guess for now.
  44 #define FG_TOWER_DEFAULT_RANGE 30
  45
  46 enum tower_traffic_type {
  47         CIRCUIT,
  48         INBOUND,
  49         OUTBOUND,
  50         TTT_UNKNOWN,    // departure, but we don't know if for circuits or leaving properly
  51         STRAIGHT_IN
  52         // Umm - what's the difference between INBOUND and STRAIGHT_IN ?
  53 };      // TODO - need some differentiation of IFR and VFR traffic in order to give the former priority.
  54
  55 // Structure for holding details of a plane under tower control.
  56 // Not fixed yet - may include more stuff later.
  57 class TowerPlaneRec {
  58
  59 public:
  60
  61         TowerPlaneRec();
  62         TowerPlaneRec(PlaneRec p);
  63         TowerPlaneRec(Point3D pt);
  64         TowerPlaneRec(PlaneRec p, Point3D pt);
  65
  66         FGAIPlane* planePtr;    // This might move to the planeRec eventually
  67         PlaneRec plane;
  68
  69         Point3D pos;
  70         double eta;             // seconds
  71         double dist_out;        // meters from theshold
  72         bool clearedToLand;
  73         bool clearedToLineUp;
  74         bool clearedToTakeOff;
  75         // ought to add time cleared to depart so we can nag if necessary
  76         bool holdShortReported;
  77         bool longFinalReported;
  78         bool longFinalAcknowledged;
  79         bool finalReported;
  80         bool finalAcknowledged;
  81         bool onRwy;             // is physically on the runway
  82         bool nextOnRwy;         // currently projected by tower to be the next on the runway
  83
  84         double clearanceCounter;                // Hack for communication timing - counter since clearance requested in seconds
  85
  86         // Type of operation the plane is doing
  87         tower_traffic_type opType;
  88
  89         // Whereabouts in circuit if doing circuits
  90         PatternLeg leg;
  91
  92         bool isUser;    // true if this plane is the user
  93 };
  94
  95
  96 typedef list < TowerPlaneRec* > tower_plane_rec_list_type;
  97 typedef tower_plane_rec_list_type::iterator tower_plane_rec_list_iterator;
  98 typedef tower_plane_rec_list_type::const_iterator tower_plane_rec_list_const_iterator;
  99
 100
 101 class FGTower : public FGATC {
 102
 103 public:
 104
 105         FGTower();
 106         ~FGTower();
 107
 108         void Init();
 109
 110         void Update(double dt);
 111
 112         void RequestLandingClearance(string ID);
 113         void RequestDepartureClearance(string ID);
 114         void ReportFinal(string ID);
 115         void ReportLongFinal(string ID);
 116         void ReportOuterMarker(string ID);
 117         void ReportMiddleMarker(string ID);
 118         void ReportInnerMarker(string ID);
 119         void ReportGoingAround(string ID);
 120         void ReportRunwayVacated(string ID);
 121         void ReportReadyForDeparture(string ID);
 122
 123         // Contact tower when at a hold short for departure - for now we'll assume plane - maybe vehicles might want to cross runway eventually?
 124         void ContactAtHoldShort(PlaneRec plane, FGAIPlane* requestee, tower_traffic_type operation);
 125
 126         // Public interface to the active runway - this will get more complex
 127         // in the future and consider multi-runway use, airplane weight etc.
 128         inline string GetActiveRunway() { return activeRwy; }
 129         inline RunwayDetails GetActiveRunwayDetails() { return rwy; }
 130
 131         inline void SetDisplay() { display = true; }
 132         inline void SetNoDisplay() { display = false; }
 133
 134         inline string get_trans_ident() { return trans_ident; }
 135         inline atc_type GetType() { return TOWER; }
 136
 137         inline FGGround* GetGroundPtr() { return ground; }
 138
 139         // Returns true if positions of crosswind/downwind/base leg turns should be constrained by previous traffic
 140         // plus the constraint position as a rwy orientated orthopos (meters)
 141         bool GetCrosswindConstraint(double& cpos);
 142         bool GetDownwindConstraint(double& dpos);
 143         bool GetBaseConstraint(double& bpos);
 144
 145         // Returns true if OK to transmit on this frequency
 146         inline bool FreqClear() { return freqClear; }
 147         // Indicate that the frequency is in use
 148         inline void FreqInUse() { freqClear = false; }
 149         // The idea is that AI traffic or the user ATC dialog box calls FreqInUse() when they begin transmitting,
 150         // and that the tower control sets freqClear back to true following a reply.
 151         // AI traffic should check FreqClear() is true prior to transmitting.
 152         // The user will just have to wait for a gap in dialog as in real life.
 153
 154 private:
 155         FGATCMgr* ATCmgr;
 156         // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
 157
 158         // Figure out if a given position lies on the active runway
 159         // Might have to change when we consider more than one active rwy.
 160         bool OnActiveRunway(Point3D pt);
 161
 162         // Figure out if a given position lies on a runway or not
 163         bool OnAnyRunway(Point3D pt);
 164
 165         // Calculate the eta of a plane to the threshold.
 166         // For ground traffic this is the fastest they can get there.
 167         // For air traffic this is the middle approximation.
 168         void CalcETA(TowerPlaneRec* tpr);
 169
 170         // Iterate through all the lists and call CalcETA for all the planes.
 171         void doThresholdETACalc();
 172
 173         // Order the list of traffic as per expected threshold use and flag any conflicts
 174         bool doThresholdUseOrder();
 175
 176         // Calculate the crow-flys distance of a plane to the threshold in meters
 177         double CalcDistOutM(TowerPlaneRec* tpr);
 178
 179         // Calculate the crow-flys distance of a plane to the threshold in miles
 180         double CalcDistOutMiles(TowerPlaneRec* tpr);
 181
 182         void doCommunication();
 183
 184         void IssueLandingClearance(TowerPlaneRec* tpr);
 185         void IssueGoAround(TowerPlaneRec* tpr);
 186         void IssueDepartureClearance(TowerPlaneRec* tpr);
 187
 188         bool display;           // Flag to indicate whether we should be outputting to the ATC display.
 189         bool displaying;                // Flag to indicate whether we are outputting to the ATC display.
 190
 191         bool freqClear;         // Flag to indicate if the frequency is clear of ongoing dialog
 192
 193         // environment - need to make sure we're getting the surface winds and not winds aloft.
 194         SGPropertyNode* wind_from_hdg;  //degrees
 195         SGPropertyNode* wind_speed_knots;               //knots
 196
 197         double aptElev;         // Airport elevation
 198         string activeRwy;       // Active runway number - For now we'll disregard multiple / alternate runway operation.
 199         RunwayDetails rwy;      // Assumed to be the active one for now.
 200         bool rwyOccupied;       // Active runway occupied flag.  For now we'll disregard land-and-hold-short operations.
 201         FGATCAlignedProjection ortho;   // Orthogonal mapping of the local area with the active runway threshold at the origin
 202
 203         // Figure out which runways are active.
 204         // For now we'll just be simple and do one active runway - eventually this will get much more complex
 205         // This is a private function - public interface to the results of this is through GetActiveRunway
 206         void DoRwyDetails();
 207
 208         // Need a data structure to hold details of the various active planes
 209         // or possibly another data structure with the positions of the inactive planes.
 210         // Need a data structure to hold outstanding communications from aircraft.
 211
 212         // Linked-list of planes on approach to active rwy ordered with nearest first (timewise).
 213         // Includes planes that have landed but not yet vacated runway.
 214         // Somewhat analagous to the paper strips used (used to be used?) in real life.
 215         // Doesn't include planes in circuit until they turn onto base/final?
 216         // TODO - may need to alter this for operation to more than one active rwy.
 217         tower_plane_rec_list_type appList;
 218         tower_plane_rec_list_iterator appListItr;
 219
 220         // What should we do with planes approaching the airport to join the circuit somewhere
 221         // but not on straight-in though? - put them in here for now.
 222         tower_plane_rec_list_type circuitAppList;
 223         tower_plane_rec_list_iterator circuitAppListItr;
 224
 225         // List of departed planes (planes doing circuits go into circuitList not depList after departure)
 226         tower_plane_rec_list_type depList;
 227         tower_plane_rec_list_iterator depListItr;
 228
 229         // List of planes in the circuit (ordered by nearest to landing first)
 230         tower_plane_rec_list_type circuitList;
 231         tower_plane_rec_list_iterator circuitListItr;
 232
 233         // List of planes waiting to depart
 234         tower_plane_rec_list_type holdList;
 235         tower_plane_rec_list_iterator holdListItr;
 236
 237         // List of planes on rwy
 238         tower_plane_rec_list_type rwyList;
 239         tower_plane_rec_list_iterator rwyListItr;
 240
 241         // List of all planes due to use a given rwy arranged in projected order of rwy use
 242         tower_plane_rec_list_type trafficList;  // TODO - needs to be expandable to more than one rwy
 243         tower_plane_rec_list_iterator trafficListItr;
 244
 245         // Returns true if successful
 246         bool RemoveFromTrafficList(string id);
 247
 248         // Return the ETA of plane no. list_pos (1-based) in the traffic list.
 249         // i.e. list_pos = 1 implies next to use runway.
 250         double GetTrafficETA(unsigned int list_pos);
 251
 252         // Add a tower plane rec with ETA to the traffic list in the correct position ETA-wise.
 253         // Returns true if this could cause a threshold ETA conflict with other traffic, false otherwise.
 254         bool AddToTrafficList(TowerPlaneRec* t, bool holding = false);
 255
 256         // Ground can be separate or handled by tower in real life.
 257         // In the program we will always use a separate FGGround class, but we need to know
 258         // whether it is supposed to be separate or not to give the correct instructions.
 259         bool separateGround;    // true if ground control is separate
 260         FGGround* ground;       // The ground control associated with this airport.
 261
 262         // for failure modeling
 263         string trans_ident;             // transmitted ident
 264         bool tower_failed;              // tower failed?
 265
 266         // Pointers to current users position and orientation
 267         SGPropertyNode* user_lon_node;
 268         SGPropertyNode* user_lat_node;
 269         SGPropertyNode* user_elev_node;
 270         SGPropertyNode* user_hdg_node;
 271
 272         // Details of the general traffic flow etc in the circuit
 273         double crosswind_leg_pos;       // Distance from threshold crosswind leg is being turned to in meters (actual operation - *not* ideal circuit)
 274         double downwind_leg_pos;        // Actual offset distance in meters from the runway that planes are flying the downwind leg
 275         // Currently not sure whether the above should be always +ve or just take the natural orthopos sign (+ve for RH circuit, -ve for LH).
 276         double base_leg_pos;            // Actual offset distance from the threshold (-ve) that planes are turning to base leg.
 277
 278         friend istream& operator>> ( istream&, FGTower& );
 279 };
 280
 281 #endif  //_FG_TOWER_HXX