1 // FGTower - a class to provide tower control at towered airports.
3 // Written by David Luff, started March 2002.
5 // Copyright (C) 2002 David C. Luff - david.luff@nottingham.ac.uk
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., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <simgear/compiler.h>
25 #include <simgear/math/point3d.hxx>
26 #include <simgear/misc/sgstream.hxx>
27 //#include <simgear/math/sg_geodesy.hxx>
29 //#include <Airports/runways.hxx>
38 //#include "ATCmgr.hxx"
40 #include "ATCProjection.hxx"
41 #include "AIPlane.hxx"
43 //DCL - a complete guess for now.
44 #define FG_TOWER_DEFAULT_RANGE 30
46 enum tower_traffic_type {
48 INBOUND, // CIRCUIT traffic gets changed to INBOUND when on final of the full-stop circuit.
50 TTT_UNKNOWN, // departure, but we don't know if for circuits or leaving properly
54 ostream& operator << (ostream& os, tower_traffic_type ttt);
56 enum tower_callback_type {
57 USER_REQUEST_DEPARTURE = 1,
58 USER_REQUEST_ARRIVAL = 2
61 // TODO - need some differentiation of IFR and VFR traffic in order to give the former priority.
63 // Structure for holding details of a plane under tower control.
64 // Not fixed yet - may include more stuff later.
70 TowerPlaneRec(PlaneRec p);
71 TowerPlaneRec(Point3D pt);
72 TowerPlaneRec(PlaneRec p, Point3D pt);
74 FGAIPlane* planePtr; // This might move to the planeRec eventually
78 double eta; // seconds
79 double dist_out; // meters from theshold
82 bool clearedToTakeOff;
83 // ought to add time cleared to depart so we can nag if necessary
84 bool holdShortReported;
85 bool downwindReported;
86 bool longFinalReported;
87 bool longFinalAcknowledged;
89 bool finalAcknowledged;
90 bool instructedToGoAround; // set true if told by tower to go around
91 bool onRwy; // is physically on the runway
92 bool nextOnRwy; // currently projected by tower to be the next on the runway
94 // Type of operation the plane is doing
95 tower_traffic_type opType;
97 // Whereabouts in circuit if doing circuits
100 LandingType landingType;
102 bool isUser; // true if this plane is the user
106 typedef list < TowerPlaneRec* > tower_plane_rec_list_type;
107 typedef tower_plane_rec_list_type::iterator tower_plane_rec_list_iterator;
108 typedef tower_plane_rec_list_type::const_iterator tower_plane_rec_list_const_iterator;
111 class FGTower : public FGATC {
120 void Update(double dt);
122 void ReceiveUserCallback(int code);
124 void RequestLandingClearance(string ID);
125 void RequestDepartureClearance(string ID);
126 void ReportFinal(string ID);
127 void ReportLongFinal(string ID);
128 void ReportOuterMarker(string ID);
129 void ReportMiddleMarker(string ID);
130 void ReportInnerMarker(string ID);
131 void ReportGoingAround(string ID);
132 void ReportRunwayVacated(string ID);
133 void ReportReadyForDeparture(string ID);
134 void ReportDownwind(string ID);
136 // Contact tower when at a hold short for departure - for now we'll assume plane - maybe vehicles might want to cross runway eventually?
137 void ContactAtHoldShort(PlaneRec plane, FGAIPlane* requestee, tower_traffic_type operation);
139 // Register the presence of an AI plane at a point where contact would already have been made in real life
140 // CAUTION - currently it is assumed that this plane's callsign is unique - it is up to AIMgr to generate unique callsigns.
141 void RegisterAIPlane(PlaneRec plane, FGAIPlane* ai, tower_traffic_type op, PatternLeg lg = LEG_UNKNOWN);
143 // Public interface to the active runway - this will get more complex
144 // in the future and consider multi-runway use, airplane weight etc.
145 inline string GetActiveRunway() { return activeRwy; }
146 inline RunwayDetails GetActiveRunwayDetails() { return rwy; }
148 inline void SetDisplay() { display = true; }
149 inline void SetNoDisplay() { display = false; }
151 inline string get_trans_ident() { return trans_ident; }
152 inline atc_type GetType() { return TOWER; }
154 inline FGGround* GetGroundPtr() { return ground; }
156 // Returns true if positions of crosswind/downwind/base leg turns should be constrained by previous traffic
157 // plus the constraint position as a rwy orientated orthopos (meters)
158 bool GetCrosswindConstraint(double& cpos);
159 bool GetDownwindConstraint(double& dpos);
160 bool GetBaseConstraint(double& bpos);
164 // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
166 // Respond to a transmission
169 void CheckHoldList(double dt);
171 void CheckCircuitList(double dt);
173 void CheckRunwayList(double dt);
175 void CheckApproachList(double dt);
177 // Currently this assumes we *are* next on the runway and doesn't check for planes about to land -
178 // this should be done prior to calling this function.
179 void ClearHoldingPlane(TowerPlaneRec* t);
181 // Find a pointer to plane of callsign ID within the internal data structures
182 TowerPlaneRec* FindPlane(string ID);
184 // Figure out if a given position lies on the active runway
185 // Might have to change when we consider more than one active rwy.
186 bool OnActiveRunway(Point3D pt);
188 // Figure out if a given position lies on a runway or not
189 bool OnAnyRunway(Point3D pt);
191 // Calculate the eta of a plane to the threshold.
192 // For ground traffic this is the fastest they can get there.
193 // For air traffic this is the middle approximation.
194 void CalcETA(TowerPlaneRec* tpr, bool printout = false);
196 // Iterate through all the lists and call CalcETA for all the planes.
197 void doThresholdETACalc();
199 // Order the list of traffic as per expected threshold use and flag any conflicts
200 bool doThresholdUseOrder();
202 // Calculate the crow-flys distance of a plane to the threshold in meters
203 double CalcDistOutM(TowerPlaneRec* tpr);
205 // Calculate the crow-flys distance of a plane to the threshold in miles
206 double CalcDistOutMiles(TowerPlaneRec* tpr);
209 void doCommunication();
212 void IssueLandingClearance(TowerPlaneRec* tpr);
213 void IssueGoAround(TowerPlaneRec* tpr);
214 void IssueDepartureClearance(TowerPlaneRec* tpr);
216 unsigned int update_count; // Convienince counter for speading computational load over several updates
217 unsigned int update_count_max; // ditto.
219 bool display; // Flag to indicate whether we should be outputting to the ATC display.
220 bool displaying; // Flag to indicate whether we are outputting to the ATC display.
222 double timeSinceLastDeparture; // Time in seconds since last departure from active rwy.
223 bool departed; // set true when the above needs incrementing with time, false when it doesn't.
225 // environment - need to make sure we're getting the surface winds and not winds aloft.
226 SGPropertyNode* wind_from_hdg; //degrees
227 SGPropertyNode* wind_speed_knots; //knots
229 double aptElev; // Airport elevation
230 string activeRwy; // Active runway number - For now we'll disregard multiple / alternate runway operation.
231 RunwayDetails rwy; // Assumed to be the active one for now.
232 bool rwyOccupied; // Active runway occupied flag. For now we'll disregard land-and-hold-short operations.
233 FGATCAlignedProjection ortho; // Orthogonal mapping of the local area with the active runway threshold at the origin
235 // Figure out which runways are active.
236 // For now we'll just be simple and do one active runway - eventually this will get much more complex
237 // This is a private function - public interface to the results of this is through GetActiveRunway
240 // Need a data structure to hold details of the various active planes
241 // or possibly another data structure with the positions of the inactive planes.
242 // Need a data structure to hold outstanding communications from aircraft.
244 // Linked-list of planes on approach to active rwy ordered with nearest first (timewise).
245 // Includes planes that have landed but not yet vacated runway.
246 // Somewhat analagous to the paper strips used (used to be used?) in real life.
247 // Doesn't include planes in circuit until they turn onto base/final?
248 // TODO - may need to alter this for operation to more than one active rwy.
249 tower_plane_rec_list_type appList;
250 tower_plane_rec_list_iterator appListItr;
252 // What should we do with planes approaching the airport to join the circuit somewhere
253 // but not on straight-in though? - put them in here for now.
254 tower_plane_rec_list_type circuitAppList;
255 tower_plane_rec_list_iterator circuitAppListItr;
257 // List of departed planes (planes doing circuits go into circuitList not depList after departure)
258 tower_plane_rec_list_type depList;
259 tower_plane_rec_list_iterator depListItr;
261 // List of planes in the circuit (ordered by nearest to landing first)
262 tower_plane_rec_list_type circuitList;
263 tower_plane_rec_list_iterator circuitListItr;
265 // List of planes waiting to depart
266 tower_plane_rec_list_type holdList;
267 tower_plane_rec_list_iterator holdListItr;
269 // List of planes on rwy
270 tower_plane_rec_list_type rwyList;
271 tower_plane_rec_list_iterator rwyListItr;
273 // List of all planes due to use a given rwy arranged in projected order of rwy use
274 tower_plane_rec_list_type trafficList; // TODO - needs to be expandable to more than one rwy
275 tower_plane_rec_list_iterator trafficListItr;
277 // Returns true if successful
278 bool RemoveFromTrafficList(string id);
280 // Return the ETA of plane no. list_pos (1-based) in the traffic list.
281 // i.e. list_pos = 1 implies next to use runway.
282 double GetTrafficETA(unsigned int list_pos, bool printout = false);
284 // Add a tower plane rec with ETA to the traffic list in the correct position ETA-wise.
285 // Returns true if this could cause a threshold ETA conflict with other traffic, false otherwise.
286 bool AddToTrafficList(TowerPlaneRec* t, bool holding = false);
288 bool AddToCircuitList(TowerPlaneRec* t);
290 // Ground can be separate or handled by tower in real life.
291 // In the program we will always use a separate FGGround class, but we need to know
292 // whether it is supposed to be separate or not to give the correct instructions.
293 bool separateGround; // true if ground control is separate
294 FGGround* ground; // The ground control associated with this airport.
296 // for failure modeling
297 string trans_ident; // transmitted ident
298 bool tower_failed; // tower failed?
300 // Pointers to current users position and orientation
301 SGPropertyNode* user_lon_node;
302 SGPropertyNode* user_lat_node;
303 SGPropertyNode* user_elev_node;
304 SGPropertyNode* user_hdg_node;
306 // Details of the general traffic flow etc in the circuit
307 double crosswind_leg_pos; // Distance from threshold crosswind leg is being turned to in meters (actual operation - *not* ideal circuit)
308 double downwind_leg_pos; // Actual offset distance in meters from the runway that planes are flying the downwind leg
309 // Currently not sure whether the above should be always +ve or just take the natural orthopos sign (+ve for RH circuit, -ve for LH).
310 double base_leg_pos; // Actual offset distance from the threshold (-ve) that planes are turning to base leg.
312 double nominal_crosswind_leg_pos;
313 double nominal_downwind_leg_pos;
314 double nominal_base_leg_pos;
316 friend istream& operator>> ( istream&, FGTower& );
319 #endif //_FG_TOWER_HXX