]> git.mxchange.org Git - flightgear.git/blob - src/ATC/tower.hxx
Multiplayer client/server system -- Message base class, "hello" message, and message...
[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 };
65
66 // TODO - need some differentiation of IFR and VFR traffic in order to give the former priority.
67
68 // Structure for holding details of a plane under tower control.
69 // Not fixed yet - may include more stuff later.
70 class TowerPlaneRec {
71         
72 public:
73         
74         TowerPlaneRec();
75         TowerPlaneRec(PlaneRec p);
76         TowerPlaneRec(Point3D pt);
77         TowerPlaneRec(PlaneRec p, Point3D pt);
78         
79         FGAIPlane* planePtr;    // This might move to the planeRec eventually
80         PlaneRec plane;
81         
82         Point3D pos;
83         double eta;             // seconds
84         double dist_out;        // meters from theshold
85         bool clearedToLand;
86         bool clearedToLineUp;
87         bool clearedToTakeOff;
88         // ought to add time cleared to depart so we can nag if necessary
89         bool holdShortReported;
90         bool downwindReported;
91         bool longFinalReported;
92         bool longFinalAcknowledged;
93         bool finalReported;
94         bool finalAcknowledged;
95         bool rwyVacatedReported;
96         bool rwyVacatedAcknowledged;
97         bool instructedToGoAround;      // set true if told by tower to go around
98         bool onRwy;             // is physically on the runway
99         bool nextOnRwy;         // currently projected by tower to be the next on the runway
100         
101         bool vfrArrivalReported;
102         bool vfrArrivalAcknowledged;
103
104         // Type of operation the plane is doing
105         tower_traffic_type opType;
106         
107         // Whereabouts in circuit if doing circuits
108         PatternLeg leg;
109         
110         LandingType landingType;
111         
112         bool isUser;    // true if this plane is the user
113 };
114
115
116 typedef list < TowerPlaneRec* > tower_plane_rec_list_type;
117 typedef tower_plane_rec_list_type::iterator tower_plane_rec_list_iterator;
118 typedef tower_plane_rec_list_type::const_iterator tower_plane_rec_list_const_iterator;
119
120
121 class FGTower : public FGATC {
122
123 public:
124         
125         FGTower();
126         ~FGTower();
127         
128         void Init();
129         
130         void Update(double dt);
131         
132         void ReceiveUserCallback(int code);
133
134         // Contact tower for VFR approach
135         // eg "Cessna Charlie Foxtrot Golf Foxtrot Sierra eight miles South of the airport for full stop with Bravo"
136         // This function probably only called via user interaction - AI planes will have an overloaded function taking a planerec.
137         void VFRArrivalContact(string ID, LandingType opt = AIP_LT_UNKNOWN);
138         
139         void RequestDepartureClearance(string ID);      
140         void ReportFinal(string ID);
141         void ReportLongFinal(string ID);
142         void ReportOuterMarker(string ID);
143         void ReportMiddleMarker(string ID);
144         void ReportInnerMarker(string ID);
145         void ReportGoingAround(string ID);
146         void ReportRunwayVacated(string ID);
147         void ReportReadyForDeparture(string ID);
148         void ReportDownwind(string ID);
149         
150         // Contact tower when at a hold short for departure - for now we'll assume plane - maybe vehicles might want to cross runway eventually?
151         void ContactAtHoldShort(PlaneRec plane, FGAIPlane* requestee, tower_traffic_type operation);
152         
153         // Register the presence of an AI plane at a point where contact would already have been made in real life
154         // CAUTION - currently it is assumed that this plane's callsign is unique - it is up to AIMgr to generate unique callsigns.
155         void RegisterAIPlane(PlaneRec plane, FGAIPlane* ai, tower_traffic_type op, PatternLeg lg = LEG_UNKNOWN);
156         
157         // Public interface to the active runway - this will get more complex 
158         // in the future and consider multi-runway use, airplane weight etc.
159         inline string GetActiveRunway() { return activeRwy; }
160         inline RunwayDetails GetActiveRunwayDetails() { return rwy; }
161         // Get the pattern direction of the active rwy.
162         inline int GetPatternDirection() { return rwy.patternDirection; }
163         
164         inline void SetDisplay() { display = true; }
165         inline void SetNoDisplay() { display = false; }
166         
167         inline string get_trans_ident() { return trans_ident; }
168         inline atc_type GetType() { return TOWER; }
169         
170         inline FGGround* GetGroundPtr() { return ground; }
171         
172         // Returns true if positions of crosswind/downwind/base leg turns should be constrained by previous traffic
173         // plus the constraint position as a rwy orientated orthopos (meters)
174         bool GetCrosswindConstraint(double& cpos);
175         bool GetDownwindConstraint(double& dpos);
176         bool GetBaseConstraint(double& bpos);
177         
178         string GenText(const string& m, int c);
179
180 private:
181         FGATCMgr* ATCmgr;       
182         // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
183         
184         // Respond to a transmission
185         void Respond();
186         
187         void CheckHoldList(double dt);
188
189         void CheckCircuitList(double dt);
190         
191         void CheckRunwayList(double dt);
192
193         void CheckApproachList(double dt);
194         
195         // Currently this assumes we *are* next on the runway and doesn't check for planes about to land - 
196         // this should be done prior to calling this function.
197         void ClearHoldingPlane(TowerPlaneRec* t);
198         
199         // Find a pointer to plane of callsign ID within the internal data structures
200         TowerPlaneRec* FindPlane(string ID);
201         
202         // Figure out if a given position lies on the active runway
203         // Might have to change when we consider more than one active rwy.
204         bool OnActiveRunway(Point3D pt);
205         
206         // Figure out if a given position lies on a runway or not
207         bool OnAnyRunway(Point3D pt);
208         
209         // Calculate the eta of a plane to the threshold.
210         // For ground traffic this is the fastest they can get there.
211         // For air traffic this is the middle approximation.
212         void CalcETA(TowerPlaneRec* tpr, bool printout = false);
213         
214         // Iterate through all the lists and call CalcETA for all the planes.
215         void doThresholdETACalc();
216         
217         // Order the list of traffic as per expected threshold use and flag any conflicts
218         bool doThresholdUseOrder();
219         
220         // Calculate the crow-flys distance of a plane to the threshold in meters
221         double CalcDistOutM(TowerPlaneRec* tpr);
222
223         // Calculate the crow-flys distance of a plane to the threshold in miles
224         double CalcDistOutMiles(TowerPlaneRec* tpr);
225         
226         /*
227         void doCommunication();
228         */
229         
230         void IssueLandingClearance(TowerPlaneRec* tpr);
231         void IssueGoAround(TowerPlaneRec* tpr);
232         void IssueDepartureClearance(TowerPlaneRec* tpr);
233         
234         unsigned int update_count;      // Convienince counter for speading computational load over several updates
235         unsigned int update_count_max;  // ditto.
236         
237         bool display;           // Flag to indicate whether we should be outputting to the ATC display.
238         bool displaying;                // Flag to indicate whether we are outputting to the ATC display.
239         
240         double timeSinceLastDeparture;  // Time in seconds since last departure from active rwy.
241         bool departed;  // set true when the above needs incrementing with time, false when it doesn't.
242         
243         // environment - need to make sure we're getting the surface winds and not winds aloft.
244         SGPropertyNode* wind_from_hdg;  //degrees
245         SGPropertyNode* wind_speed_knots;               //knots
246         
247         double aptElev;         // Airport elevation
248         string activeRwy;       // Active runway number - For now we'll disregard multiple / alternate runway operation.
249         RunwayDetails rwy;      // Assumed to be the active one for now.
250         bool rwyOccupied;       // Active runway occupied flag.  For now we'll disregard land-and-hold-short operations.
251         FGATCAlignedProjection ortho;   // Orthogonal mapping of the local area with the active runway threshold at the origin
252         
253         // Figure out which runways are active.
254         // For now we'll just be simple and do one active runway - eventually this will get much more complex
255         // This is a private function - public interface to the results of this is through GetActiveRunway
256         void DoRwyDetails();
257         
258         // Need a data structure to hold details of the various active planes
259         // or possibly another data structure with the positions of the inactive planes.
260         // Need a data structure to hold outstanding communications from aircraft.
261         
262         // Linked-list of planes on approach to active rwy ordered with nearest first (timewise).
263         // Includes planes that have landed but not yet vacated runway.
264         // Somewhat analagous to the paper strips used (used to be used?) in real life.
265         // Doesn't include planes in circuit until they turn onto base/final?
266         // TODO - may need to alter this for operation to more than one active rwy.
267         tower_plane_rec_list_type appList;
268         tower_plane_rec_list_iterator appListItr;
269
270         // What should we do with planes approaching the airport to join the circuit somewhere
271         // but not on straight-in though? - put them in here for now.   
272         tower_plane_rec_list_type circuitAppList;
273         tower_plane_rec_list_iterator circuitAppListItr;
274         
275         // List of departed planes (planes doing circuits go into circuitList not depList after departure)
276         tower_plane_rec_list_type depList;
277         tower_plane_rec_list_iterator depListItr;
278         
279         // List of planes in the circuit (ordered by nearest to landing first)
280         tower_plane_rec_list_type circuitList;
281         tower_plane_rec_list_iterator circuitListItr;
282         
283         // List of planes waiting to depart
284         tower_plane_rec_list_type holdList;
285         tower_plane_rec_list_iterator holdListItr;
286                 
287         // List of planes on rwy
288         tower_plane_rec_list_type rwyList;
289         tower_plane_rec_list_iterator rwyListItr;
290
291         // List of all planes due to use a given rwy arranged in projected order of rwy use
292         tower_plane_rec_list_type trafficList;  // TODO - needs to be expandable to more than one rwy
293         tower_plane_rec_list_iterator trafficListItr;
294         
295         // Returns true if successful
296         bool RemoveFromTrafficList(string id);
297         
298         // Return the ETA of plane no. list_pos (1-based) in the traffic list.
299         // i.e. list_pos = 1 implies next to use runway.
300         double GetTrafficETA(unsigned int list_pos, bool printout = false);
301         
302         // Add a tower plane rec with ETA to the traffic list in the correct position ETA-wise.
303         // Returns true if this could cause a threshold ETA conflict with other traffic, false otherwise.
304         bool AddToTrafficList(TowerPlaneRec* t, bool holding = false);
305         
306         bool AddToCircuitList(TowerPlaneRec* t);
307
308         // Ground can be separate or handled by tower in real life.
309         // In the program we will always use a separate FGGround class, but we need to know
310         // whether it is supposed to be separate or not to give the correct instructions.
311         bool separateGround;    // true if ground control is separate
312         FGGround* ground;       // The ground control associated with this airport.
313         
314         // for failure modeling
315         string trans_ident;             // transmitted ident
316         bool tower_failed;              // tower failed?
317         
318         // Pointers to current users position and orientation
319         SGPropertyNode* user_lon_node;
320         SGPropertyNode* user_lat_node;
321         SGPropertyNode* user_elev_node;
322         SGPropertyNode* user_hdg_node;
323         
324         // Details of the general traffic flow etc in the circuit
325         double crosswind_leg_pos;       // Distance from threshold crosswind leg is being turned to in meters (actual operation - *not* ideal circuit)
326         double downwind_leg_pos;        // Actual offset distance in meters from the runway that planes are flying the downwind leg
327         // Currently not sure whether the above should be always +ve or just take the natural orthopos sign (+ve for RH circuit, -ve for LH).
328         double base_leg_pos;            // Actual offset distance from the threshold (-ve) that planes are turning to base leg.
329         
330         double nominal_crosswind_leg_pos;
331         double nominal_downwind_leg_pos;
332         double nominal_base_leg_pos;
333         
334         friend istream& operator>> ( istream&, FGTower& );
335 };
336
337 #endif  //_FG_TOWER_HXX