1 // FGGround - a class to provide ground control at larger 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.
21 #ifndef _FG_GROUND_HXX
22 #define _FG_GROUND_HXX
33 #include <simgear/math/point3d.hxx>
34 #include <simgear/misc/sgstream.hxx>
35 #include <simgear/math/sg_geodesy.hxx>
38 #include "ATCProjection.hxx"
44 //////////////////////////////////////////////////////
45 // Types for the logical network data structure
46 typedef enum arc_type {
51 typedef enum node_type {
61 TRANSPORT_PASSENGER_NARROWBODY,
62 TRANSPORT_PASSENGER_WIDEBODY,
70 OTHER // ie. anything goes!!
73 typedef enum network_element_type {
78 struct ground_network_element {
79 network_element_type struct_type;
82 struct arc : public ground_network_element {
86 bool directed; //false if 2-way, true if 1-way.
87 //This is a can of worms since arcs might be one way in different directions under different circumstances
88 unsigned int n1; // The nodeID of the first node
89 unsigned int n2; // The nodeID of the second node
90 // If the arc is directed then flow is normally from n1 to n2. See the above can of worms comment though.
93 typedef vector <arc*> arc_array_type; // This was and may become again a list instead of vector
94 typedef arc_array_type::iterator arc_array_iterator;
95 typedef arc_array_type::const_iterator arc_array_const_iterator;
97 struct node : public ground_network_element {
98 unsigned int nodeID; //each node in an airport needs a unique ID number - this is ZERO-BASED to match array position
104 double max_turn_radius;
107 typedef vector <node*> node_array_type;
108 typedef node_array_type::iterator node_array_iterator;
109 typedef node_array_type::const_iterator node_array_const_iterator;
111 struct Gate : public node {
113 int max_weight; //units??
114 //airline_code airline; //For the future - we don't have any airline codes ATM
115 int id; // The gate number in the logical scheme of things
116 string sid; // The real-world gate letter/number
119 double heading; // The direction the parked-up plane should point in degrees
122 typedef vector < Gate > gate_vec_type;
123 typedef gate_vec_type::iterator gate_vec_iterator;
124 typedef gate_vec_type::const_iterator gate_vec_const_iterator;
126 // A map of gate vs. the logical (internal FGFS) gate ID
127 typedef map < int, Gate > gate_map_type;
128 typedef gate_map_type::iterator gate_map_iterator;
129 typedef gate_map_type::const_iterator gate_map_const_iterator;
131 // Runways - all the runway stuff is likely to change in the future
133 int id; //note this is a very simplified scheme for now - R & L are not differentiated
134 //It should work for simple one rwy airports
135 node_array_type exits; //Array of available exits from runway
136 // should probably add an FGRunway structure here as well eventually
137 // Eventually we will also want some encoding of real-life preferred runways
138 // This will get us up and running for single runway airports though.
140 typedef vector < Rwy > runway_array_type;
141 typedef runway_array_type::iterator runway_array_iterator;
142 typedef runway_array_type::const_iterator runway_array_const_iterator;
144 // end logical network types
145 ///////////////////////////////////////////////////////
147 ///////////////////////////////////////////////////////
148 // Structures to use the network
150 // A path through the network
151 typedef vector < ground_network_element* > ground_network_path_type;
152 typedef ground_network_path_type::iterator ground_network_path_iterator;
153 typedef ground_network_path_type::const_iterator ground_network_path_const_iterator;
155 //////////////////////////////////////////////////////////////////////////////////////////
157 // Planes active within the ground network.
158 // somewhere in the ATC/AI system we are going to have defined something like
159 // typedef struct plane_rec
160 // list <PlaneRec> plane_rec_list_type
162 // A more specialist plane rec to include ground information
163 typedef struct ground_rec {
168 bool cleared; // set true when the plane has been cleared to somewhere
169 bool incoming; //true for arrivals, false for departures
171 // Almost certainly need to add more here
174 typedef list<ground_rec*> ground_rec_list;
175 typedef ground_rec_list::iterator ground_rec_list_itr;
176 typedef ground_rec_list::const_iterator ground_rec_list_const_itr;
178 //////////////////////////////////////////////////////////////////////////////////////////
180 ///////////////////////////////////////////////////////////////////////////////
184 ///////////////////////////////////////////////////////////////////////////////
185 class FGGround : public FGATC {
194 inline string get_trans_ident() { return trans_ident; }
195 inline atc_type GetType() { return GROUND; }
196 inline void SetDisplay() {display = true;}
197 inline void SetNoDisplay() {display = false;}
199 // Its possible that NewArrival and NewDeparture should simply be rolled into Request.
201 // Contact ground control on arrival, assumed to request any gate
202 //void NewArrival(plane_rec plane);
204 // Contact ground control on departure, assumed to request currently active runway.
205 //void NewDeparture(plane_rec plane);
207 // Contact ground control when the calling routine doesn't know if arrival
208 // or departure is appropriate.
209 //void NewContact(plane_rec plane);
211 // Make a request of ground control.
212 //void Request(ground_request request);
214 // Randomly fill some of the available gates and GA parking spots with planes
215 void PopulateGates();
217 // Return a suitable gate (maybe this should be a list of suitable gates so the plane or controller can choose the closest one)
218 void ReturnGate(Gate &gate, GateType type);
220 //The following two functions have been made public for now but may go private with a higher level accessor at some point
221 // Return the internal ID of a random, suitable, unused gate
222 // For now we are simply implementing as any random unused gate
223 int GetRandomGateID();
224 // Return a pointer to a node based on the gate ID
225 Gate* GetGateNode(int gateID);
227 // Runway stuff - this might change in the future.
228 // Get a list of exits from a given runway
229 // It is up to the calling function to check for non-zero size of returned array before use
230 node_array_type GetExits(int rwyID);
232 // Get a path from one node to another
233 ground_network_path_type GetPath(node* A, node* B);
237 // Need a data structure to hold details of the various active planes
238 // Need a data structure to hold details of the logical network
239 // including which gates are filled - or possibly another data structure
240 // with the positions of the inactive planes.
241 // Need a data structure to hold outstanding communications from aircraft.
242 // Possibly need a data structure to hold outstanding communications to aircraft.
244 // The logical network
245 // NODES WILL BE STORED IN THE NETWORK IN ORDER OF nodeID NUMBER
246 // ie. NODE 5 WILL BE AT network[5]
247 node_array_type network;
249 // A map of all the gates indexed against internal (FGFS) ID
251 gate_map_iterator gatesItr;
253 // Runway stuff - this might change in the future.
254 //runway_array_type runways; // STL way
255 Rwy runways[36]; // quick hack!
257 FGATCAlignedProjection ortho;
259 // Planes currently active
260 //ground_rec_list ground_traffic;
262 // Find the shortest route through the logical network between two points.
263 //FindShortestRoute(point a, point b);
265 // Project a point in WGS84 lat/lon onto the local gnomonic.
266 //ConvertWGS84ToXY(sgVec3 wgs84, point xy);
268 // Assign a gate or parking location to a new arrival
269 //AssignGate(ground_rec &g);
271 // Generate the next clearance for an airplane
272 //NextClearance(ground_rec &g);
274 bool display; // Flag to indicate whether we should be outputting to the ATC display.
275 bool displaying; // Flag to indicate whether we are outputting to the ATC display.
276 // for failure modeling
277 string trans_ident; // transmitted ident
278 bool ground_failed; // ground failed?
279 bool networkLoadOK; // Indicates whether LoadNetwork returned true or false at last attempt
281 // Load the logical ground network for this airport from file.
282 // Return true if successfull.
285 // Parse a runway exit string and push the supplied node pointer onto the runway exit list
286 void ParseRwyExits(node* np, char* es);
289 #endif // _FG_GROUND_HXX