]> git.mxchange.org Git - flightgear.git/blob - src/ATC/tower.hxx
Fix a misuse of a return value that lead to an error message being displayed
[flightgear.git] / 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,        // CIRCUIT traffic gets changed to INBOUND when on final of the full-stop circuit.
49         OUTBOUND,
50         TTT_UNKNOWN,    // departure, but we don't know if for circuits or leaving properly
51         STRAIGHT_IN
52 };
53
54 ostream& operator << (ostream& os, tower_traffic_type ttt);
55
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
65 };
66
67 // TODO - need some differentiation of IFR and VFR traffic in order to give the former priority.
68
69 // Structure for holding details of a plane under tower control.
70 // Not fixed yet - may include more stuff later.
71 class TowerPlaneRec {
72         
73 public:
74         
75         TowerPlaneRec();
76         TowerPlaneRec(PlaneRec p);
77         TowerPlaneRec(Point3D pt);
78         TowerPlaneRec(PlaneRec p, Point3D pt);
79         
80         FGAIPlane* planePtr;    // This might move to the planeRec eventually
81         PlaneRec plane;
82         
83         Point3D pos;
84         double eta;             // seconds
85         double dist_out;        // meters from theshold
86         bool clearedToLand;
87         bool clearedToLineUp;
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;
94         bool finalReported;
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
102         
103         bool vfrArrivalReported;
104         bool vfrArrivalAcknowledged;
105
106         // Type of operation the plane is doing
107         tower_traffic_type opType;
108         
109         // Whereabouts in circuit if doing circuits
110         PatternLeg leg;
111         
112         LandingType landingType;
113         
114         bool isUser;    // true if this plane is the user
115 };
116
117
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;
121
122
123 class FGTower : public FGATC {
124
125 public:
126         
127         FGTower();
128         ~FGTower();
129         
130         void Init();
131         
132         void Update(double dt);
133         
134         void ReceiveUserCallback(int code);
135
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);
142         
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);
153         
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);
156         
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);
160         
161         // Deregister and remove an AI plane.
162         void DeregisterAIPlane(string id);
163         
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; }
170         
171         inline string get_trans_ident() { return trans_ident; }
172         
173         inline FGGround* GetGroundPtr() { return ground; }
174         
175         // Returns true if positions of crosswind/downwind/base leg turns should be constrained by previous traffic
176         // plus the constraint position as a rwy orientated orthopos (meters)
177         bool GetCrosswindConstraint(double& cpos);
178         bool GetDownwindConstraint(double& dpos);
179         bool GetBaseConstraint(double& bpos);
180         
181         string GenText(const string& m, int c);
182
183 private:
184         FGATCMgr* ATCmgr;       
185         // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
186         
187         // Respond to a transmission
188         void Respond();
189         
190         void ProcessRunwayVacatedReport(TowerPlaneRec* t);
191         void ProcessDownwindReport(TowerPlaneRec* t);
192         
193         // Remove all options from the user dialog choice
194         void RemoveAllUserDialogOptions();
195         
196         // Periodic checks on the various traffic.
197         void CheckHoldList(double dt);
198         void CheckCircuitList(double dt);
199         void CheckRunwayList(double dt);
200         void CheckApproachList(double dt);
201         void CheckDepartureList(double dt);
202         
203         // Currently this assumes we *are* next on the runway and doesn't check for planes about to land - 
204         // this should be done prior to calling this function.
205         void ClearHoldingPlane(TowerPlaneRec* t);
206         
207         // Find a pointer to plane of callsign ID within the internal data structures
208         TowerPlaneRec* FindPlane(string ID);
209         
210         // Remove and delete all instances of a plane with a given ID
211         void RemovePlane(string ID);
212         
213         // Figure out if a given position lies on the active runway
214         // Might have to change when we consider more than one active rwy.
215         bool OnActiveRunway(Point3D pt);
216         
217         // Figure out if a given position lies on a runway or not
218         bool OnAnyRunway(Point3D pt);
219         
220         // Calculate the eta of a plane to the threshold.
221         // For ground traffic this is the fastest they can get there.
222         // For air traffic this is the middle approximation.
223         void CalcETA(TowerPlaneRec* tpr, bool printout = false);
224         
225         // Iterate through all the lists and call CalcETA for all the planes.
226         void doThresholdETACalc();
227         
228         // Order the list of traffic as per expected threshold use and flag any conflicts
229         bool doThresholdUseOrder();
230         
231         // Calculate the crow-flys distance of a plane to the threshold in meters
232         double CalcDistOutM(TowerPlaneRec* tpr);
233
234         // Calculate the crow-flys distance of a plane to the threshold in miles
235         double CalcDistOutMiles(TowerPlaneRec* tpr);
236         
237         /*
238         void doCommunication();
239         */
240         
241         void IssueLandingClearance(TowerPlaneRec* tpr);
242         void IssueGoAround(TowerPlaneRec* tpr);
243         void IssueDepartureClearance(TowerPlaneRec* tpr);
244         
245         unsigned int update_count;      // Convienince counter for speading computational load over several updates
246         unsigned int update_count_max;  // ditto.
247         
248         double timeSinceLastDeparture;  // Time in seconds since last departure from active rwy.
249         bool departed;  // set true when the above needs incrementing with time, false when it doesn't.
250         
251         // environment - need to make sure we're getting the surface winds and not winds aloft.
252         SGPropertyNode* wind_from_hdg;  //degrees
253         SGPropertyNode* wind_speed_knots;               //knots
254         
255         double aptElev;         // Airport elevation
256         string activeRwy;       // Active runway number - For now we'll disregard multiple / alternate runway operation.
257         RunwayDetails rwy;      // Assumed to be the active one for now.
258         bool rwyOccupied;       // Active runway occupied flag.  For now we'll disregard land-and-hold-short operations.
259         FGATCAlignedProjection ortho;   // Orthogonal mapping of the local area with the active runway threshold at the origin
260         
261         // Figure out which runways are active.
262         // For now we'll just be simple and do one active runway - eventually this will get much more complex
263         // This is a private function - public interface to the results of this is through GetActiveRunway
264         void DoRwyDetails();
265         
266         // Need a data structure to hold details of the various active planes
267         // or possibly another data structure with the positions of the inactive planes.
268         // Need a data structure to hold outstanding communications from aircraft.
269         
270         // Linked-list of planes on approach to active rwy ordered with nearest first (timewise).
271         // Includes planes that have landed but not yet vacated runway.
272         // Somewhat analagous to the paper strips used (used to be used?) in real life.
273         // Doesn't include planes in circuit until they turn onto base/final?
274         // TODO - may need to alter this for operation to more than one active rwy.
275         tower_plane_rec_list_type appList;
276         tower_plane_rec_list_iterator appListItr;
277
278         // What should we do with planes approaching the airport to join the circuit somewhere
279         // but not on straight-in though? - put them in here for now.   
280         tower_plane_rec_list_type circuitAppList;
281         tower_plane_rec_list_iterator circuitAppListItr;
282         
283         // List of departed planes (planes doing circuits go into circuitList not depList after departure)
284         tower_plane_rec_list_type depList;
285         tower_plane_rec_list_iterator depListItr;
286         
287         // List of planes in the circuit (ordered by nearest to landing first)
288         tower_plane_rec_list_type circuitList;
289         tower_plane_rec_list_iterator circuitListItr;
290         
291         // List of planes waiting to depart
292         tower_plane_rec_list_type holdList;
293         tower_plane_rec_list_iterator holdListItr;
294                 
295         // List of planes on rwy
296         tower_plane_rec_list_type rwyList;
297         tower_plane_rec_list_iterator rwyListItr;
298
299         // List of all planes due to use a given rwy arranged in projected order of rwy use
300         tower_plane_rec_list_type trafficList;  // TODO - needs to be expandable to more than one rwy
301         tower_plane_rec_list_iterator trafficListItr;
302         
303         // List of planes that have vacated the runway inbound but not yet handed off to ground
304         tower_plane_rec_list_type vacatedList;
305         tower_plane_rec_list_iterator vacatedListItr;
306         
307         // Returns true if successful
308         bool RemoveFromTrafficList(string id);
309         bool RemoveFromAppList(string id);
310         bool RemoveFromRwyList(string id);
311         
312         // Return the ETA of plane no. list_pos (1-based) in the traffic list.
313         // i.e. list_pos = 1 implies next to use runway.
314         double GetTrafficETA(unsigned int list_pos, bool printout = false);
315         
316         // Add a tower plane rec with ETA to the traffic list in the correct position ETA-wise.
317         // Returns true if this could cause a threshold ETA conflict with other traffic, false otherwise.
318         bool AddToTrafficList(TowerPlaneRec* t, bool holding = false);
319         
320         bool AddToCircuitList(TowerPlaneRec* t);
321         
322         // Add to vacated list only if not already present
323         void AddToVacatedList(TowerPlaneRec* t);
324
325         // Ground can be separate or handled by tower in real life.
326         // In the program we will always use a separate FGGround class, but we need to know
327         // whether it is supposed to be separate or not to give the correct instructions.
328         bool separateGround;    // true if ground control is separate
329         FGGround* ground;       // The ground control associated with this airport.
330         
331         bool _departureControlled;      // true if we need to hand off departing traffic to departure control
332         //FGDeparture* _departure;      // The relevant departure control (once we've actually written it!)
333         
334         // for failure modeling
335         string trans_ident;             // transmitted ident
336         bool tower_failed;              // tower failed?
337         
338         // Pointers to current users position and orientation
339         SGPropertyNode* user_lon_node;
340         SGPropertyNode* user_lat_node;
341         SGPropertyNode* user_elev_node;
342         SGPropertyNode* user_hdg_node;
343         
344         // Details of the general traffic flow etc in the circuit
345         double crosswind_leg_pos;       // Distance from threshold crosswind leg is being turned to in meters (actual operation - *not* ideal circuit)
346         double downwind_leg_pos;        // Actual offset distance in meters from the runway that planes are flying the downwind leg
347         // Currently not sure whether the above should be always +ve or just take the natural orthopos sign (+ve for RH circuit, -ve for LH).
348         double base_leg_pos;            // Actual offset distance from the threshold (-ve) that planes are turning to base leg.
349         
350         double nominal_crosswind_leg_pos;
351         double nominal_downwind_leg_pos;
352         double nominal_base_leg_pos;
353         
354         friend istream& operator>> ( istream&, FGTower& );
355 };
356
357 #endif  //_FG_TOWER_HXX