1 // trafficcontrol.hxx - classes to manage AIModels based air traffic control
2 // Written by Durk Talsma, started September 2006.
4 // This program is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU General Public License as
6 // published by the Free Software Foundation; either version 2 of the
7 // License, or (at your option) any later version.
9 // This program is distributed in the hope that it will be useful, but
10 // WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with this program; if not, write to the Free Software
16 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 #ifndef _TRAFFIC_CONTROL_HXX_
22 #define _TRAFFIC_CONTROL_HXX_
26 # error This library requires C++
30 #include <simgear/compiler.h>
31 #include <simgear/debug/logstream.hxx>
42 typedef vector<int> intVec;
43 typedef vector<int>::iterator intVecIterator;
46 class FGAIFlightPlan; // forward reference
47 class FGGroundNetwork; // forward reference
48 class FGAIAircraft; // forward reference
50 /**************************************************************************************
51 * class FGATCInstruction
52 * like class FGATC Controller, this class definition should go into its own file
53 * and or directory... For now, just testing this stuff out though...
54 *************************************************************************************/
55 class FGATCInstruction
63 bool resolveCircularWait;
71 bool hasInstruction ();
72 bool getHoldPattern () { return holdPattern; };
73 bool getHoldPosition () { return holdPosition; };
74 bool getChangeSpeed () { return changeSpeed; };
75 bool getChangeHeading () { return changeHeading; };
76 bool getChangeAltitude() { return changeAltitude; };
78 double getSpeed () { return speed; };
79 double getHeading () { return heading; };
80 double getAlt () { return alt; };
82 bool getCheckForCircularWait() { return resolveCircularWait; };
84 void setHoldPattern (bool val) { holdPattern = val; };
85 void setHoldPosition (bool val) { holdPosition = val; };
86 void setChangeSpeed (bool val) { changeSpeed = val; };
87 void setChangeHeading (bool val) { changeHeading = val; };
88 void setChangeAltitude(bool val) { changeAltitude = val; };
90 void setResolveCircularWait (bool val) { resolveCircularWait = val; };
92 void setSpeed (double val) { speed = val; };
93 void setHeading (double val) { heading = val; };
94 void setAlt (double val) { alt = val; };
101 /**************************************************************************************
102 * class FGTrafficRecord
103 *************************************************************************************/
104 class FGTrafficRecord
112 bool allowTransmission;
115 FGATCInstruction instruction;
116 double latitude, longitude, heading, speed, altitude, radius;
118 //FGAISchedule *trafficRef;
119 FGAIAircraft *aircraft;
125 void setId(int val) { id = val; };
126 void setRadius(double rad) { radius = rad;};
127 void setPositionAndIntentions(int pos, FGAIFlightPlan *route);
128 void setRunway(string rwy) { runway = rwy;};
129 void setLeg(int lg) { leg = lg;};
130 int getId() { return id;};
131 int getState() { return state;};
132 FGATCInstruction getInstruction() { return instruction;};
133 bool hasInstruction() { return instruction.hasInstruction(); };
134 void setPositionAndHeading(double lat, double lon, double hdg, double spd, double alt);
135 bool checkPositionAndIntentions(FGTrafficRecord &other);
136 int crosses (FGGroundNetwork *, FGTrafficRecord &other);
137 bool isOpposing (FGGroundNetwork *, FGTrafficRecord &other, int node);
139 bool onRoute(FGGroundNetwork *, FGTrafficRecord &other);
141 bool getSpeedAdjustment() { return instruction.getChangeSpeed(); };
143 double getLatitude () { return latitude ; };
144 double getLongitude() { return longitude; };
145 double getHeading () { return heading ; };
146 double getSpeed () { return speed ; };
147 double getAltitude () { return altitude ; };
148 double getRadius () { return radius ; };
150 int getWaitsForId () { return waitsForId; };
152 void setSpeedAdjustment(double spd);
153 void setHeadingAdjustment(double heading);
154 void clearSpeedAdjustment () { instruction.setChangeSpeed (false); };
155 void clearHeadingAdjustment() { instruction.setChangeHeading(false); };
157 bool hasHeadingAdjustment() { return instruction.getChangeHeading(); };
158 bool hasHoldPosition() { return instruction.getHoldPosition(); };
159 void setHoldPosition (bool inst) { instruction.setHoldPosition(inst); };
161 void setWaitsForId(int id) { waitsForId = id; };
163 void setResolveCircularWait() { instruction.setResolveCircularWait(true); };
164 void clearResolveCircularWait() { instruction.setResolveCircularWait(false); };
166 string getRunway() { return runway; };
167 //void setCallSign(string clsgn) { callsign = clsgn; };
168 void setAircraft(FGAIAircraft *ref) { aircraft = ref;};
169 void updateState() { state++; allowTransmission=true; };
170 //string getCallSign() { return callsign; };
171 FGAIAircraft *getAircraft() { return aircraft;};
172 int getTime() { return timer; };
173 int getLeg() { return leg; };
174 void setTime(time_t time) { timer = time; };
176 bool pushBackAllowed();
177 bool allowTransmissions() { return allowTransmission; };
178 void suppressRepeatedTransmissions () { allowTransmission=false; };
179 void allowRepeatedTransmissions () { allowTransmission=true; };
180 void nextFrequency() { frequencyId++; };
181 int getNextFrequency() { return frequencyId; };
184 typedef vector<FGTrafficRecord> TrafficVector;
185 typedef vector<FGTrafficRecord>::iterator TrafficVectorIterator;
188 /***********************************************************************
189 * Active runway, a utility class to keep track of which aircraft has
190 * clearance for a given runway.
191 **********************************************************************/
196 int currentlyCleared;
198 ActiveRunway(string r, int cc) { rwy = r; currentlyCleared = cc; };
200 string getRunwayName() { return rwy; };
201 int getCleared () { return currentlyCleared; };
204 typedef vector<ActiveRunway> ActiveRunwayVec;
205 typedef vector<ActiveRunway>::iterator ActiveRunwayVecIterator;
208 * class FGATCController
209 * NOTE: this class serves as an abstraction layer for all sorts of ATC controller.
210 *************************************************************************************/
211 class FGATCController
217 string formatATCFrequency3_2(int );
218 string genTransponderCode(string fltRules);
222 MSG_ANNOUNCE_ENGINE_START,
223 MSG_REQUEST_ENGINE_START,
224 MSG_PERMIT_ENGINE_START,
225 MSG_DENY_ENGINE_START,
226 MSG_ACKNOWLEDGE_ENGINE_START,
227 MSG_REQUEST_PUSHBACK_CLEARANCE,
228 MSG_PERMIT_PUSHBACK_CLEARANCE,
229 MSG_HOLD_PUSHBACK_CLEARANCE,
230 MSG_ACKNOWLEDGE_SWITCH_GROUND_FREQUENCY } AtcMsgId;
233 ATC_GROUND_TO_AIR } AtcMsgDir;
234 FGATCController() { dt_count = 0;};
235 virtual ~FGATCController() {};
236 virtual void announcePosition(int id, FGAIFlightPlan *intendedRoute, int currentRoute,
237 double lat, double lon,
238 double hdg, double spd, double alt, double radius, int leg,
239 FGAIAircraft *aircraft) = 0;
240 virtual void signOff(int id) = 0;
241 virtual void update(int id, double lat, double lon,
242 double heading, double speed, double alt, double dt) = 0;
243 virtual bool hasInstruction(int id) = 0;
244 virtual FGATCInstruction getInstruction(int id) = 0;
246 double getDt() { return dt_count; };
247 void setDt(double dt) { dt_count = dt;};
248 void transmit(FGTrafficRecord *rec, AtcMsgId msgId, AtcMsgDir msgDir);
249 string getGateName(FGAIAircraft *aircraft);
252 /******************************************************************************
253 * class FGTowerControl
254 *****************************************************************************/
255 class FGTowerController : public FGATCController
258 TrafficVector activeTraffic;
259 ActiveRunwayVec activeRunways;
263 virtual ~FGTowerController() {};
264 virtual void announcePosition(int id, FGAIFlightPlan *intendedRoute, int currentRoute,
265 double lat, double lon,
266 double hdg, double spd, double alt, double radius, int leg,
267 FGAIAircraft *aircraft);
268 virtual void signOff(int id);
269 virtual void update(int id, double lat, double lon,
270 double heading, double speed, double alt, double dt);
271 virtual bool hasInstruction(int id);
272 virtual FGATCInstruction getInstruction(int id);
274 bool hasActiveTraffic() { return activeTraffic.size() != 0; };
275 TrafficVector &getActiveTraffic() { return activeTraffic; };
278 /******************************************************************************
279 * class FGStartupController
281 *****************************************************************************/
283 class FGStartupController : public FGATCController
286 TrafficVector activeTraffic;
288 time_t lastTransmission;
289 //ActiveRunwayVec activeRunways;
292 FGStartupController();
293 virtual ~FGStartupController() {};
294 virtual void announcePosition(int id, FGAIFlightPlan *intendedRoute, int currentRoute,
295 double lat, double lon,
296 double hdg, double spd, double alt, double radius, int leg,
297 FGAIAircraft *aircraft);
298 virtual void signOff(int id);
299 virtual void update(int id, double lat, double lon,
300 double heading, double speed, double alt, double dt);
301 virtual bool hasInstruction(int id);
302 virtual FGATCInstruction getInstruction(int id);
304 bool hasActiveTraffic() { return activeTraffic.size() != 0; };
305 TrafficVector &getActiveTraffic() { return activeTraffic; };
309 #endif // _TRAFFIC_CONTROL_HXX