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.
26 # include <strings.h> // bcopy()
28 # include <string.h> // MSVC doesn't have strings.h
31 #include <Main/globals.hxx>
32 #include <Airports/runways.hxx>
33 #include <simgear/math/sg_geodesy.hxx>
34 #include <simgear/debug/logstream.hxx>
37 #include "ATCdisplay.hxx"
39 #include "ATCutils.hxx"
40 #include "ATCDialog.hxx"
41 #include "commlist.hxx"
42 #include "AILocalTraffic.hxx"
48 TowerPlaneRec::TowerPlaneRec() :
51 clearedToLineUp(false),
52 clearedToTakeOff(false),
53 holdShortReported(false),
54 downwindReported(false),
55 longFinalReported(false),
56 longFinalAcknowledged(false),
58 finalAcknowledged(false),
59 rwyVacatedReported(false),
60 rwyVacatedAcknowledged(false),
61 goAroundReported(false),
62 instructedToGoAround(false),
65 vfrArrivalReported(false),
66 vfrArrivalAcknowledged(false),
69 landingType(AIP_LT_UNKNOWN),
72 plane.callsign = "UNKNOWN";
75 TowerPlaneRec::TowerPlaneRec(PlaneRec p) :
78 clearedToLineUp(false),
79 clearedToTakeOff(false),
80 holdShortReported(false),
81 downwindReported(false),
82 longFinalReported(false),
83 longFinalAcknowledged(false),
85 finalAcknowledged(false),
86 rwyVacatedReported(false),
87 rwyVacatedAcknowledged(false),
88 goAroundReported(false),
89 instructedToGoAround(false),
92 vfrArrivalReported(false),
93 vfrArrivalAcknowledged(false),
96 landingType(AIP_LT_UNKNOWN),
102 TowerPlaneRec::TowerPlaneRec(Point3D pt) :
104 clearedToLand(false),
105 clearedToLineUp(false),
106 clearedToTakeOff(false),
107 holdShortReported(false),
108 downwindReported(false),
109 longFinalReported(false),
110 longFinalAcknowledged(false),
111 finalReported(false),
112 finalAcknowledged(false),
113 rwyVacatedReported(false),
114 rwyVacatedAcknowledged(false),
115 goAroundReported(false),
116 instructedToGoAround(false),
119 vfrArrivalReported(false),
120 vfrArrivalAcknowledged(false),
123 landingType(AIP_LT_UNKNOWN),
126 plane.callsign = "UNKNOWN";
130 TowerPlaneRec::TowerPlaneRec(PlaneRec p, Point3D pt) :
132 clearedToLand(false),
133 clearedToLineUp(false),
134 clearedToTakeOff(false),
135 holdShortReported(false),
136 downwindReported(false),
137 longFinalReported(false),
138 longFinalAcknowledged(false),
139 finalReported(false),
140 finalAcknowledged(false),
141 rwyVacatedReported(false),
142 rwyVacatedAcknowledged(false),
143 goAroundReported(false),
144 instructedToGoAround(false),
147 vfrArrivalReported(false),
148 vfrArrivalAcknowledged(false),
151 landingType(AIP_LT_UNKNOWN),
161 /*******************************************
164 Currently user is assumed to have taken off again when leaving the runway - check speed/elev for taxiing-in. (MAJOR)
166 Use track instead of heading to determine what leg of the circuit the user is flying. (MINOR)
168 Use altitude as well as position to try to determine if the user has left the circuit. (MEDIUM - other issues as well).
170 Currently HoldShortReported code assumes there will be only one plane holding for the runway at once and
171 will break when planes start queueing. (CRITICAL)
173 Report-Runway-Vacated is left as only user ATC option following a go-around. (MAJOR)
175 Report-Downwind is not added as ATC option when user takes off to fly a circuit. (MAJOR)
177 eta of USER can be calculated very wrongly in circuit if flying straight out and turn4 etc are with +ve ortho y.
178 This can then screw up circuit ordering for other planes (MEDIUM)
180 USER leaving circuit needs to be more robustly considered when intentions unknown
181 Currently only considered during climbout and breaks when user turns (MEDIUM).
183 GetPos() of the AI planes is called erratically - either too much or not enough. (MINOR)
185 GO-AROUND is instructed very late at < 12s to landing - possibly make more dependent on chance of rwy clearing before landing (FEATURE)
187 Need to make clear when TowerPlaneRecs do or don't get deleted in RemoveFromCircuitList etc. (MINOR until I misuse it - then CRITICAL!)
189 FGTower::RemoveAllUserDialogOptions() really ought to be replaced by an ATCDialog::clear_entries() function. (MINOR - efficiency).
191 At the moment planes in the lists are not guaranteed to always have a sensible ETA - it should be set as part of AddList functions, and lists should only be accessed this way. (FAIRLY MAJOR).
192 *******************************************/
195 ATCmgr = globals->get_ATC_mgr();
199 // Init the property nodes - TODO - need to make sure we're getting surface winds.
200 wind_from_hdg = fgGetNode("/environment/wind-from-heading-deg", true);
201 wind_speed_knots = fgGetNode("/environment/wind-speed-kt", true);
204 update_count_max = 15;
206 holdListItr = holdList.begin();
208 appListItr = appList.begin();
209 depListItr = depList.begin();
210 rwyListItr = rwyList.begin();
211 circuitListItr = circuitList.begin();
212 trafficListItr = trafficList.begin();
214 vacatedListItr = vacatedList.begin();
218 timeSinceLastDeparture = 9999;
221 nominal_downwind_leg_pos = 1000.0;
222 nominal_base_leg_pos = -1000.0;
223 // TODO - set nominal crosswind leg pos based on minimum distance from takeoff end of rwy.
225 _departureControlled = false;
228 FGTower::~FGTower() {
229 if(!separateGround) {
234 void FGTower::Init() {
235 //cout << "Initialising tower " << ident << '\n';
237 // Pointers to user's position
238 user_lon_node = fgGetNode("/position/longitude-deg", true);
239 user_lat_node = fgGetNode("/position/latitude-deg", true);
240 user_elev_node = fgGetNode("/position/altitude-ft", true);
241 user_hdg_node = fgGetNode("/orientation/heading-deg", true);
243 // Need some way to initialise rwyOccupied flag correctly if the user is on the runway and to know its the user.
244 // I'll punt the startup issue for now though!!!
247 // Setup the ground control at this airport
249 //cout << "Tower ident = " << ident << '\n';
250 if(ATCmgr->GetAirportATCDetails(ident, &a)) {
251 if(a.ground_freq) { // Ground control
252 ground = (FGGround*)ATCmgr->GetATCPointer(ident, GROUND);
253 separateGround = true;
255 // Something has gone wrong :-(
256 SG_LOG(SG_ATC, SG_WARN, "ERROR - ground has frequency but can't get ground pointer :-(");
257 ground = new FGGround(ident);
258 separateGround = false;
261 ground->SetDisplay();
263 ground->SetNoDisplay();
267 // Initialise ground anyway to do the shortest path stuff!
268 // Note that we're now responsible for updating and deleting this - NOT the ATCMgr.
269 ground = new FGGround(ident);
270 separateGround = false;
273 ground->SetDisplay();
275 ground->SetNoDisplay();
279 SG_LOG(SG_ATC, SG_ALERT, "Unable to find airport details for " << ident << " in FGTower::Init()");
280 // Initialise ground anyway to avoid segfault later
281 ground = new FGGround(ident);
282 separateGround = false;
285 ground->SetDisplay();
287 ground->SetNoDisplay();
291 // TODO - attempt to get a departure control pointer to see if we need to hand off departing traffic to departure.
293 // Get the airport elevation
294 aptElev = dclGetAirportElev(ident.c_str());
296 // TODO - this function only assumes one active rwy.
299 // TODO - this currently assumes only one active runway.
300 rwyOccupied = OnActiveRunway(Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), 0.0));
302 //cout << "User found on active runway\n";
303 // Assume the user is started at the threshold ready to take-off
304 TowerPlaneRec* t = new TowerPlaneRec;
305 t->plane.callsign = fgGetString("/sim/user/callsign");
306 t->plane.type = GA_SINGLE; // FIXME - hardwired!!
307 t->opType = TTT_UNKNOWN; // We don't know if the user wants to do circuits or a departure...
308 t->landingType = AIP_LT_UNKNOWN;
309 t->leg = TAKEOFF_ROLL;
312 t->clearedToTakeOff = true;
313 rwyList.push_back(t);
316 //cout << "User not on active runway\n";
317 // For now assume that this means the user is not at the airport and is in the air.
318 // TODO FIXME - this will break when user starts on apron, at hold short, etc.
319 if(!OnAnyRunway(Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), 0.0))) {
320 //cout << ident << " ADD 0\n";
321 current_atcdialog->add_entry(ident, "@AP Tower @CS @MI miles @CD of the airport for full stop with the ATIS", "Contact tower for VFR arrival (full stop)", TOWER, (int)USER_REQUEST_VFR_ARRIVAL_FULL_STOP);
326 void FGTower::Update(double dt) {
327 //cout << "T" << endl;
328 // Each time step, what do we need to do?
329 // We need to go through the list of outstanding requests and acknowedgements
330 // and process at least one of them.
331 // We need to go through the list of planes under our control and check if
332 // any need to be addressed.
333 // We need to check for planes not under our control coming within our
334 // control area and address if necessary.
336 // TODO - a lot of the below probably doesn't need to be called every frame and should be staggered.
338 // Sort the arriving planes
341 if(ident == "KEMT") {
342 cout << update_count << "\ttL: " << trafficList.size() << " cL: " << circuitList.size() << " hL: " << holdList.size() << " aL: " << appList.size() << '\n';
345 //if(ident == "EGNX") cout << display << '\n';
347 if(departed != false) {
348 timeSinceLastDeparture += dt;
349 //if(ident == "KEMT")
350 // cout << " dt = " << dt << " timeSinceLastDeparture = " << timeSinceLastDeparture << '\n';
353 //cout << ident << " respond = " << respond << " responseReqd = " << responseReqd << '\n';
355 if(!responseReqd) SG_LOG(SG_ATC, SG_ALERT, "ERROR - respond is true and responseReqd is false in FGTower::Update(...)");
358 responseReqd = false;
361 // Calculate the eta of each plane to the threshold.
362 // For ground traffic this is the fastest they can get there.
363 // For air traffic this is the middle approximation.
364 if(update_count == 1) {
365 doThresholdETACalc();
368 // Order the list of traffic as per expected threshold use and flag any conflicts
369 if(update_count == 2) {
370 //bool conflicts = doThresholdUseOrder();
371 doThresholdUseOrder();
374 // sortConficts() !!!
376 if(update_count == 4) {
380 // Uggh - HACK - why have we got rwyOccupied - wouldn't simply testing rwyList.size() do?
387 if(update_count == 5 && rwyOccupied) {
391 if(update_count == 6) {
392 CheckCircuitList(dt);
395 if(update_count == 7) {
396 CheckApproachList(dt);
399 if(update_count == 8) {
400 CheckDepartureList(dt);
403 // TODO - do one plane from the departure list and set departed = false when out of consideration
407 if(!separateGround) {
408 // The display stuff might have to get more clever than this when not separate
409 // since the tower and ground might try communicating simultaneously even though
410 // they're mean't to be the same contoller/frequency!!
411 // We could also get rid of this by overloading FGATC's Set(No)Display() functions.
413 ground->SetDisplay();
415 ground->SetNoDisplay();
421 // How big should ii get - ie how long should the update cycle interval stretch?
422 if(update_count >= update_count_max) {
426 // Call the base class update for the response time handling.
430 if(ident == "KEMT") {
431 // For AI debugging convienience - may be removed
433 user_pos.setlon(user_lon_node->getDoubleValue());
434 user_pos.setlat(user_lat_node->getDoubleValue());
435 user_pos.setelev(user_elev_node->getDoubleValue());
436 Point3D user_ortho_pos = ortho.ConvertToLocal(user_pos);
437 fgSetDouble("/AI/user/ortho-x", user_ortho_pos.x());
438 fgSetDouble("/AI/user/ortho-y", user_ortho_pos.y());
439 fgSetDouble("/AI/user/elev", user_elev_node->getDoubleValue());
443 //cout << "Done T" << endl;
446 void FGTower::ReceiveUserCallback(int code) {
447 if(code == (int)USER_REQUEST_VFR_DEPARTURE) {
448 //cout << "User requested departure\n";
449 } else if(code == (int)USER_REQUEST_VFR_ARRIVAL) {
450 VFRArrivalContact("USER");
451 } else if(code == (int)USER_REQUEST_VFR_ARRIVAL_FULL_STOP) {
452 VFRArrivalContact("USER", FULL_STOP);
453 } else if(code == (int)USER_REQUEST_VFR_ARRIVAL_TOUCH_AND_GO) {
454 VFRArrivalContact("USER", TOUCH_AND_GO);
455 } else if(code == (int)USER_REPORT_DOWNWIND) {
456 ReportDownwind("USER");
457 } else if(code == (int)USER_REPORT_3_MILE_FINAL) {
458 // For now we'll just call report final instead of report long final to avoid having to alter the response code
460 } else if(code == (int)USER_REPORT_RWY_VACATED) {
461 ReportRunwayVacated("USER");
462 } else if(code == (int)USER_REPORT_GOING_AROUND) {
463 ReportGoingAround("USER");
467 // **************** RESPONSE FUNCTIONS ****************
469 void FGTower::Respond() {
470 //cout << "\nEntering Respond, responseID = " << responseID << endl;
471 TowerPlaneRec* t = FindPlane(responseID);
474 if(t->vfrArrivalReported && !t->vfrArrivalAcknowledged) {
475 //cout << "Tower " << ident << " is responding to VFR arrival reported...\n";
476 // Testing - hardwire straight in for now
477 string trns = t->plane.callsign;
481 // Should we clear staight in or for downwind entry?
482 // For now we'll clear straight in if greater than 1km from a line drawn through the threshold perpendicular to the rwy.
483 // Later on we might check the actual heading and direct some of those to enter on downwind or base.
484 Point3D op = ortho.ConvertToLocal(t->pos);
486 trns += " Report three mile straight-in runway ";
487 t->opType = STRAIGHT_IN;
489 current_atcdialog->add_entry(ident, "@AP Tower @CS @MI mile final Runway @RW", "Report Final", TOWER, (int)USER_REPORT_3_MILE_FINAL);
491 t->planePtr->RegisterTransmission(14);
494 // For now we'll just request reporting downwind.
495 // TODO - In real life something like 'report 2 miles southwest right downwind rwy 19R' might be used
496 // but I'm not sure how to handle all permutations of which direction to tell to report from yet.
498 //cout << "Responding, rwy.patterDirection is " << rwy.patternDirection << '\n';
499 trns += ((rwy.patternDirection == 1) ? "right " : "left ");
500 trns += "downwind runway ";
502 // leave it in the app list until it gets into pattern though.
504 current_atcdialog->add_entry(ident, "@AP Tower @CS Downwind @RW", "Report Downwind", TOWER, (int)USER_REPORT_DOWNWIND);
506 t->planePtr->RegisterTransmission(15);
509 trns += ConvertRwyNumToSpokenString(activeRwy);
511 globals->get_ATC_display()->RegisterSingleMessage(trns, 0);
513 //cout << "Not displaying, trns was " << trns << '\n';
515 t->vfrArrivalAcknowledged = true;
516 } else if(t->downwindReported) {
517 //cout << "Tower " << ident << " is responding to downwind reported...\n";
518 ProcessDownwindReport(t);
519 t->downwindReported = false;
520 } else if(t->holdShortReported) {
521 //cout << "Tower " << ident << " is reponding to holdShortReported...\n";
523 if(rwyOccupied) { // TODO - ought to add a sanity check that it isn't this plane only on the runway (even though it shouldn't be!!)
524 // Do nothing for now - consider acknowloging hold short eventually
526 ClearHoldingPlane(t);
527 t->leg = TAKEOFF_ROLL;
528 rwyList.push_back(t);
530 // WARNING - WE ARE ASSUMING ONLY ONE PLANE REPORTING HOLD AT A TIME BELOW
531 // FIXME TODO - FIX THIS!!!
532 if(holdList.size()) {
533 if(holdListItr == holdList.end()) {
534 holdListItr = holdList.begin();
536 holdList.erase(holdListItr);
537 holdListItr = holdList.begin();
541 // Tell him to hold and what position he is.
542 // Not currently sure under which circumstances we do or don't bother transmitting this.
543 string trns = t->plane.callsign;
544 trns += " hold position";
546 globals->get_ATC_display()->RegisterSingleMessage(trns, 0);
548 // TODO - add some idea of what traffic is blocking him.
550 t->holdShortReported = false;
551 } else if(t->finalReported && !(t->finalAcknowledged)) {
552 //cout << "Tower " << ident << " is responding to finalReported...\n";
554 string trns = t->plane.callsign;
555 //cout << (t->nextOnRwy ? "Next on rwy " : "Not next!! ");
556 //cout << (rwyOccupied ? "RWY OCCUPIED!!\n" : "Rwy not occupied\n");
557 if(t->nextOnRwy && !rwyOccupied && !(t->instructedToGoAround)) {
558 if(t->landingType == FULL_STOP) {
559 trns += " cleared to land ";
561 trns += " cleared for the option ";
564 t->clearedToLand = true;
565 // Maybe remove report downwind from menu here as well incase user didn't bother to?
567 //cout << "ADD VACATED B\n";
568 // Put going around at the top (and hence default) since that'll be more desperate,
569 // or put rwy vacated at the top since that'll be more common?
570 current_atcdialog->add_entry(ident, "@CS Going Around", "Report going around", TOWER, USER_REPORT_GOING_AROUND);
571 current_atcdialog->add_entry(ident, "@CS Clear of the runway", "Report runway vacated", TOWER, USER_REPORT_RWY_VACATED);
573 t->planePtr->RegisterTransmission(7);
575 } else if(t->eta < 20) {
576 // Do nothing - we'll be telling it to go around in less than 10 seconds if the
577 // runway doesn't clear so no point in calling "continue approach".
580 trns += " continue approach";
581 t->clearedToLand = false;
583 if(_display && disp) {
584 globals->get_ATC_display()->RegisterSingleMessage(trns);
586 t->finalAcknowledged = true;
587 } else if(t->rwyVacatedReported && !(t->rwyVacatedAcknowledged)) {
588 ProcessRunwayVacatedReport(t);
589 t->rwyVacatedAcknowledged = true;
592 //freqClear = true; // FIXME - set this to come true after enough time to render the message
593 _releaseCounter = 0.0;
595 _runReleaseCounter = true;
596 //cout << "Done Respond\n" << endl;
599 void FGTower::ProcessDownwindReport(TowerPlaneRec* t) {
601 int a = 0; // Count of preceding planes on approach
602 bool cf = false; // conflicting traffic on final
603 bool cc = false; // preceding traffic in circuit
605 for(tower_plane_rec_list_iterator twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
606 if((*twrItr)->plane.callsign == responseID) break;
610 if(i > 1) { cc = true; }
611 doThresholdETACalc();
613 for(tower_plane_rec_list_iterator twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
614 if((*twrItr)->eta < (t->eta + 45)) {
618 // This should set the flagged plane to be the last conflicting one, and hence the one to follow.
619 // It ignores the fact that we might have problems slotting into the approach traffic behind it -
620 // eventually we'll need some fancy algorithms for that!
623 string trns = t->plane.callsign;
625 trns += ConvertNumToSpokenDigits(i + a);
626 // This assumes that the number spoken is landing position, not circuit position, since some of the traffic might be on straight-in final.
629 if((i == 1) && (!rwyList.size()) && (t->nextOnRwy) && (!cf)) { // Unfortunately nextOnRwy currently doesn't handle circuit/straight-in ordering properly at present, hence the cf check below.
630 trns += "Cleared to land"; // TODO - clear for the option if appropriate
631 t->clearedToLand = true;
632 if(!t->isUser) t->planePtr->RegisterTransmission(7);
633 } else if((i+a) > 1) {
634 //First set tt to point to the correct preceding plane - final or circuit
636 tt = (tf->eta < tc->eta ? tf : tc);
642 // We should never get here!
643 SG_LOG(SG_ATC, SG_ALERT, "ALERT - Logic error in FGTower::ProcessDownwindReport");
645 trns += "Follow the ";
646 string s = tt->plane.callsign;
650 if((tt->opType) == CIRCUIT) {
651 if(tt->planePtr->GetLeg() == FINAL) {
653 } else if(tt->planePtr->GetLeg() == TURN4) {
654 trns += " turning final";
655 } else if(tt->planePtr->GetLeg() == BASE) {
657 } else if(tt->planePtr->GetLeg() == TURN3) {
658 trns += " turning base";
661 double miles_out = CalcDistOutMiles(tt);
663 trns += " on short final";
666 trns += ConvertNumToSpokenDigits((int)miles_out);
667 trns += " mile final";
672 globals->get_ATC_display()->RegisterSingleMessage(trns);
675 if(t->opType == TTT_UNKNOWN) t->opType = CIRCUIT;
676 //cout << "ADD VACATED A\n";
677 // Put going around at the top (and hence default) since that'll be more desperate,
678 // or put rwy vacated at the top since that'll be more common?
679 //cout << "ident = " << ident << ", adding go-around option\n";
680 current_atcdialog->add_entry(ident, "@CS Going Around", "Report going around", TOWER, USER_REPORT_GOING_AROUND);
681 current_atcdialog->add_entry(ident, "@CS Clear of the runway", "Report runway vacated", TOWER, USER_REPORT_RWY_VACATED);
685 void FGTower::ProcessRunwayVacatedReport(TowerPlaneRec* t) {
686 //cout << "Processing rwy vacated...\n";
687 if(t->isUser) current_atcdialog->remove_entry(ident, USER_REPORT_GOING_AROUND, TOWER);
688 string trns = t->plane.callsign;
690 trns += " Contact ground on ";
691 double f = globals->get_ATC_mgr()->GetFrequency(ident, GROUND) / 100.0;
693 sprintf(buf, "%.2f", f);
696 if(!t->isUser) t->planePtr->RegisterTransmission(5);
699 trns += " cleared for taxi to the GA parking";
700 if(!t->isUser) t->planePtr->RegisterTransmission(6); // TODO - this is a mega-hack!!
702 //cout << "trns = " << trns << '\n';
704 globals->get_ATC_display()->RegisterSingleMessage(trns);
706 RemoveFromRwyList(t->plane.callsign);
708 // Maybe we should check that the plane really *has* vacated the runway!
711 // *********** END RESPONSE FUNCTIONS *****************
713 // Currently this assumes we *are* next on the runway and doesn't check for planes about to land -
714 // this should be done prior to calling this function.
715 void FGTower::ClearHoldingPlane(TowerPlaneRec* t) {
716 //cout << "Entering ClearHoldingPlane..." << endl;
718 string trns = t->plane.callsign;
719 //if(departed plane < some threshold in time away) {
721 //if(timeSinceLastDeparture <= 60.0 && departed == true) {
723 t->clearedToLineUp = true;
724 t->planePtr->RegisterTransmission(3); // cleared to line-up
725 //} else if(arriving plane < some threshold away) {
726 } else if(GetTrafficETA(2) < 150.0 && (timeSinceLastDeparture > 60.0 || departed == false)) { // Hack - hardwired time
727 trns += " cleared immediate take-off";
728 if(trafficList.size()) {
729 tower_plane_rec_list_iterator trfcItr = trafficList.begin();
730 trfcItr++; // At the moment the holding plane should be first in trafficList.
731 // Note though that this will break if holding planes aren't put in trafficList in the future.
732 TowerPlaneRec* trfc = *trfcItr;
733 trns += "... traffic is";
734 switch(trfc->plane.type) {
738 trns += " a Cessna"; // TODO - add ability to specify actual plane type somewhere
744 trns += " a King-air";
747 trns += " a Learjet";
750 trns += " a Regional";
759 //if(trfc->opType == STRAIGHT_IN || trfc->opType == TTT_UNKNOWN) {
760 if(trfc->opType == STRAIGHT_IN) {
761 double miles_out = CalcDistOutMiles(trfc);
766 trns += ConvertNumToSpokenDigits((int)miles_out);
767 trns += " mile final";
769 } else if(trfc->opType == CIRCUIT) {
770 //cout << "Getting leg of " << trfc->plane.callsign << '\n';
776 trns += " turning final";
782 trns += " turning base";
785 trns += " in circuit"; // At the moment the user plane is generally flagged as unknown opType when downwind incase its a downwind departure which means we won't get here.
787 // And to eliminate compiler warnings...
788 case TAKEOFF_ROLL: break;
789 case CLIMBOUT: break;
791 case CROSSWIND: break;
793 case LANDING_ROLL: break;
794 case LEG_UNKNOWN: break;
798 // By definition there should be some arriving traffic if we're cleared for immediate takeoff
799 SG_LOG(SG_ATC, SG_WARN, "Warning: Departing traffic cleared for *immediate* take-off despite no arriving traffic in FGTower");
801 t->clearedToTakeOff = true;
802 t->planePtr->RegisterTransmission(4); // cleared to take-off - TODO differentiate between immediate and normal take-off
804 timeSinceLastDeparture = 0.0;
806 //} else if(timeSinceLastDeparture > 60.0 || departed == false) { // Hack - test for timeSinceLastDeparture should be in lineup block eventually
807 trns += " cleared for take-off";
808 // TODO - add traffic is... ?
809 t->clearedToTakeOff = true;
810 t->planePtr->RegisterTransmission(4); // cleared to take-off
812 timeSinceLastDeparture = 0.0;
815 globals->get_ATC_display()->RegisterSingleMessage(trns, 0);
817 //cout << "Done ClearHoldingPlane " << endl;
821 // ***************************************************************************************
822 // ********** Functions to periodically check what the various traffic is doing **********
824 // Do one plane from the hold list
825 void FGTower::CheckHoldList(double dt) {
826 //cout << "Entering CheckHoldList..." << endl;
827 if(holdList.size()) {
828 //cout << "*holdListItr = " << *holdListItr << endl;
829 if(holdListItr == holdList.end()) {
830 holdListItr = holdList.begin();
832 //cout << "*holdListItr = " << *holdListItr << endl;
833 //Process(*holdListItr);
834 TowerPlaneRec* t = *holdListItr;
835 //cout << "t = " << t << endl;
836 if(t->holdShortReported) {
837 // NO-OP - leave it to the response handler.
838 } else { // not responding to report, but still need to clear if clear
840 //cout << "departed = " << departed << '\n';
841 //cout << "timeSinceLastDeparture = " << timeSinceLastDeparture << '\n';
844 } else if(timeSinceLastDeparture <= 60.0 && departed == true) {
845 // Do nothing - this is a bit of a hack - should maybe do line up be ready here
847 ClearHoldingPlane(t);
848 t->leg = TAKEOFF_ROLL;
849 rwyList.push_back(t);
851 holdList.erase(holdListItr);
852 holdListItr = holdList.begin();
855 // TODO - rationalise the considerable code duplication above!
859 //cout << "Done CheckHoldList" << endl;
862 // do the ciruit list
863 void FGTower::CheckCircuitList(double dt) {
864 //cout << "Entering CheckCircuitList..." << endl;
865 // Clear the constraints - we recalculate here.
867 downwind_leg_pos = 0.0;
868 crosswind_leg_pos = 0.0;
870 if(circuitList.size()) { // Do one plane from the circuit
871 if(circuitListItr == circuitList.end()) {
872 circuitListItr = circuitList.begin();
874 TowerPlaneRec* t = *circuitListItr;
875 //cout << ident << ' ' << circuitList.size() << ' ' << t->plane.callsign << " " << t->leg << " eta " << t->eta << '\n';
877 t->pos.setlon(user_lon_node->getDoubleValue());
878 t->pos.setlat(user_lat_node->getDoubleValue());
879 t->pos.setelev(user_elev_node->getDoubleValue());
880 //cout << ident << ' ' << circuitList.size() << ' ' << t->plane.callsign << " " << t->leg << " eta " << t->eta << '\n';
882 t->pos = t->planePtr->GetPos(); // We should probably only set the pos's on one walk through the traffic list in the update function, to save a few CPU should we end up duplicating this.
883 t->landingType = t->planePtr->GetLandingOption();
884 //cout << "AI plane landing option is " << t->landingType << '\n';
886 Point3D tortho = ortho.ConvertToLocal(t->pos);
888 // Need to figure out which leg he's on
889 //cout << "rwy.hdg = " << rwy.hdg << " user hdg = " << user_hdg_node->getDoubleValue();
890 double ho = GetAngleDiff_deg(user_hdg_node->getDoubleValue(), rwy.hdg);
891 //cout << " ho = " << ho << " abs(ho = " << abs(ho) << '\n';
892 // TODO FIXME - get the wind and convert this to track, or otherwise use track somehow!!!
893 // If it's gusty might need to filter the value, although we are leaving 30 degrees each way leeway!
895 // could be either takeoff, climbout or landing - check orthopos.y
896 //cout << "tortho.y = " << tortho.y() << '\n';
897 if((tortho.y() < 0) || (t->leg == TURN4) || (t->leg == FINAL)) {
901 t->leg = CLIMBOUT; // TODO - check elev wrt. apt elev to differentiate takeoff roll and climbout
902 //cout << "Climbout\n";
903 // If it's the user we may be unsure of his/her intentions.
904 // (Hopefully the AI planes won't try confusing the sim!!!)
905 //cout << "tortho.y = " << tortho.y() << '\n';
906 if(t->opType == TTT_UNKNOWN) {
907 if(tortho.y() > 5000) {
908 // 5 km out from threshold - assume it's a departure
909 t->opType = OUTBOUND; // TODO - could check if the user has climbed significantly above circuit altitude as well.
910 // Since we are unknown operation we should be in depList already.
911 //cout << ident << " Removing user from circuitList (TTT_UNKNOWN)\n";
912 circuitList.erase(circuitListItr);
913 RemoveFromTrafficList(t->plane.callsign);
914 circuitListItr = circuitList.begin();
916 } else if(t->opType == CIRCUIT) {
917 if(tortho.y() > 10000) {
918 // 10 km out - assume the user has abandoned the circuit!!
919 t->opType = OUTBOUND;
920 depList.push_back(t);
921 //cout << ident << " removing user from circuitList (CIRCUIT)\n";
922 circuitList.erase(circuitListItr);
923 circuitListItr = circuitList.begin();
927 } else if(abs(ho) < 60) {
929 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
930 if((t->leg == CLIMBOUT) || (t->leg == TURN1)) {
937 } else if(abs(ho) < 120) {
939 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
940 if((t->leg == TURN1) || (t->leg == CROSSWIND)) {
942 //cout << "Crosswind\n";
947 } else if(abs(ho) < 150) {
949 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
950 if((t->leg == CROSSWIND) || (t->leg == TURN2)) {
955 // Probably safe now to assume the user is flying a circuit
962 //cout << "Downwind\n";
964 if(t->leg == FINAL) {
965 if(OnActiveRunway(t->pos)) {
966 t->leg = LANDING_ROLL;
970 t->leg = t->planePtr->GetLeg();
973 // Set the constraints IF this is the first plane in the circuit
974 // TODO - at the moment we're constraining plane 2 based on plane 1 - this won't (or might not) work for 3 planes in the circuit!!
975 if(circuitListItr == circuitList.begin()) {
978 // 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.
979 base_leg_pos = tortho.y();
980 //cout << "base_leg_pos = " << base_leg_pos << '\n';
983 // Fall through to base
985 base_leg_pos = tortho.y();
986 //cout << "base_leg_pos = " << base_leg_pos << '\n';
989 // Fall through to downwind
991 // Only have the downwind leg pos as turn-to-base constraint if more negative than we already have.
992 base_leg_pos = (tortho.y() < base_leg_pos ? tortho.y() : base_leg_pos);
993 //cout << "base_leg_pos = " << base_leg_pos;
994 downwind_leg_pos = tortho.x(); // Assume that a following plane can simply be constrained by the immediately in front downwind plane
995 //cout << " downwind_leg_pos = " << downwind_leg_pos << '\n';
998 // Fall through to crosswind
1000 crosswind_leg_pos = tortho.y();
1001 //cout << "crosswind_leg_pos = " << crosswind_leg_pos << '\n';
1002 t->instructedToGoAround = false;
1005 // Fall through to climbout
1007 // Only use current by constraint as largest
1008 crosswind_leg_pos = (tortho.y() > crosswind_leg_pos ? tortho.y() : crosswind_leg_pos);
1009 //cout << "crosswind_leg_pos = " << crosswind_leg_pos << '\n';
1022 if(t->leg == FINAL && !(t->instructedToGoAround)) {
1023 doThresholdETACalc();
1024 doThresholdUseOrder();
1027 cout << "Checking USER on final... ";
1028 cout << "eta " << t->eta;
1029 if(t->clearedToLand) cout << " cleared to land\n";
1032 //cout << "YES FINAL, t->eta = " << t->eta << ", rwyList.size() = " << rwyList.size() << '\n';
1033 if(t->landingType == FULL_STOP) {
1034 t->opType = INBOUND;
1035 //cout << "\n******** SWITCHING TO INBOUND AT POINT AAA *********\n\n";
1037 if(t->eta < 12 && rwyList.size()) {
1038 // TODO - need to make this more sophisticated
1039 // eg. is the plane accelerating down the runway taking off [OK],
1040 // or stationary near the start [V. BAD!!].
1041 // For now this should stop the AI plane landing on top of the user.
1042 string trns = t->plane.callsign;
1043 trns += " GO AROUND TRAFFIC ON RUNWAY I REPEAT GO AROUND";
1044 pending_transmission = trns;
1045 ImmediateTransmit();
1046 t->instructedToGoAround = true;
1047 t->clearedToLand = false;
1048 // Assume it complies!!!
1049 t->opType = CIRCUIT;
1052 //cout << "Registering Go-around transmission with AI plane\n";
1053 t->planePtr->RegisterTransmission(13);
1055 } else if(!t->clearedToLand) {
1056 // The whip through the appList is a hack since currently t->nextOnRwy doesn't always work
1059 for(tower_plane_rec_list_iterator twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1060 if((*twrItr)->eta < t->eta) {
1064 if(t->nextOnRwy && !cf) {
1065 if(!rwyList.size()) {
1066 string trns = t->plane.callsign;
1067 trns += " Cleared to land";
1068 pending_transmission = trns;
1070 //if(t->isUser) cout << "Transmitting cleared to Land!!!\n";
1071 t->clearedToLand = true;
1073 t->planePtr->RegisterTransmission(7);
1077 //if(t->isUser) cout << "Not next\n";
1080 } else if(t->leg == LANDING_ROLL) {
1081 //cout << t->plane.callsign << " has landed - adding to rwyList\n";
1082 rwyList.push_front(t);
1083 // TODO - if(!clearedToLand) shout something!!
1084 t->clearedToLand = false;
1085 RemoveFromTrafficList(t->plane.callsign);
1087 t->opType = TTT_UNKNOWN;
1088 } // TODO - allow the user to specify opType via ATC menu
1089 //cout << ident << " Removing " << t->plane.callsign << " from circuitList..." << endl;
1090 circuitListItr = circuitList.erase(circuitListItr);
1091 if(circuitListItr == circuitList.end() ) {
1092 circuitListItr = circuitList.begin();
1097 //cout << "Done CheckCircuitList" << endl;
1100 // 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!!
1101 // FIXME - at the moment it looks like we're only doing the first plane from the rwy list.
1102 // (However, at the moment there should only be one airplane on the rwy at once, until we
1103 // start allowing planes to line up whilst previous arrival clears the rwy.)
1104 void FGTower::CheckRunwayList(double dt) {
1105 //cout << "Entering CheckRunwayList..." << endl;
1107 if(!rwyList.size()) {
1108 rwyOccupied = false;
1110 rwyListItr = rwyList.begin();
1111 TowerPlaneRec* t = *rwyListItr;
1113 t->pos.setlon(user_lon_node->getDoubleValue());
1114 t->pos.setlat(user_lat_node->getDoubleValue());
1115 t->pos.setelev(user_elev_node->getDoubleValue());
1117 t->pos = t->planePtr->GetPos(); // We should probably only set the pos's on one walk through the traffic list in the update function, to save a few CPU should we end up duplicating this.
1119 bool on_rwy = OnActiveRunway(t->pos);
1121 // TODO - for all of these we need to check what the user is *actually* doing!
1122 if((t->opType == INBOUND) || (t->opType == STRAIGHT_IN)) {
1123 //cout << "Tower " << ident << " is removing plane " << t->plane.callsign << " from rwy list (vacated)\n";
1124 //cout << "Size of rwylist was " << rwyList.size() << '\n';
1125 //cout << "Size of vacatedList was " << vacatedList.size() << '\n';
1126 RemoveFromRwyList(t->plane.callsign);
1127 AddToVacatedList(t);
1128 //cout << "Size of rwylist is " << rwyList.size() << '\n';
1129 //cout << "Size of vacatedList is " << vacatedList.size() << '\n';
1130 // At the moment we wait until Runway Vacated is reported by the plane before telling to contact ground etc.
1131 // It's possible we could be a bit more proactive about this.
1132 } else if(t->opType == OUTBOUND) {
1133 depList.push_back(t);
1134 rwyList.pop_front();
1136 timeSinceLastDeparture = 0.0;
1137 } else if(t->opType == CIRCUIT) {
1138 //cout << ident << " adding " << t->plane.callsign << " to circuitList" << endl;
1139 circuitList.push_back(t);
1140 AddToTrafficList(t);
1141 rwyList.pop_front();
1143 timeSinceLastDeparture = 0.0;
1144 } else if(t->opType == TTT_UNKNOWN) {
1145 depList.push_back(t);
1146 //cout << ident << " adding " << t->plane.callsign << " to circuitList" << endl;
1147 circuitList.push_back(t);
1148 AddToTrafficList(t);
1149 rwyList.pop_front();
1151 timeSinceLastDeparture = 0.0; // TODO - we need to take into account that the user might taxi-in when flagged opType UNKNOWN - check speed/altitude etc to make decision as to what user is up to.
1153 // HELP - we shouldn't ever get here!!!
1158 //cout << "Done CheckRunwayList" << endl;
1161 // Do one plane from the approach list
1162 void FGTower::CheckApproachList(double dt) {
1163 //cout << "CheckApproachList called for " << ident << endl;
1164 //cout << "AppList.size is " << appList.size() << endl;
1165 if(appList.size()) {
1166 if(appListItr == appList.end()) {
1167 appListItr = appList.begin();
1169 TowerPlaneRec* t = *appListItr;
1170 //cout << "t = " << t << endl;
1171 //cout << "Checking " << t->plane.callsign << endl;
1173 t->pos.setlon(user_lon_node->getDoubleValue());
1174 t->pos.setlat(user_lat_node->getDoubleValue());
1175 t->pos.setelev(user_elev_node->getDoubleValue());
1177 // TODO - set/update the position if it's an AI plane
1179 doThresholdETACalc(); // We need this here because planes in the lists are not guaranteed to *always* have the correct ETA
1180 //cout << "eta is " << t->eta << ", rwy is " << (rwyList.size() ? "occupied " : "clear ") << '\n';
1181 if(t->eta < 12 && rwyList.size() && !(t->instructedToGoAround)) {
1182 // TODO - need to make this more sophisticated
1183 // eg. is the plane accelerating down the runway taking off [OK],
1184 // or stationary near the start [V. BAD!!].
1185 // For now this should stop the AI plane landing on top of the user.
1186 string trns = t->plane.callsign;
1187 trns += " GO AROUND TRAFFIC ON RUNWAY I REPEAT GO AROUND";
1188 pending_transmission = trns;
1189 ImmediateTransmit();
1190 t->instructedToGoAround = true;
1191 t->clearedToLand = false;
1192 t->nextOnRwy = false; // But note this is recalculated so don't rely on it
1193 // Assume it complies!!!
1194 t->opType = CIRCUIT;
1198 //cout << "Registering Go-around transmission with AI plane\n";
1199 t->planePtr->RegisterTransmission(13);
1202 // TODO - add Go-around ack to comm options,
1203 // remove report rwy vacated. (possibly).
1205 } else if(t->eta < 90 && !t->clearedToLand) {
1206 //doThresholdETACalc();
1207 doThresholdUseOrder();
1208 // The whip through the appList is a hack since currently t->nextOnRwy doesn't always work
1211 for(tower_plane_rec_list_iterator twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1212 if((*twrItr)->eta < t->eta) {
1216 if(t->nextOnRwy && !cf) {
1217 if(!rwyList.size()) {
1218 string trns = t->plane.callsign;
1219 trns += " Cleared to land";
1220 pending_transmission = trns;
1222 //if(t->isUser) cout << "Transmitting cleared to Land!!!\n";
1223 t->clearedToLand = true;
1225 t->planePtr->RegisterTransmission(7);
1229 //if(t->isUser) cout << "Not next\n";
1233 // Check for landing...
1234 bool landed = false;
1237 if(t->planePtr->GetLeg() == LANDING_ROLL) {
1241 SG_LOG(SG_ATC, SG_ALERT, "WARNING - not user and null planePtr in CheckApproachList!");
1244 if(OnActiveRunway(t->pos)) {
1250 // Duplicated in CheckCircuitList - must be able to rationalise this somehow!
1251 //cout << "A " << t->plane.callsign << " has landed, adding to rwyList...\n";
1252 rwyList.push_front(t);
1253 // TODO - if(!clearedToLand) shout something!!
1254 t->clearedToLand = false;
1255 RemoveFromTrafficList(t->plane.callsign);
1257 // t->opType = TTT_UNKNOWN;
1258 //} // TODO - allow the user to specify opType via ATC menu
1259 appListItr = appList.erase(appListItr);
1260 if(appListItr == appList.end() ) {
1261 appListItr = appList.begin();
1267 //cout << "Done" << endl;
1270 // Do one plane from the departure list
1271 void FGTower::CheckDepartureList(double dt) {
1272 if(depList.size()) {
1273 if(depListItr == depList.end()) {
1274 depListItr = depList.begin();
1276 TowerPlaneRec* t = *depListItr;
1277 //cout << "Dep list, checking " << t->plane.callsign;
1279 double distout; // meters
1280 if(t->isUser) distout = dclGetHorizontalSeparation(Point3D(lon, lat, elev), Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), user_elev_node->getDoubleValue()));
1281 else distout = dclGetHorizontalSeparation(Point3D(lon, lat, elev), t->planePtr->GetPos());
1282 //cout << " distout = " << distout << '\n';
1283 if(distout > 10000) {
1284 string trns = t->plane.callsign;
1285 trns += " You are now clear of my airspace, good day";
1286 pending_transmission = trns;
1289 // Change the communication options
1290 RemoveAllUserDialogOptions();
1291 //cout << "ADD A\n";
1292 current_atcdialog->add_entry(ident, "@AP Tower @CS @MI miles @CD of the airport for full stop with the ATIS", "Contact tower for VFR arrival (full stop)", TOWER, (int)USER_REQUEST_VFR_ARRIVAL_FULL_STOP);
1294 // Send a clear-of-airspace signal
1295 // TODO - implement this once we actually have departing AI traffic (currently all circuits or arrivals).
1297 RemovePlane(t->plane.callsign);
1304 // ********** End periodic check functions ***********************************************
1305 // ***************************************************************************************
1308 // Remove all dialog options for this tower.
1309 void FGTower::RemoveAllUserDialogOptions() {
1310 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_DEPARTURE, TOWER);
1311 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL, TOWER);
1312 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL_FULL_STOP, TOWER);
1313 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL_TOUCH_AND_GO, TOWER);
1314 current_atcdialog->remove_entry(ident, USER_REPORT_3_MILE_FINAL, TOWER);
1315 current_atcdialog->remove_entry(ident, USER_REPORT_DOWNWIND, TOWER);
1316 current_atcdialog->remove_entry(ident, USER_REPORT_RWY_VACATED, TOWER);
1317 current_atcdialog->remove_entry(ident, USER_REPORT_GOING_AROUND, TOWER);
1320 // Returns true if positions of crosswind/downwind/base leg turns should be constrained by previous traffic
1321 // plus the constraint position as a rwy orientated orthopos (meters)
1322 bool FGTower::GetCrosswindConstraint(double& cpos) {
1323 if(crosswind_leg_pos != 0.0) {
1324 cpos = crosswind_leg_pos;
1331 bool FGTower::GetDownwindConstraint(double& dpos) {
1332 if(fabs(downwind_leg_pos) > nominal_downwind_leg_pos) {
1333 dpos = downwind_leg_pos;
1340 bool FGTower::GetBaseConstraint(double& bpos) {
1341 if(base_leg_pos < nominal_base_leg_pos) {
1342 bpos = base_leg_pos;
1345 bpos = nominal_base_leg_pos;
1351 // Figure out which runways are active.
1352 // For now we'll just be simple and do one active runway - eventually this will get much more complex
1353 // This is a private function - public interface to the results of this is through GetActiveRunway
1354 void FGTower::DoRwyDetails() {
1355 //cout << "GetRwyDetails called" << endl;
1357 // Based on the airport-id and wind get the active runway
1360 double hdg = wind_from_hdg->getDoubleValue();
1361 double speed = wind_speed_knots->getDoubleValue();
1362 hdg = (speed == 0.0 ? 270.0 : hdg);
1363 //cout << "Heading = " << hdg << '\n';
1366 bool rwyGood = globals->get_runways()->search(ident, int(hdg), &runway);
1368 //cout << "RUNWAY GOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOD\n";
1369 activeRwy = runway.rwy_no;
1370 rwy.rwyID = runway.rwy_no;
1371 SG_LOG(SG_ATC, SG_INFO, "Active runway for airport " << ident << " is " << activeRwy);
1373 // Get the threshold position
1374 double other_way = runway.heading - 180.0;
1375 while(other_way <= 0.0) {
1378 // move to the +l end/center of the runway
1379 //cout << "Runway center is at " << runway.lon << ", " << runway.lat << '\n';
1380 Point3D origin = Point3D(runway.lon, runway.lat, aptElev);
1381 Point3D ref = origin;
1382 double tshlon, tshlat, tshr;
1383 double tolon, tolat, tor;
1384 rwy.length = runway.length * SG_FEET_TO_METER;
1385 rwy.width = runway.width * SG_FEET_TO_METER;
1386 geo_direct_wgs_84 ( aptElev, ref.lat(), ref.lon(), other_way,
1387 rwy.length / 2.0 - 25.0, &tshlat, &tshlon, &tshr );
1388 geo_direct_wgs_84 ( aptElev, ref.lat(), ref.lon(), runway.heading,
1389 rwy.length / 2.0 - 25.0, &tolat, &tolon, &tor );
1390 // Note - 25 meters in from the runway end is a bit of a hack to put the plane ahead of the user.
1391 // now copy what we need out of runway into rwy
1392 rwy.threshold_pos = Point3D(tshlon, tshlat, aptElev);
1393 Point3D takeoff_end = Point3D(tolon, tolat, aptElev);
1394 //cout << "Threshold position = " << tshlon << ", " << tshlat << ", " << aptElev << '\n';
1395 //cout << "Takeoff position = " << tolon << ", " << tolat << ", " << aptElev << '\n';
1396 rwy.hdg = runway.heading;
1397 // Set the projection for the local area based on this active runway
1398 ortho.Init(rwy.threshold_pos, rwy.hdg);
1399 rwy.end1ortho = ortho.ConvertToLocal(rwy.threshold_pos); // should come out as zero
1400 rwy.end2ortho = ortho.ConvertToLocal(takeoff_end);
1402 // Set the pattern direction
1403 // TODO - we'll check for a facilities file with this in eventually - for now assume left traffic except
1404 // for certain circumstances (RH parallel rwy).
1405 rwy.patternDirection = -1; // Left
1406 if(rwy.rwyID.size() == 3) {
1407 rwy.patternDirection = (rwy.rwyID.substr(2,1) == "R" ? 1 : -1);
1409 //cout << "Doing details, rwy.patterDirection is " << rwy.patternDirection << '\n';
1411 SG_LOG(SG_ATC, SG_ALERT, "Help - can't get good runway in FGTower!!");
1417 // Figure out if a given position lies on the active runway
1418 // Might have to change when we consider more than one active rwy.
1419 bool FGTower::OnActiveRunway(Point3D pt) {
1420 // TODO - check that the centre calculation below isn't confused by displaced thesholds etc.
1421 Point3D xyc((rwy.end1ortho.x() + rwy.end2ortho.x())/2.0, (rwy.end1ortho.y() + rwy.end2ortho.y())/2.0, 0.0);
1422 Point3D xyp = ortho.ConvertToLocal(pt);
1424 //cout << "Length offset = " << fabs(xyp.y() - xyc.y()) << '\n';
1425 //cout << "Width offset = " << fabs(xyp.x() - xyc.x()) << '\n';
1427 double rlen = rwy.length/2.0 + 5.0;
1428 double rwidth = rwy.width/2.0;
1429 double ldiff = fabs(xyp.y() - xyc.y());
1430 double wdiff = fabs(xyp.x() - xyc.x());
1432 return((ldiff < rlen) && (wdiff < rwidth));
1436 // Figure out if a given position lies on any runway or not
1437 // Only call this at startup - reading the runways database is expensive and needs to be fixed!
1438 bool FGTower::OnAnyRunway(Point3D pt) {
1440 double dist = current_commlist->FindClosest(lon, lat, elev, ad, TOWER, 10.0);
1444 // Based on the airport-id, go through all the runways and check for a point in them
1446 // TODO - do we actually need to search for the airport - surely we already know our ident and
1447 // can just search runways of our airport???
1448 //cout << "Airport ident is " << ad.ident << '\n';
1450 bool rwyGood = globals->get_runways()->search(ad.ident, &runway);
1452 SG_LOG(SG_ATC, SG_WARN, "Unable to find any runways for airport ID " << ad.ident << " in FGTower");
1455 while(runway.id == ad.ident) {
1456 on = OnRunway(pt, runway);
1457 //cout << "Runway " << runway.rwy_no << ": On = " << (on ? "true\n" : "false\n");
1458 if(on) return(true);
1459 globals->get_runways()->next(&runway);
1465 // Returns true if successful
1466 bool FGTower::RemoveFromTrafficList(string id) {
1467 tower_plane_rec_list_iterator twrItr;
1468 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
1469 TowerPlaneRec* tpr = *twrItr;
1470 if(tpr->plane.callsign == id) {
1471 trafficList.erase(twrItr);
1472 trafficListItr = trafficList.begin();
1476 SG_LOG(SG_ATC, SG_WARN, "Warning - unable to remove aircraft " << id << " from trafficList in FGTower");
1481 // Returns true if successful
1482 bool FGTower::RemoveFromAppList(string id) {
1483 tower_plane_rec_list_iterator twrItr;
1484 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1485 TowerPlaneRec* tpr = *twrItr;
1486 if(tpr->plane.callsign == id) {
1487 appList.erase(twrItr);
1488 appListItr = appList.begin();
1492 //SG_LOG(SG_ATC, SG_WARN, "Warning - unable to remove aircraft " << id << " from appList in FGTower");
1496 // Returns true if successful
1497 bool FGTower::RemoveFromRwyList(string id) {
1498 tower_plane_rec_list_iterator twrItr;
1499 for(twrItr = rwyList.begin(); twrItr != rwyList.end(); twrItr++) {
1500 TowerPlaneRec* tpr = *twrItr;
1501 if(tpr->plane.callsign == id) {
1502 rwyList.erase(twrItr);
1503 rwyListItr = rwyList.begin();
1507 //SG_LOG(SG_ATC, SG_WARN, "Warning - unable to remove aircraft " << id << " from rwyList in FGTower");
1512 // Add a tower plane rec with ETA to the traffic list in the correct position ETA-wise
1513 // and set nextOnRwy if so.
1514 // Returns true if this could cause a threshold ETA conflict with other traffic, false otherwise.
1515 // For planes holding they are put in the first position with time to go, and the return value is
1516 // true if in the first position (nextOnRwy) and false otherwise.
1517 // See the comments in FGTower::doThresholdUseOrder for notes on the ordering
1518 bool FGTower::AddToTrafficList(TowerPlaneRec* t, bool holding) {
1519 //cout << "ADD: " << trafficList.size();
1520 //cout << "AddToTrafficList called, currently size = " << trafficList.size() << ", holding = " << holding << endl;
1521 double separation_time = 90.0; // seconds - this is currently a guess for light plane separation, and includes a few seconds for a holding plane to taxi onto the rwy.
1522 double departure_sep_time = 60.0; // Separation time behind departing airplanes. Comments above also apply.
1523 bool conflict = false;
1524 double lastETA = 0.0;
1525 bool firstTime = true;
1526 // FIXME - make this more robust for different plane types eg. light following heavy.
1527 tower_plane_rec_list_iterator twrItr;
1528 //twrItr = trafficList.begin();
1530 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
1531 //if(twrItr == trafficList.end()) {
1533 // trafficList.push_back(t);
1534 // return(holding ? firstTime : conflict);
1536 TowerPlaneRec* tpr = *twrItr;
1538 //cout << (tpr->isUser ? "USER!\n" : "NOT user\n");
1539 //cout << "tpr->eta - lastETA = " << tpr->eta - lastETA << '\n';
1540 double dep_allowance = (timeSinceLastDeparture < departure_sep_time ? departure_sep_time - timeSinceLastDeparture : 0.0);
1541 double slot_time = (firstTime ? separation_time + dep_allowance : separation_time + departure_sep_time);
1542 // separation_time + departure_sep_time in the above accounts for the fact that the arrival could be touch and go,
1543 // and if not needs time to clear the rwy anyway.
1544 if(tpr->eta - lastETA > slot_time) {
1545 t->nextOnRwy = firstTime;
1546 trafficList.insert(twrItr, t);
1547 //cout << "\tH\t" << trafficList.size() << '\n';
1552 if(t->eta < tpr->eta) {
1553 // Ugg - this one's tricky.
1554 // It depends on what the two planes are doing and whether there's a conflict what we do.
1555 if(tpr->eta - t->eta > separation_time) { // No probs, plane 2 can squeeze in before plane 1 with no apparent conflict
1556 if(tpr->nextOnRwy) {
1557 tpr->nextOnRwy = false;
1558 t->nextOnRwy = true;
1560 trafficList.insert(twrItr, t);
1561 } else { // Ooops - this ones tricky - we have a potential conflict!
1563 // HACK - just add anyway for now and flag conflict - TODO - FIX THIS using CIRCUIT/STRAIGHT_IN and VFR/IFR precedence rules.
1564 if(tpr->nextOnRwy) {
1565 tpr->nextOnRwy = false;
1566 t->nextOnRwy = true;
1568 trafficList.insert(twrItr, t);
1570 //cout << "\tC\t" << trafficList.size() << '\n';
1577 // If we get here we must be at the end of the list, or maybe the list is empty.
1578 if(!trafficList.size()) {
1579 t->nextOnRwy = true;
1580 // conflict and firstTime should be false and true respectively in this case anyway.
1582 t->nextOnRwy = false;
1584 trafficList.push_back(t);
1585 //cout << "\tE\t" << trafficList.size() << endl;
1586 return(holding ? firstTime : conflict);
1589 // Add a tower plane rec with ETA to the circuit list in the correct position ETA-wise
1590 // Returns true if this might cause a separation conflict (based on ETA) with other traffic, false otherwise.
1591 // Safe to add a plane that is already in - planes with the same callsign are not added.
1592 bool FGTower::AddToCircuitList(TowerPlaneRec* t) {
1594 //cout << "**********************************************\n";
1595 //cout << "AddToCircuitList called with NULL pointer!!!!!\n";
1596 //cout << "**********************************************\n";
1599 //cout << "ADD: " << circuitList.size();
1600 //cout << ident << " AddToCircuitList called for " << t->plane.callsign << ", currently size = " << circuitList.size() << endl;
1601 double separation_time = 60.0; // seconds - this is currently a guess for light plane separation, and includes a few seconds for a holding plane to taxi onto the rwy.
1602 bool conflict = false;
1603 tower_plane_rec_list_iterator twrItr;
1604 // First check if the plane is already in the list
1605 //cout << "A" << endl;
1606 //cout << "Checking whether " << t->plane.callsign << " is already in circuit list..." << endl;
1607 //cout << "B" << endl;
1608 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
1609 if((*twrItr)->plane.callsign == t->plane.callsign) {
1610 //cout << "In list - returning...\n";
1614 //cout << "Not in list - adding..." << endl;
1616 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
1617 TowerPlaneRec* tpr = *twrItr;
1618 //cout << tpr->plane.callsign << " eta is " << tpr->eta << '\n';
1619 //cout << "New eta is " << t->eta << '\n';
1620 if(t->eta < tpr->eta) {
1621 // Ugg - this one's tricky.
1622 // It depends on what the two planes are doing and whether there's a conflict what we do.
1623 if(tpr->eta - t->eta > separation_time) { // No probs, plane 2 can squeeze in before plane 1 with no apparent conflict
1624 circuitList.insert(twrItr, t);
1625 } else { // Ooops - this ones tricky - we have a potential conflict!
1627 // HACK - just add anyway for now and flag conflict.
1628 circuitList.insert(twrItr, t);
1630 //cout << "\tC\t" << circuitList.size() << '\n';
1634 // If we get here we must be at the end of the list, or maybe the list is empty.
1635 //cout << ident << " adding " << t->plane.callsign << " to circuitList" << endl;
1636 circuitList.push_back(t); // TODO - check the separation with the preceding plane for the conflict flag.
1637 //cout << "\tE\t" << circuitList.size() << endl;
1641 // Add to vacated list only if not already present
1642 void FGTower::AddToVacatedList(TowerPlaneRec* t) {
1643 tower_plane_rec_list_iterator twrItr;
1645 for(twrItr = vacatedList.begin(); twrItr != vacatedList.end(); twrItr++) {
1646 if((*twrItr)->plane.callsign == t->plane.callsign) {
1651 vacatedList.push_back(t);
1655 // Calculate the eta of a plane to the threshold.
1656 // For ground traffic this is the fastest they can get there.
1657 // For air traffic this is the middle approximation.
1658 void FGTower::CalcETA(TowerPlaneRec* tpr, bool printout) {
1659 // For now we'll be very crude and hardwire expected speeds to C172-like values
1660 // The speeds below are specified in knots IAS and then converted to m/s
1661 double app_ias = 100.0 * 0.514444; // Speed during straight-in approach
1662 double circuit_ias = 80.0 * 0.514444; // Speed around circuit
1663 double final_ias = 70.0 * 0.514444; // Speed during final approach
1666 //cout << "In CalcETA, airplane ident = " << tpr->plane.callsign << '\n';
1667 //cout << (tpr->isUser ? "USER\n" : "AI\n");
1671 // Sign convention - dist_out is -ve for approaching planes and +ve for departing planes
1672 // dist_across is +ve in the pattern direction - ie a plane correctly on downwind will have a +ve dist_across
1674 Point3D op = ortho.ConvertToLocal(tpr->pos);
1676 //if(!tpr->isUser) cout << "Orthopos is " << op.x() << ", " << op.y() << ' ';
1677 //cout << "opType is " << tpr->opType << '\n';
1679 double dist_out_m = op.y();
1680 double dist_across_m = fabs(op.x()); // The fabs is a hack to cope with the fact that we don't know the circuit direction yet
1681 //cout << "Doing ETA calc for " << tpr->plane.callsign << '\n';
1683 if(tpr->opType == STRAIGHT_IN || tpr->opType == INBOUND) {
1684 //cout << "CASE 1\n";
1685 double dist_to_go_m = sqrt((dist_out_m * dist_out_m) + (dist_across_m * dist_across_m));
1686 if(dist_to_go_m < 1000) {
1687 tpr->eta = dist_to_go_m / final_ias;
1689 tpr->eta = (1000.0 / final_ias) + ((dist_to_go_m - 1000.0) / app_ias);
1691 } else if(tpr->opType == CIRCUIT || tpr->opType == TTT_UNKNOWN) { // Hack alert - UNKNOWN has sort of been added here as a temporary hack.
1692 //cout << "CASE 2\n";
1693 // It's complicated - depends on if base leg is delayed or not
1695 //cout << "Leg = " << tpr->leg << '\n';
1697 if(tpr->leg == LANDING_ROLL) {
1699 } else if((tpr->leg == FINAL) || (tpr->leg == TURN4)) {
1700 //cout << "dist_out_m = " << dist_out_m << '\n';
1701 tpr->eta = fabs(dist_out_m) / final_ias;
1702 } else if((tpr->leg == BASE) || (tpr->leg == TURN3)) {
1703 tpr->eta = (fabs(dist_out_m) / final_ias) + (dist_across_m / circuit_ias);
1705 // Need to calculate where base leg is likely to be
1706 // FIXME - for now I'll hardwire it to 1000m which is what AILocalTraffic uses!!!
1707 // 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
1708 double nominal_base_dist_out_m = -1000;
1709 double current_base_dist_out_m;
1710 if(!GetBaseConstraint(current_base_dist_out_m)) {
1711 current_base_dist_out_m = nominal_base_dist_out_m;
1713 //cout << "current_base_dist_out_m = " << current_base_dist_out_m << '\n';
1714 double nominal_dist_across_m = 1000; // Hardwired value from AILocalTraffic
1715 double current_dist_across_m;
1716 if(!GetDownwindConstraint(current_dist_across_m)) {
1717 current_dist_across_m = nominal_dist_across_m;
1719 double nominal_cross_dist_out_m = 2000; // Bit of a guess - AI plane turns to crosswind at 700ft agl.
1720 tpr->eta = fabs(current_base_dist_out_m) / final_ias; // final
1721 //cout << "a = " << tpr->eta << '\n';
1722 if((tpr->leg == DOWNWIND) || (tpr->leg == TURN2)) {
1723 tpr->eta += dist_across_m / circuit_ias;
1724 //cout << "b = " << tpr->eta << '\n';
1725 tpr->eta += fabs(current_base_dist_out_m - dist_out_m) / circuit_ias;
1726 //cout << "c = " << tpr->eta << '\n';
1727 } else if((tpr->leg == CROSSWIND) || (tpr->leg == TURN1)) {
1728 //cout << "CROSSWIND calc: ";
1729 //cout << tpr->eta << ' ';
1730 if(dist_across_m > nominal_dist_across_m) {
1731 tpr->eta += dist_across_m / circuit_ias;
1734 tpr->eta += nominal_dist_across_m / circuit_ias;
1737 //cout << tpr->eta << ' ';
1738 // should we use the dist across of the previous plane if there is previous still on downwind?
1739 //if(printout) cout << "bb = " << tpr->eta << '\n';
1740 if(dist_out_m > nominal_cross_dist_out_m) {
1741 tpr->eta += fabs(current_base_dist_out_m - dist_out_m) / circuit_ias;
1744 tpr->eta += fabs(current_base_dist_out_m - nominal_cross_dist_out_m) / circuit_ias;
1747 //cout << tpr->eta << ' ';
1748 //if(printout) cout << "cc = " << tpr->eta << '\n';
1749 if(nominal_dist_across_m > dist_across_m) {
1750 tpr->eta += (nominal_dist_across_m - dist_across_m) / circuit_ias;
1756 //cout << tpr->eta << '\n';
1757 //if(printout) cout << "dd = " << tpr->eta << '\n';
1759 // We've only just started - why not use a generic estimate?
1764 // cout << "ETA = " << tpr->eta << '\n';
1766 //if(!tpr->isUser) cout << tpr->plane.callsign << '\t' << tpr->eta << '\n';
1773 // Calculate the distance of a plane to the threshold in meters
1774 // TODO - Modify to calculate flying distance of a plane in the circuit
1775 double FGTower::CalcDistOutM(TowerPlaneRec* tpr) {
1776 return(dclGetHorizontalSeparation(rwy.threshold_pos, tpr->pos));
1780 // Calculate the distance of a plane to the threshold in miles
1781 // TODO - Modify to calculate flying distance of a plane in the circuit
1782 double FGTower::CalcDistOutMiles(TowerPlaneRec* tpr) {
1783 return(CalcDistOutM(tpr) / 1600.0); // FIXME - use a proper constant if possible.
1787 // Iterate through all the lists, update the position of, and call CalcETA for all the planes.
1788 void FGTower::doThresholdETACalc() {
1789 //cout << "Entering doThresholdETACalc..." << endl;
1790 tower_plane_rec_list_iterator twrItr;
1791 // Do the approach list first
1792 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1793 TowerPlaneRec* tpr = *twrItr;
1794 if(!(tpr->isUser)) tpr->pos = tpr->planePtr->GetPos();
1798 // Then the circuit list
1799 //cout << "Circuit list size is " << circuitList.size() << '\n';
1800 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
1801 TowerPlaneRec* tpr = *twrItr;
1802 if(!(tpr->isUser)) tpr->pos = tpr->planePtr->GetPos();
1806 //cout << "Done doThresholdETCCalc" << endl;
1810 // Check that the planes in traffic list are correctly ordered,
1811 // that the nearest (timewise) is flagged next on rwy, and return
1812 // true if any threshold use conflicts are detected, false otherwise.
1813 bool FGTower::doThresholdUseOrder() {
1814 //cout << "Entering doThresholdUseOrder..." << endl;
1815 bool conflict = false;
1817 // Wipe out traffic list, go through circuit, app and hold list, and reorder them in traffic list.
1818 // Here's the rather simplistic assumptions we're using:
1819 // Currently all planes are assumed to be GA light singles with corresponding speeds and separation times.
1820 // In order of priority for runway use:
1821 // STRAIGHT_IN > CIRCUIT > HOLDING_FOR_DEPARTURE
1822 // No modification of planes speeds occurs - conflicts are resolved by delaying turn for base,
1823 // and holding planes until a space.
1824 // When calculating if a holding plane can use the runway, time clearance from last departure
1825 // as well as time clearance to next arrival must be considered.
1827 trafficList.clear();
1829 tower_plane_rec_list_iterator twrItr;
1830 // Do the approach list first
1831 //if(ident == "KRHV") cout << "A" << flush;
1832 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1833 TowerPlaneRec* tpr = *twrItr;
1834 //if(ident == "KRHV") cout << tpr->plane.callsign << '\n';
1835 conflict = AddToTrafficList(tpr);
1837 // Then the circuit list
1838 //if(ident == "KRHV") cout << "C" << flush;
1839 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
1840 TowerPlaneRec* tpr = *twrItr;
1841 //if(ident == "KRHV") cout << tpr->plane.callsign << '\n';
1842 conflict = AddToTrafficList(tpr);
1844 // And finally the hold list
1845 //cout << "H" << endl;
1846 for(twrItr = holdList.begin(); twrItr != holdList.end(); twrItr++) {
1847 TowerPlaneRec* tpr = *twrItr;
1848 AddToTrafficList(tpr, true);
1853 //if(ident == "KRHV") {
1855 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
1856 TowerPlaneRec* tpr = *twrItr;
1857 cout << tpr->plane.callsign << '\t' << tpr->eta << '\t';
1862 //cout << "Done doThresholdUseOrder" << endl;
1867 // Return the ETA of plane no. list_pos (1-based) in the traffic list.
1868 // i.e. list_pos = 1 implies next to use runway.
1869 double FGTower::GetTrafficETA(unsigned int list_pos, bool printout) {
1870 if(trafficList.size() < list_pos) {
1874 tower_plane_rec_list_iterator twrItr;
1875 twrItr = trafficList.begin();
1876 for(unsigned int i = 1; i < list_pos; i++, twrItr++);
1877 TowerPlaneRec* tpr = *twrItr;
1878 CalcETA(tpr, printout);
1879 //cout << "ETA returned = " << tpr->eta << '\n';
1884 void FGTower::ContactAtHoldShort(PlaneRec plane, FGAIPlane* requestee, tower_traffic_type operation) {
1885 // HACK - assume that anything contacting at hold short is new for now - FIXME LATER
1886 TowerPlaneRec* t = new TowerPlaneRec;
1888 t->planePtr = requestee;
1889 t->holdShortReported = true;
1890 t->clearedToLineUp = false;
1891 t->clearedToTakeOff = false;
1892 t->opType = operation;
1893 t->pos = requestee->GetPos();
1895 //cout << "Hold Short reported by " << plane.callsign << '\n';
1896 SG_LOG(SG_ATC, SG_BULK, "Hold Short reported by " << plane.callsign);
1899 bool next = AddToTrafficList(t, true);
1901 double teta = GetTrafficETA(2);
1903 t->clearanceCounter = 7.0; // This reduces the delay before response to 3 secs if an immediate takeoff is reqd
1904 //cout << "Reducing response time to request due imminent traffic\n";
1909 // TODO - possibly add the reduced interval to clearance when immediate back in under the new scheme
1911 holdList.push_back(t);
1913 responseReqd = true;
1916 // Register the presence of an AI plane at a point where contact would already have been made in real life
1917 // CAUTION - currently it is assumed that this plane's callsign is unique - it is up to AIMgr to generate unique callsigns.
1918 void FGTower::RegisterAIPlane(PlaneRec plane, FGAIPlane* ai, tower_traffic_type op, PatternLeg lg) {
1919 // At the moment this is only going to be tested with inserting an AI plane on downwind
1920 TowerPlaneRec* t = new TowerPlaneRec;
1925 t->pos = ai->GetPos();
1929 if(op == CIRCUIT && lg != LEG_UNKNOWN) {
1930 AddToCircuitList(t);
1935 doThresholdUseOrder();
1938 void FGTower::DeregisterAIPlane(string id) {
1942 // Contact tower for VFR approach
1943 // eg "Cessna Charlie Foxtrot Golf Foxtrot Sierra eight miles South of the airport for full stop with Bravo"
1944 // This function probably only called via user interaction - AI planes will have an overloaded function taking a planerec.
1945 // opt defaults to AIP_LT_UNKNOWN
1946 void FGTower::VFRArrivalContact(string ID, LandingType opt) {
1947 //cout << "USER Request Landing Clearance called for ID " << ID << '\n';
1949 // For now we'll assume that the user is a light plane and can get him/her to join the circuit if necessary.
1952 string usercall = fgGetString("/sim/user/callsign");
1953 if(ID == "USER" || ID == usercall) {
1954 t = FindPlane(usercall);
1956 //cout << "NOT t\n";
1957 t = new TowerPlaneRec;
1959 t->pos.setlon(user_lon_node->getDoubleValue());
1960 t->pos.setlat(user_lat_node->getDoubleValue());
1961 t->pos.setelev(user_elev_node->getDoubleValue());
1964 // Oops - the plane is already registered with this tower - maybe we took off and flew a giant circuit without
1965 // quite getting out of tower airspace - just ignore for now and treat as new arrival.
1966 // TODO - Maybe should remove from departure and circuit list if in there though!!
1969 // Oops - something has gone wrong - put out a warning
1970 cout << "WARNING - FGTower::VFRContact(string ID, LandingType lt) called with ID " << ID << " which does not appear to be the user.\n";
1976 // Calculate where the plane is in relation to the active runway and it's circuit
1977 // and set the op-type as appropriate.
1979 // HACK - to get up and running I'm going to assume that the user contacts tower on a staight-in final for now.
1980 t->opType = STRAIGHT_IN;
1982 t->plane.type = GA_SINGLE; // FIXME - Another assumption!
1983 t->plane.callsign = usercall;
1985 t->vfrArrivalReported = true;
1986 responseReqd = true;
1988 appList.push_back(t); // Not necessarily permanent
1989 AddToTrafficList(t);
1991 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL, TOWER);
1992 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL_FULL_STOP, TOWER);
1993 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL_TOUCH_AND_GO, TOWER);
1996 // landingType defaults to AIP_LT_UNKNOWN
1997 void FGTower::VFRArrivalContact(PlaneRec plane, FGAIPlane* requestee, LandingType lt) {
1998 //cout << "VFRArrivalContact called for plane " << plane.callsign << " at " << ident << '\n';
1999 // Possible hack - assume this plane is new for now - TODO - should check really
2000 TowerPlaneRec* t = new TowerPlaneRec;
2002 t->planePtr = requestee;
2003 t->landingType = lt;
2004 t->pos = requestee->GetPos();
2006 //cout << "Hold Short reported by " << plane.callsign << '\n';
2007 SG_LOG(SG_ATC, SG_BULK, "VFR arrival contact made by " << plane.callsign);
2008 //cout << "VFR arrival contact made by " << plane.callsign << '\n';
2010 // HACK - to get up and running I'm going to assume a staight-in final for now.
2011 t->opType = STRAIGHT_IN;
2013 t->vfrArrivalReported = true;
2014 responseReqd = true;
2016 //cout << "Before adding, appList.size = " << appList.size() << " at " << ident << '\n';
2017 appList.push_back(t); // Not necessarily permanent
2018 //cout << "After adding, appList.size = " << appList.size() << " at " << ident << '\n';
2019 AddToTrafficList(t);
2022 void FGTower::RequestDepartureClearance(string ID) {
2023 //cout << "Request Departure Clearance called...\n";
2026 void FGTower::ReportFinal(string ID) {
2027 //cout << "Report Final Called at tower " << ident << " by plane " << ID << '\n';
2029 ID = fgGetString("/sim/user/callsign");
2030 current_atcdialog->remove_entry(ident, USER_REPORT_3_MILE_FINAL, TOWER);
2032 TowerPlaneRec* t = FindPlane(ID);
2034 t->finalReported = true;
2035 t->finalAcknowledged = false;
2036 if(!(t->clearedToLand)) {
2037 responseReqd = true;
2039 // possibly respond with wind even if already cleared to land?
2040 t->finalReported = false;
2041 t->finalAcknowledged = true;
2042 // HACK!! - prevents next reporting being misinterpreted as this one.
2045 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportFinal(...)");
2049 void FGTower::ReportLongFinal(string ID) {
2051 ID = fgGetString("/sim/user/callsign");
2052 current_atcdialog->remove_entry(ident, USER_REPORT_3_MILE_FINAL, TOWER);
2054 TowerPlaneRec* t = FindPlane(ID);
2056 t->longFinalReported = true;
2057 t->longFinalAcknowledged = false;
2058 if(!(t->clearedToLand)) {
2059 responseReqd = true;
2060 } // possibly respond with wind even if already cleared to land?
2062 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportLongFinal(...)");
2066 //void FGTower::ReportOuterMarker(string ID);
2067 //void FGTower::ReportMiddleMarker(string ID);
2068 //void FGTower::ReportInnerMarker(string ID);
2070 void FGTower::ReportRunwayVacated(string ID) {
2071 //cout << "Report Runway Vacated Called at tower " << ident << " by plane " << ID << '\n';
2073 ID = fgGetString("/sim/user/callsign");
2074 current_atcdialog->remove_entry(ident, USER_REPORT_RWY_VACATED, TOWER);
2076 TowerPlaneRec* t = FindPlane(ID);
2078 //cout << "Found it...\n";
2079 t->rwyVacatedReported = true;
2080 responseReqd = true;
2082 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportRunwayVacated(...)");
2083 SG_LOG(SG_ATC, SG_ALERT, "A WARNING: Unable to find plane " << ID << " in FGTower::ReportRunwayVacated(...)");
2084 //cout << "WARNING: Unable to find plane " << ID << " in FGTower::ReportRunwayVacated(...)\n";
2088 TowerPlaneRec* FGTower::FindPlane(string ID) {
2089 //cout << "FindPlane called for " << ID << "...\n";
2090 tower_plane_rec_list_iterator twrItr;
2091 // Do the approach list first
2092 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
2093 //cout << "appList callsign is " << (*twrItr)->plane.callsign << '\n';
2094 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2096 // Then the circuit list
2097 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
2098 //cout << "circuitList callsign is " << (*twrItr)->plane.callsign << '\n';
2099 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2101 // Then the runway list
2102 //cout << "rwyList.size() is " << rwyList.size() << '\n';
2103 for(twrItr = rwyList.begin(); twrItr != rwyList.end(); twrItr++) {
2104 //cout << "rwyList callsign is " << (*twrItr)->plane.callsign << '\n';
2105 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2108 for(twrItr = holdList.begin(); twrItr != holdList.end(); twrItr++) {
2109 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2111 // And finally the vacated list
2112 for(twrItr = vacatedList.begin(); twrItr != vacatedList.end(); twrItr++) {
2113 //cout << "vacatedList callsign is " << (*twrItr)->plane.callsign << '\n';
2114 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2116 SG_LOG(SG_ATC, SG_WARN, "Unable to find " << ID << " in FGTower::FindPlane(...)");
2121 void FGTower::RemovePlane(string ID) {
2122 //cout << ident << " RemovePlane called for " << ID << '\n';
2123 // We have to be careful here - we want to erase the plane from all lists it is in,
2124 // but we can only delete it once, AT THE END.
2125 TowerPlaneRec* t = NULL;
2126 tower_plane_rec_list_iterator twrItr;
2127 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
2128 if((*twrItr)->plane.callsign == ID) {
2130 twrItr = appList.erase(twrItr);
2131 appListItr = appList.begin();
2134 for(twrItr = depList.begin(); twrItr != depList.end(); twrItr++) {
2135 if((*twrItr)->plane.callsign == ID) {
2137 twrItr = depList.erase(twrItr);
2138 depListItr = depList.begin();
2141 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
2142 if((*twrItr)->plane.callsign == ID) {
2144 twrItr = circuitList.erase(twrItr);
2145 circuitListItr = circuitList.begin();
2148 for(twrItr = holdList.begin(); twrItr != holdList.end(); twrItr++) {
2149 if((*twrItr)->plane.callsign == ID) {
2151 twrItr = holdList.erase(twrItr);
2152 holdListItr = holdList.begin();
2155 for(twrItr = rwyList.begin(); twrItr != rwyList.end(); twrItr++) {
2156 if((*twrItr)->plane.callsign == ID) {
2158 twrItr = rwyList.erase(twrItr);
2159 rwyListItr = rwyList.begin();
2162 for(twrItr = vacatedList.begin(); twrItr != vacatedList.end(); twrItr++) {
2163 if((*twrItr)->plane.callsign == ID) {
2165 twrItr = vacatedList.erase(twrItr);
2166 vacatedListItr = vacatedList.begin();
2169 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
2170 if((*twrItr)->plane.callsign == ID) {
2172 twrItr = trafficList.erase(twrItr);
2173 trafficListItr = trafficList.begin();
2176 // And finally, delete the record if we found it.
2180 void FGTower::ReportDownwind(string ID) {
2181 //cout << "ReportDownwind(...) called\n";
2183 ID = fgGetString("/sim/user/callsign");
2184 current_atcdialog->remove_entry(ident, USER_REPORT_DOWNWIND, TOWER);
2186 TowerPlaneRec* t = FindPlane(ID);
2188 t->downwindReported = true;
2189 responseReqd = true;
2190 // If the plane is in the app list, remove it and put it in the circuit list instead.
2191 // Ideally we might want to do this at the 2 mile report prior to 45 deg entry, but at
2192 // the moment that would b&gg?r up the constraint position calculations.
2193 RemoveFromAppList(ID);
2196 t->pos.setlon(user_lon_node->getDoubleValue());
2197 t->pos.setlat(user_lat_node->getDoubleValue());
2198 t->pos.setelev(user_elev_node->getDoubleValue());
2200 // ASSERT(t->planePtr != NULL);
2201 t->pos = t->planePtr->GetPos();
2204 AddToCircuitList(t);
2206 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportDownwind(...)");
2210 void FGTower::ReportGoingAround(string ID) {
2212 ID = fgGetString("/sim/user/callsign");
2213 RemoveAllUserDialogOptions(); // TODO - it would be much more efficient if ATCDialog simply had a clear() function!!!
2214 current_atcdialog->add_entry(ident, "@AP Tower @CS Downwind @RW", "Report Downwind", TOWER, (int)USER_REPORT_DOWNWIND);
2216 TowerPlaneRec* t = FindPlane(ID);
2218 //t->goAroundReported = true; // No need to set this until we start responding to it.
2219 responseReqd = false; // might change in the future but for now we'll not distract them during the go-around.
2220 // If the plane is in the app list, remove it and put it in the circuit list instead.
2221 RemoveFromAppList(ID);
2224 t->pos.setlon(user_lon_node->getDoubleValue());
2225 t->pos.setlat(user_lat_node->getDoubleValue());
2226 t->pos.setelev(user_elev_node->getDoubleValue());
2228 // ASSERT(t->planePtr != NULL);
2229 t->pos = t->planePtr->GetPos();
2232 AddToCircuitList(t);
2234 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportDownwind(...)");
2238 string FGTower::GenText(const string& m, int c) {
2239 const int cmax = 300;
2249 string usercall = fgGetString("/sim/user/callsign");
2251 //transmission_list_type tmissions = transmissionlist_station[station];
2252 //transmission_list_iterator current = tmissions.begin();
2253 //transmission_list_iterator last = tmissions.end();
2255 //for ( ; current != last ; ++current ) {
2256 // if ( current->get_code().c1 == code.c1 &&
2257 // current->get_code().c2 == code.c2 &&
2258 // current->get_code().c3 == code.c3 ) {
2260 //if ( ttext ) message = current->get_transtext();
2261 //else message = current->get_menutext();
2262 strcpy( &mes[0], m.c_str() );
2264 // Replace all the '@' parameters with the actual text.
2265 int check = 0; // If mes gets overflowed the while loop can go infinite
2266 while ( strchr(&mes[0], crej) != NULL ) { // ie. loop until no more occurances of crej ('@') found
2267 pos = strchr( &mes[0], crej );
2268 bcopy(pos, &tag[0], 3);
2272 for ( i=0; i<cmax; i++ ) {
2273 if ( mes[i] == crej ) {
2278 strncpy( &dum[0], &mes[0], len );
2281 if ( strcmp ( tag, "@ST" ) == 0 )
2282 //strcat( &dum[0], tpars.station.c_str() );
2283 strcat(&dum[0], ident.c_str());
2284 else if ( strcmp ( tag, "@AP" ) == 0 )
2285 //strcat( &dum[0], tpars.airport.c_str() );
2286 strcat(&dum[0], name.c_str());
2287 else if ( strcmp ( tag, "@CS" ) == 0 )
2288 //strcat( &dum[0], tpars.callsign.c_str() );
2289 strcat(&dum[0], usercall.c_str());
2290 else if ( strcmp ( tag, "@TD" ) == 0 ) {
2292 if ( tpars.tdir == 1 ) {
2293 char buf[] = "left";
2294 strcat( &dum[0], &buf[0] );
2297 char buf[] = "right";
2298 strcat( &dum[0], &buf[0] );
2302 else if ( strcmp ( tag, "@HE" ) == 0 ) {
2305 sprintf( buf, "%i", (int)(tpars.heading) );
2306 strcat( &dum[0], &buf[0] );
2309 else if ( strcmp ( tag, "@VD" ) == 0 ) {
2311 if ( tpars.VDir == 1 ) {
2312 char buf[] = "Descend and maintain";
2313 strcat( &dum[0], &buf[0] );
2315 else if ( tpars.VDir == 2 ) {
2316 char buf[] = "Maintain";
2317 strcat( &dum[0], &buf[0] );
2319 else if ( tpars.VDir == 3 ) {
2320 char buf[] = "Climb and maintain";
2321 strcat( &dum[0], &buf[0] );
2325 else if ( strcmp ( tag, "@AL" ) == 0 ) {
2328 sprintf( buf, "%i", (int)(tpars.alt) );
2329 strcat( &dum[0], &buf[0] );
2332 else if ( strcmp ( tag, "@MI" ) == 0 ) {
2334 //sprintf( buf, "%3.1f", tpars.miles );
2335 int dist_miles = (int)dclGetHorizontalSeparation(Point3D(lon, lat, elev), Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), user_elev_node->getDoubleValue())) / 1600;
2336 sprintf(buf, "%i", dist_miles);
2337 strcat( &dum[0], &buf[0] );
2339 else if ( strcmp ( tag, "@FR" ) == 0 ) {
2342 sprintf( buf, "%6.2f", tpars.freq );
2343 strcat( &dum[0], &buf[0] );
2346 else if ( strcmp ( tag, "@RW" ) == 0 ) {
2347 strcat(&dum[0], ConvertRwyNumToSpokenString(activeRwy).c_str());
2348 } else if(strcmp(tag, "@CD") == 0) { // @CD = compass direction
2349 double h = GetHeadingFromTo(Point3D(lon, lat, elev), Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), user_elev_node->getDoubleValue()));
2350 while(h < 0.0) h += 360.0;
2351 while(h > 360.0) h -= 360.0;
2352 if(h < 22.5 || h > 337.5) {
2353 strcat(&dum[0], "North");
2354 } else if(h < 67.5) {
2355 strcat(&dum[0], "North-East");
2356 } else if(h < 112.5) {
2357 strcat(&dum[0], "East");
2358 } else if(h < 157.5) {
2359 strcat(&dum[0], "South-East");
2360 } else if(h < 202.5) {
2361 strcat(&dum[0], "South");
2362 } else if(h < 247.5) {
2363 strcat(&dum[0], "South-West");
2364 } else if(h < 292.5) {
2365 strcat(&dum[0], "West");
2367 strcat(&dum[0], "North-West");
2370 cout << "Tag " << tag << " not found" << endl;
2373 strcat( &dum[0], &mes[len+3] );
2374 strcpy( &mes[0], &dum[0] );
2378 SG_LOG(SG_ATC, SG_WARN, "WARNING: Possibly endless loop terminated in FGTransmissionlist::gen_text(...)");
2383 //cout << mes << endl;
2387 if ( mes != "" ) return mes;
2388 else return "No transmission found";
2391 ostream& operator << (ostream& os, tower_traffic_type ttt) {
2393 case(CIRCUIT): return(os << "CIRCUIT");
2394 case(INBOUND): return(os << "INBOUND");
2395 case(OUTBOUND): return(os << "OUTBOUND");
2396 case(TTT_UNKNOWN): return(os << "UNKNOWN");
2397 case(STRAIGHT_IN): return(os << "STRAIGHT_IN");
2399 return(os << "ERROR - Unknown switch in tower_traffic_type operator << ");