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.
21 #include <Main/globals.hxx>
22 #include <Airports/runways.hxx>
23 #include <simgear/math/sg_geodesy.hxx>
24 #include <simgear/debug/logstream.hxx>
27 #include "ATCdisplay.hxx"
29 #include "ATCutils.hxx"
30 #include "commlist.hxx"
31 #include "AILocalTraffic.hxx"
37 TowerPlaneRec::TowerPlaneRec() :
39 clearedToLineUp(false),
40 clearedToTakeOff(false),
41 holdShortReported(false),
42 longFinalReported(false),
43 longFinalAcknowledged(false),
45 finalAcknowledged(false),
49 plane.callsign = "UNKNOWN";
52 TowerPlaneRec::TowerPlaneRec(PlaneRec p) :
54 clearedToLineUp(false),
55 clearedToTakeOff(false),
56 holdShortReported(false),
57 longFinalReported(false),
58 longFinalAcknowledged(false),
60 finalAcknowledged(false),
67 TowerPlaneRec::TowerPlaneRec(Point3D pt) :
69 clearedToLineUp(false),
70 clearedToTakeOff(false),
71 holdShortReported(false),
72 longFinalReported(false),
73 longFinalAcknowledged(false),
75 finalAcknowledged(false),
79 plane.callsign = "UNKNOWN";
83 TowerPlaneRec::TowerPlaneRec(PlaneRec p, Point3D pt) :
85 clearedToLineUp(false),
86 clearedToTakeOff(false),
87 holdShortReported(false),
88 longFinalReported(false),
89 longFinalAcknowledged(false),
91 finalAcknowledged(false),
103 ATCmgr = globals->get_ATC_mgr();
105 // Init the property nodes - TODO - need to make sure we're getting surface winds.
106 wind_from_hdg = fgGetNode("/environment/wind-from-heading-deg", true);
107 wind_speed_knots = fgGetNode("/environment/wind-speed-kts", true);
109 holdListItr = holdList.begin();
110 appListItr = appList.begin();
111 depListItr = depList.begin();
112 rwyListItr = rwyList.begin();
113 circuitListItr = circuitList.begin();
114 trafficListItr = trafficList.begin();
117 FGTower::~FGTower() {
118 if(!separateGround) {
123 void FGTower::Init() {
126 // Pointers to user's position
127 user_lon_node = fgGetNode("/position/longitude-deg", true);
128 user_lat_node = fgGetNode("/position/latitude-deg", true);
129 user_elev_node = fgGetNode("/position/altitude-ft", true);
130 user_hdg_node = fgGetNode("/orientation/heading-deg", true);
132 // Need some way to initialise rwyOccupied flag correctly if the user is on the runway and to know its the user.
133 // I'll punt the startup issue for now though!!!
136 // Setup the ground control at this airport
138 //cout << "Tower ident = " << ident << '\n';
139 if(ATCmgr->GetAirportATCDetails(ident, &a)) {
140 if(a.ground_freq) { // Ground control
141 ground = (FGGround*)ATCmgr->GetATCPointer(ident, GROUND);
142 separateGround = true;
144 // Something has gone wrong :-(
145 SG_LOG(SG_ATC, SG_WARN, "ERROR - ground has frequency but can't get ground pointer :-(");
146 ground = new FGGround(ident);
147 separateGround = false;
150 ground->SetDisplay();
152 ground->SetNoDisplay();
156 // Initialise ground anyway to do the shortest path stuff!
157 // Note that we're now responsible for updating and deleting this - NOT the ATCMgr.
158 ground = new FGGround(ident);
159 separateGround = false;
162 ground->SetDisplay();
164 ground->SetNoDisplay();
168 SG_LOG(SG_ATC, SG_ALERT, "Unable to find airport details for " << ident << " in FGTower::Init()");
169 // Initialise ground anyway to avoid segfault later
170 ground = new FGGround(ident);
171 separateGround = false;
174 ground->SetDisplay();
176 ground->SetNoDisplay();
180 // Get the airport elevation
181 aptElev = dclGetAirportElev(ident.c_str()) * SG_FEET_TO_METER;
185 // FIXME - this currently assumes use of the active rwy by the user.
186 rwyOccupied = OnAnyRunway(Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), 0.0));
188 // Assume the user is started at the threshold ready to take-off
189 TowerPlaneRec* t = new TowerPlaneRec;
190 t->plane.callsign = "Charlie Foxtrot Sierra"; // C-FGFS !!! - fixme - this is a bit hardwired
191 t->opType = TTT_UNKNOWN; // We don't know if the user wants to do circuits or a departure...
192 t->leg = TAKEOFF_ROLL;
195 t->clearedToTakeOff = true;
196 rwyList.push_back(t);
200 void FGTower::Update(double dt) {
201 static int ii = 0; // Counter for spreading the load
202 //cout << "T" << flush;
203 // Each time step, what do we need to do?
204 // We need to go through the list of outstanding requests and acknowedgements
205 // and process at least one of them.
206 // We need to go through the list of planes under our control and check if
207 // any need to be addressed.
208 // We need to check for planes not under our control coming within our
209 // control area and address if necessary.
211 // TODO - a lot of the below probably doesn't need to be called every frame and should be staggered.
213 // Sort the arriving planes
215 // Calculate the eta of each plane to the threshold.
216 // For ground traffic this is the fastest they can get there.
217 // For air traffic this is the middle approximation.
219 doThresholdETACalc();
222 // Order the list of traffic as per expected threshold use and flag any conflicts
224 bool conflicts = doThresholdUseOrder();
227 // sortConficts() !!!
229 // Do one plane from the hold list
231 if(holdList.size()) {
232 //cout << "A" << endl;
233 //cout << "*holdListItr = " << *holdListItr << endl;
234 if(holdListItr == holdList.end()) {
235 holdListItr = holdList.begin();
237 //cout << "*holdListItr = " << *holdListItr << endl;
238 //Process(*holdListItr);
239 TowerPlaneRec* t = *holdListItr;
240 //cout << "t = " << t << endl;
241 if(t->holdShortReported) {
242 //cout << "B" << endl;
243 double responseTime = 10.0; // seconds - this should get more sophisticated at some point
244 if(t->clearanceCounter > responseTime) {
245 //cout << "C" << endl;
247 //cout << "D" << endl;
249 //cout << "E" << endl;
250 // Do nothing for now - consider acknowloging hold short eventually
253 string trns = t->plane.callsign;
254 //if(departed plane < some threshold in time away) {
257 t->clearedToLineUp = true;
258 t->planePtr->RegisterTransmission(3); // cleared to line-up
259 t->leg = TAKEOFF_ROLL;
260 //} else if(arriving plane < some threshold away) {
261 } else if(0) { // FIXME
262 trns += " cleared immediate take-off";
263 // TODO - add traffic is... ?
264 t->clearedToTakeOff = true;
265 t->planePtr->RegisterTransmission(4); // cleared to take-off - TODO differentiate between immediate and normal take-off
266 t->leg = TAKEOFF_ROLL;
268 trns += " cleared for take-off";
269 // TODO - add traffic is... ?
270 t->clearedToTakeOff = true;
271 t->planePtr->RegisterTransmission(4); // cleared to take-off
272 t->leg = TAKEOFF_ROLL;
275 globals->get_ATC_display()->RegisterSingleMessage(trns, 0);
277 t->holdShortReported = false;
278 t->clearanceCounter = 0;
279 rwyList.push_back(t);
281 holdList.erase(holdListItr);
282 holdListItr = holdList.begin();
285 // possibly tell him to hold and what position he is?
288 t->clearanceCounter += (dt * holdList.size());
295 // Do the runway list - we'll do the whole runway list since it's important and there'll never be many planes on the rwy at once!!
298 if(!rwyList.size()) {
301 rwyListItr = rwyList.begin();
302 TowerPlaneRec* t = *rwyListItr;
304 bool on_rwy = OnActiveRunway(Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), 0.0));
305 // TODO - how do we find the position when it's not the user?
307 if((t->opType == INBOUND) || (t->opType == STRAIGHT_IN)) {
310 // TODO - tell it to taxi / contact ground / don't delete it etc!
311 } else if(t->opType == OUTBOUND) {
312 depList.push_back(t);
314 } else if(t->opType == CIRCUIT) {
315 circuitList.push_back(t);
317 } else if(t->opType == TTT_UNKNOWN) {
318 depList.push_back(t);
319 circuitList.push_back(t);
322 // HELP - we shouldn't ever get here!!!
325 } // else TODO figure out what to do when it's not the user
330 // do the ciruit list
332 // Clear the constraints - we recalculate here.
334 downwind_leg_pos = 0.0;
335 crosswind_leg_pos = 0.0;
336 if(circuitList.size()) {
337 circuitListItr = circuitList.begin(); // TODO - at the moment we're constraining plane 2 based on plane 1 - this won't work for 3 planes in the circuit!!
338 TowerPlaneRec* t = *circuitListItr;
339 Point3D tortho = ortho.ConvertToLocal(t->pos);
341 // Need to figure out which leg he's on
342 double ho = GetAngleDiff_deg(user_hdg_node->getDoubleValue(), rwy.hdg);
343 // TODO FIXME - get the wind and convert this to track, or otherwise use track somehow!!!
344 // If it's gusty might need to filter the value, although we are leaving 30 degrees each way leeway!
346 // could be either takeoff, climbout or landing - check orthopos.y
347 if((tortho.y() < 0) || (t->leg == TURN4) || (t->leg == LANDING_ROLL)) {
348 t->leg = LANDING_ROLL;
349 //cout << "Landing_roll\n";
351 t->leg = CLIMBOUT; // TODO - check elev wrt. apt elev to differentiate takeoff roll and climbout
352 //cout << "Climbout\n";
354 } else if(abs(ho) < 60) {
356 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
357 if((t->leg == CLIMBOUT) || (t->leg == TURN1)) {
364 } else if(abs(ho) < 120) {
366 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
367 if((t->leg == TURN1) || (t->leg == CROSSWIND)) {
369 //cout << "Crosswind\n";
374 } else if(abs(ho) < 150) {
376 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
377 if((t->leg == CROSSWIND) || (t->leg == TURN2)) {
387 //cout << "Downwind\n";
390 t->leg = t->planePtr->GetLeg();
394 // Base leg must be at least as far out as the plane is - actually possibly not necessary for separation, but we'll use that for now.
395 base_leg_pos = tortho.y();
398 // Fall through to base
400 base_leg_pos = tortho.y();
403 // Fall through to downwind
405 // Only have the downwind leg pos as turn-to-base constraint if more negative than we already have.
406 base_leg_pos = (tortho.y() < base_leg_pos ? tortho.y() : base_leg_pos);
407 downwind_leg_pos = tortho.x(); // Assume that a following plane can simply be constrained by the immediately in front downwind plane
410 // Fall through to crosswind
412 crosswind_leg_pos = tortho.y();
415 // Fall through to climbout
417 // Only use current by constraint as largest
418 crosswind_leg_pos = (tortho.y() > crosswind_leg_pos ? tortho.x() : crosswind_leg_pos);
434 if(!separateGround) {
435 // The display stuff might have to get more clever than this when not separate
436 // since the tower and ground might try communicating simultaneously even though
437 // they're mean't to be the same contoller/frequency!!
439 ground->SetDisplay();
441 ground->SetNoDisplay();
447 // How big should ii get - ie how long should the update cycle interval stretch?
454 // Figure out which runways are active.
455 // For now we'll just be simple and do one active runway - eventually this will get much more complex
456 // This is a private function - public interface to the results of this is through GetActiveRunway
457 void FGTower::DoRwyDetails() {
458 //cout << "GetRwyDetails called" << endl;
460 // Based on the airport-id and wind get the active runway
461 SGPath path( globals->get_fg_root() );
462 path.append( "Airports" );
463 path.append( "runways.mk4" );
464 FGRunways runways( path.c_str() );
467 double hdg = wind_from_hdg->getDoubleValue();
468 double speed = wind_speed_knots->getDoubleValue();
469 hdg = (speed == 0.0 ? 270.0 : hdg);
470 //cout << "Heading = " << hdg << '\n';
473 bool rwyGood = runways.search(ident, int(hdg), &runway);
475 activeRwy = runway.rwy_no;
476 rwy.rwyID = runway.rwy_no;
477 SG_LOG(SG_ATC, SG_INFO, "Active runway for airport " << ident << " is " << activeRwy);
479 // Get the threshold position
480 double other_way = runway.heading - 180.0;
481 while(other_way <= 0.0) {
484 // move to the +l end/center of the runway
485 //cout << "Runway center is at " << runway.lon << ", " << runway.lat << '\n';
486 Point3D origin = Point3D(runway.lon, runway.lat, aptElev);
487 Point3D ref = origin;
488 double tshlon, tshlat, tshr;
489 double tolon, tolat, tor;
490 rwy.length = runway.length * SG_FEET_TO_METER;
491 rwy.width = runway.width * SG_FEET_TO_METER;
492 geo_direct_wgs_84 ( aptElev, ref.lat(), ref.lon(), other_way,
493 rwy.length / 2.0 - 25.0, &tshlat, &tshlon, &tshr );
494 geo_direct_wgs_84 ( aptElev, ref.lat(), ref.lon(), runway.heading,
495 rwy.length / 2.0 - 25.0, &tolat, &tolon, &tor );
496 // Note - 25 meters in from the runway end is a bit of a hack to put the plane ahead of the user.
497 // now copy what we need out of runway into rwy
498 rwy.threshold_pos = Point3D(tshlon, tshlat, aptElev);
499 Point3D takeoff_end = Point3D(tolon, tolat, aptElev);
500 //cout << "Threshold position = " << tshlon << ", " << tshlat << ", " << aptElev << '\n';
501 //cout << "Takeoff position = " << tolon << ", " << tolat << ", " << aptElev << '\n';
502 rwy.hdg = runway.heading;
503 // Set the projection for the local area based on this active runway
504 ortho.Init(rwy.threshold_pos, rwy.hdg);
505 rwy.end1ortho = ortho.ConvertToLocal(rwy.threshold_pos); // should come out as zero
506 rwy.end2ortho = ortho.ConvertToLocal(takeoff_end);
508 SG_LOG(SG_ATC, SG_ALERT, "Help - can't get good runway in FGTower!!");
514 // Figure out if a given position lies on the active runway
515 // Might have to change when we consider more than one active rwy.
516 bool FGTower::OnActiveRunway(Point3D pt) {
517 // TODO - check that the centre calculation below isn't confused by displaced thesholds etc.
518 Point3D xyc((rwy.end1ortho.x() + rwy.end2ortho.x())/2.0, (rwy.end1ortho.y() + rwy.end2ortho.y())/2.0, 0.0);
519 Point3D xyp = ortho.ConvertToLocal(pt);
521 //cout << "Length offset = " << fabs(xyp.y() - xyc.y()) << '\n';
522 //cout << "Width offset = " << fabs(xyp.x() - xyc.x()) << '\n';
524 double rlen = rwy.length/2.0 + 5.0;
525 double rwidth = rwy.width/2.0;
526 double ldiff = fabs(xyp.y() - xyc.y());
527 double wdiff = fabs(xyp.x() - xyc.x());
529 return((ldiff < rlen) && (wdiff < rwidth));
533 // Figure out if a given position lies on any runway or not
534 // Only call this at startup - reading the runways database is expensive and needs to be fixed!
535 bool FGTower::OnAnyRunway(Point3D pt) {
537 double dist = current_commlist->FindClosest(lon, lat, elev, ad, TOWER, 10.0);
541 // Based on the airport-id, go through all the runways and check for a point in them
542 SGPath spath( globals->get_fg_root() );
543 spath.append( "Airports" );
544 spath.append( "runways.mk4" );
545 FGRunways runways( spath.c_str() );
547 // TODO - do we actually need to search for the airport - surely we already know our ident and
548 // can just search runways of our airport???
549 //cout << "Airport ident is " << ad.ident << '\n';
551 bool rwyGood = runways.search(ad.ident, &runway);
553 SG_LOG(SG_ATC, SG_WARN, "Unable to find any runways for airport ID " << ad.ident << " in FGTower");
556 while(runway.id == ad.ident) {
557 on = OnRunway(pt, runway);
558 //cout << "Runway " << runway.rwy_no << ": On = " << (on ? "true\n" : "false\n");
560 runways.next(&runway);
566 // Calculate the eta of each plane to the threshold.
567 // For ground traffic this is the fastest they can get there.
568 // For air traffic this is the middle approximation.
569 void FGTower::doThresholdETACalc() {
570 // For now we'll be very crude and hardwire expected speeds to C172-like values
571 // The speeds below are specified in knots IAS and then converted to m/s
572 double app_ias = 100.0 * 0.514444; // Speed during straight-in approach
573 double circuit_ias = 80.0 * 0.514444; // Speed around circuit
574 double final_ias = 70.0 * 0.514444; // Speed during final approach
576 tower_plane_rec_list_iterator twrItr;
578 // Sign convention - dist_out is -ve for approaching planes and +ve for departing planes
579 // dist_across is +ve in the pattern direction - ie a plane correctly on downwind will have a +ve dist_across
580 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
581 TowerPlaneRec* tpr = *twrItr;
582 Point3D op = ortho.ConvertToLocal(tpr->pos);
583 double dist_out_m = op.y();
584 double dist_across_m = fabs(op.x()); // FIXME = the fabs is a hack to cope with the fact that we don't know the circuit direction yet
585 //cout << "Doing ETA calc for " << tpr->plane.callsign << '\n';
586 if(tpr->opType == CIRCUIT) {
587 // It's complicated - depends on if base leg is delayed or not
588 if(tpr->leg == LANDING_ROLL) {
590 } else if((tpr->leg == FINAL) || (tpr->leg == TURN4)) {
591 tpr->eta = fabs(dist_out_m) / final_ias;
592 } else if((tpr->leg == BASE) || (tpr->leg == TURN3)) {
593 tpr->eta = (fabs(dist_out_m) / final_ias) + (dist_across_m / circuit_ias);
595 // Need to calculate where base leg is likely to be
596 // FIXME - for now I'll hardwire it to 1000m which is what AILocalTraffic uses!!!
597 // TODO - as a matter of design - AILocalTraffic should get the nominal no-traffic base turn distance from Tower, since in real life the published pattern might differ from airport to airport
598 double nominal_base_dist_out_m = -1000;
599 double current_base_dist_out_m = nominal_base_dist_out_m;
600 double nominal_dist_across_m = 1000; // Hardwired value from AILocalTraffic
601 double nominal_cross_dist_out_m = 1000; // Bit of a guess - AI plane turns to crosswind at 600ft agl.
602 tpr->eta = fabs(current_base_dist_out_m) / final_ias; // final
603 if((tpr->leg == DOWNWIND) || (tpr->leg == TURN2)) {
604 tpr->eta += dist_across_m / circuit_ias;
605 tpr->eta += fabs(current_base_dist_out_m - dist_out_m) / circuit_ias;
606 } else if((tpr->leg == CROSSWIND) || (tpr->leg == TURN1)) {
607 tpr->eta += nominal_dist_across_m / circuit_ias; // should we use the dist across of the previous plane if there is previous still on downwind?
608 tpr->eta += fabs(current_base_dist_out_m - nominal_cross_dist_out_m) / circuit_ias;
609 tpr->eta += (nominal_dist_across_m - dist_across_m) / circuit_ias;
611 // We've only just started - why not use a generic estimate?
614 } else if((tpr->opType == INBOUND) || (tpr->opType == STRAIGHT_IN)) {
617 // Must be outbound - ignore it!
619 //cout << "ETA = " << tpr->eta << '\n';
624 bool FGTower::doThresholdUseOrder() {
628 void FGTower::doCommunication() {
631 void FGTower::ContactAtHoldShort(PlaneRec plane, FGAIPlane* requestee, tower_traffic_type operation) {
632 // HACK - assume that anything contacting at hold short is new for now - FIXME LATER
633 TowerPlaneRec* t = new TowerPlaneRec;
635 t->planePtr = requestee;
636 t->holdShortReported = true;
637 t->clearanceCounter = 0;
638 t->clearedToLineUp = false;
639 t->clearedToTakeOff = false;
640 t->opType = operation;
642 // HACK ALERT - THIS IS HARDWIRED FOR TESTING - FIXME TODO ETC
645 //cout << "t = " << t << '\n';
647 holdList.push_back(t);
650 void FGTower::RequestLandingClearance(string ID) {
651 //cout << "Request Landing Clearance called...\n";
653 void FGTower::RequestDepartureClearance(string ID) {
654 //cout << "Request Departure Clearance called...\n";
656 //void FGTower::ReportFinal(string ID);
657 //void FGTower::ReportLongFinal(string ID);
658 //void FGTower::ReportOuterMarker(string ID);
659 //void FGTower::ReportMiddleMarker(string ID);
660 //void FGTower::ReportInnerMarker(string ID);
661 //void FGTower::ReportGoingAround(string ID);
662 void FGTower::ReportRunwayVacated(string ID) {
663 //cout << "Report Runway Vacated Called...\n";