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_VFR_DEPARTURE = 1,
58 USER_REQUEST_VFR_ARRIVAL = 2,
59 USER_REQUEST_VFR_ARRIVAL_FULL_STOP = 3,
60 USER_REQUEST_VFR_ARRIVAL_TOUCH_AND_GO = 4,
61 USER_REPORT_3_MILE_FINAL = 5,
62 USER_REPORT_DOWNWIND = 6,
63 USER_REPORT_RWY_VACATED = 7,
64 USER_REPORT_GOING_AROUND = 8
67 // TODO - need some differentiation of IFR and VFR traffic in order to give the former priority.
69 // Structure for holding details of a plane under tower control.
70 // Not fixed yet - may include more stuff later.
76 TowerPlaneRec(PlaneRec p);
77 TowerPlaneRec(Point3D pt);
78 TowerPlaneRec(PlaneRec p, Point3D pt);
80 FGAIPlane* planePtr; // This might move to the planeRec eventually
84 double eta; // seconds
85 double dist_out; // meters from theshold
88 bool clearedToTakeOff;
89 // ought to add time cleared to depart so we can nag if necessary
90 bool holdShortReported;
91 bool downwindReported;
92 bool longFinalReported;
93 bool longFinalAcknowledged;
95 bool finalAcknowledged;
96 bool rwyVacatedReported;
97 bool rwyVacatedAcknowledged;
98 bool goAroundReported; // set true if plane informs tower that it's going around.
99 bool instructedToGoAround; // set true if plane told by tower to go around.
100 bool onRwy; // is physically on the runway
101 bool nextOnRwy; // currently projected by tower to be the next on the runway
103 bool vfrArrivalReported;
104 bool vfrArrivalAcknowledged;
106 // Type of operation the plane is doing
107 tower_traffic_type opType;
109 // Whereabouts in circuit if doing circuits
112 LandingType landingType;
114 bool isUser; // true if this plane is the user
118 typedef list < TowerPlaneRec* > tower_plane_rec_list_type;
119 typedef tower_plane_rec_list_type::iterator tower_plane_rec_list_iterator;
120 typedef tower_plane_rec_list_type::const_iterator tower_plane_rec_list_const_iterator;
123 class FGTower : public FGATC {
132 void Update(double dt);
134 void ReceiveUserCallback(int code);
136 // Contact tower for VFR approach
137 // eg "Cessna Charlie Foxtrot Golf Foxtrot Sierra eight miles South of the airport for full stop with Bravo"
138 // This function probably only called via user interaction - AI planes will have an overloaded function taking a planerec.
139 void VFRArrivalContact(string ID, LandingType opt = AIP_LT_UNKNOWN);
140 // For the AI planes...
141 void VFRArrivalContact(PlaneRec plane, FGAIPlane* requestee, LandingType lt = AIP_LT_UNKNOWN);
143 void RequestDepartureClearance(string ID);
144 void ReportFinal(string ID);
145 void ReportLongFinal(string ID);
146 void ReportOuterMarker(string ID);
147 void ReportMiddleMarker(string ID);
148 void ReportInnerMarker(string ID);
149 void ReportRunwayVacated(string ID);
150 void ReportReadyForDeparture(string ID);
151 void ReportDownwind(string ID);
152 void ReportGoingAround(string ID);
154 // Contact tower when at a hold short for departure - for now we'll assume plane - maybe vehicles might want to cross runway eventually?
155 void ContactAtHoldShort(PlaneRec plane, FGAIPlane* requestee, tower_traffic_type operation);
157 // Register the presence of an AI plane at a point where contact would already have been made in real life
158 // CAUTION - currently it is assumed that this plane's callsign is unique - it is up to AIMgr to generate unique callsigns.
159 void RegisterAIPlane(PlaneRec plane, FGAIPlane* ai, tower_traffic_type op, PatternLeg lg = LEG_UNKNOWN);
161 // Deregister and remove an AI plane.
162 void DeregisterAIPlane(string id);
164 // Public interface to the active runway - this will get more complex
165 // in the future and consider multi-runway use, airplane weight etc.
166 inline string GetActiveRunway() { return activeRwy; }
167 inline RunwayDetails GetActiveRunwayDetails() { return rwy; }
168 // Get the pattern direction of the active rwy.
169 inline int GetPatternDirection() { return rwy.patternDirection; }
171 inline void SetDisplay() { display = true; }
172 inline void SetNoDisplay() { display = false; }
174 inline string get_trans_ident() { return trans_ident; }
176 inline FGGround* GetGroundPtr() { return ground; }
178 // Returns true if positions of crosswind/downwind/base leg turns should be constrained by previous traffic
179 // plus the constraint position as a rwy orientated orthopos (meters)
180 bool GetCrosswindConstraint(double& cpos);
181 bool GetDownwindConstraint(double& dpos);
182 bool GetBaseConstraint(double& bpos);
184 string GenText(const string& m, int c);
188 // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
190 // Respond to a transmission
193 void ProcessRunwayVacatedReport(TowerPlaneRec* t);
195 // Remove all options from the user dialog choice
196 void RemoveAllUserDialogOptions();
198 // Periodic checks on the various traffic.
199 void CheckHoldList(double dt);
200 void CheckCircuitList(double dt);
201 void CheckRunwayList(double dt);
202 void CheckApproachList(double dt);
203 void CheckDepartureList(double dt);
205 // Currently this assumes we *are* next on the runway and doesn't check for planes about to land -
206 // this should be done prior to calling this function.
207 void ClearHoldingPlane(TowerPlaneRec* t);
209 // Find a pointer to plane of callsign ID within the internal data structures
210 TowerPlaneRec* FindPlane(string ID);
212 // Remove and delete all instances of a plane with a given ID
213 void RemovePlane(string ID);
215 // Figure out if a given position lies on the active runway
216 // Might have to change when we consider more than one active rwy.
217 bool OnActiveRunway(Point3D pt);
219 // Figure out if a given position lies on a runway or not
220 bool OnAnyRunway(Point3D pt);
222 // Calculate the eta of a plane to the threshold.
223 // For ground traffic this is the fastest they can get there.
224 // For air traffic this is the middle approximation.
225 void CalcETA(TowerPlaneRec* tpr, bool printout = false);
227 // Iterate through all the lists and call CalcETA for all the planes.
228 void doThresholdETACalc();
230 // Order the list of traffic as per expected threshold use and flag any conflicts
231 bool doThresholdUseOrder();
233 // Calculate the crow-flys distance of a plane to the threshold in meters
234 double CalcDistOutM(TowerPlaneRec* tpr);
236 // Calculate the crow-flys distance of a plane to the threshold in miles
237 double CalcDistOutMiles(TowerPlaneRec* tpr);
240 void doCommunication();
243 void IssueLandingClearance(TowerPlaneRec* tpr);
244 void IssueGoAround(TowerPlaneRec* tpr);
245 void IssueDepartureClearance(TowerPlaneRec* tpr);
247 unsigned int update_count; // Convienince counter for speading computational load over several updates
248 unsigned int update_count_max; // ditto.
250 bool display; // Flag to indicate whether we should be outputting to the ATC display.
251 bool displaying; // Flag to indicate whether we are outputting to the ATC display.
253 double timeSinceLastDeparture; // Time in seconds since last departure from active rwy.
254 bool departed; // set true when the above needs incrementing with time, false when it doesn't.
256 // environment - need to make sure we're getting the surface winds and not winds aloft.
257 SGPropertyNode* wind_from_hdg; //degrees
258 SGPropertyNode* wind_speed_knots; //knots
260 double aptElev; // Airport elevation
261 string activeRwy; // Active runway number - For now we'll disregard multiple / alternate runway operation.
262 RunwayDetails rwy; // Assumed to be the active one for now.
263 bool rwyOccupied; // Active runway occupied flag. For now we'll disregard land-and-hold-short operations.
264 FGATCAlignedProjection ortho; // Orthogonal mapping of the local area with the active runway threshold at the origin
266 // Figure out which runways are active.
267 // For now we'll just be simple and do one active runway - eventually this will get much more complex
268 // This is a private function - public interface to the results of this is through GetActiveRunway
271 // Need a data structure to hold details of the various active planes
272 // or possibly another data structure with the positions of the inactive planes.
273 // Need a data structure to hold outstanding communications from aircraft.
275 // Linked-list of planes on approach to active rwy ordered with nearest first (timewise).
276 // Includes planes that have landed but not yet vacated runway.
277 // Somewhat analagous to the paper strips used (used to be used?) in real life.
278 // Doesn't include planes in circuit until they turn onto base/final?
279 // TODO - may need to alter this for operation to more than one active rwy.
280 tower_plane_rec_list_type appList;
281 tower_plane_rec_list_iterator appListItr;
283 // What should we do with planes approaching the airport to join the circuit somewhere
284 // but not on straight-in though? - put them in here for now.
285 tower_plane_rec_list_type circuitAppList;
286 tower_plane_rec_list_iterator circuitAppListItr;
288 // List of departed planes (planes doing circuits go into circuitList not depList after departure)
289 tower_plane_rec_list_type depList;
290 tower_plane_rec_list_iterator depListItr;
292 // List of planes in the circuit (ordered by nearest to landing first)
293 tower_plane_rec_list_type circuitList;
294 tower_plane_rec_list_iterator circuitListItr;
296 // List of planes waiting to depart
297 tower_plane_rec_list_type holdList;
298 tower_plane_rec_list_iterator holdListItr;
300 // List of planes on rwy
301 tower_plane_rec_list_type rwyList;
302 tower_plane_rec_list_iterator rwyListItr;
304 // List of all planes due to use a given rwy arranged in projected order of rwy use
305 tower_plane_rec_list_type trafficList; // TODO - needs to be expandable to more than one rwy
306 tower_plane_rec_list_iterator trafficListItr;
308 // List of planes that have vacated the runway inbound but not yet handed off to ground
309 tower_plane_rec_list_type vacatedList;
310 tower_plane_rec_list_iterator vacatedListItr;
312 // Returns true if successful
313 bool RemoveFromTrafficList(string id);
314 bool RemoveFromAppList(string id);
315 bool RemoveFromRwyList(string id);
317 // Return the ETA of plane no. list_pos (1-based) in the traffic list.
318 // i.e. list_pos = 1 implies next to use runway.
319 double GetTrafficETA(unsigned int list_pos, bool printout = false);
321 // Add a tower plane rec with ETA to the traffic list in the correct position ETA-wise.
322 // Returns true if this could cause a threshold ETA conflict with other traffic, false otherwise.
323 bool AddToTrafficList(TowerPlaneRec* t, bool holding = false);
325 bool AddToCircuitList(TowerPlaneRec* t);
327 // Ground can be separate or handled by tower in real life.
328 // In the program we will always use a separate FGGround class, but we need to know
329 // whether it is supposed to be separate or not to give the correct instructions.
330 bool separateGround; // true if ground control is separate
331 FGGround* ground; // The ground control associated with this airport.
333 bool _departureControlled; // true if we need to hand off departing traffic to departure control
334 //FGDeparture* _departure; // The relevant departure control (once we've actually written it!)
336 // for failure modeling
337 string trans_ident; // transmitted ident
338 bool tower_failed; // tower failed?
340 // Pointers to current users position and orientation
341 SGPropertyNode* user_lon_node;
342 SGPropertyNode* user_lat_node;
343 SGPropertyNode* user_elev_node;
344 SGPropertyNode* user_hdg_node;
346 // Details of the general traffic flow etc in the circuit
347 double crosswind_leg_pos; // Distance from threshold crosswind leg is being turned to in meters (actual operation - *not* ideal circuit)
348 double downwind_leg_pos; // Actual offset distance in meters from the runway that planes are flying the downwind leg
349 // Currently not sure whether the above should be always +ve or just take the natural orthopos sign (+ve for RH circuit, -ve for LH).
350 double base_leg_pos; // Actual offset distance from the threshold (-ve) that planes are turning to base leg.
352 double nominal_crosswind_leg_pos;
353 double nominal_downwind_leg_pos;
354 double nominal_base_leg_pos;
356 friend istream& operator>> ( istream&, FGTower& );
359 #endif //_FG_TOWER_HXX