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(const 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(const 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(const PlaneRec& p, const 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 = fgGetAirportElev(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);
512 pending_transmission = trns;
515 //cout << "Not displaying, trns was " << trns << '\n';
517 t->vfrArrivalAcknowledged = true;
518 } else if(t->downwindReported) {
519 //cout << "Tower " << ident << " is responding to downwind reported...\n";
520 ProcessDownwindReport(t);
521 t->downwindReported = false;
522 } else if(t->holdShortReported) {
523 //cout << "Tower " << ident << " is reponding to holdShortReported...\n";
525 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!!)
526 // Do nothing for now - consider acknowloging hold short eventually
528 ClearHoldingPlane(t);
529 t->leg = TAKEOFF_ROLL;
530 rwyList.push_back(t);
532 // WARNING - WE ARE ASSUMING ONLY ONE PLANE REPORTING HOLD AT A TIME BELOW
533 // FIXME TODO - FIX THIS!!!
534 if(holdList.size()) {
535 if(holdListItr == holdList.end()) {
536 holdListItr = holdList.begin();
538 holdList.erase(holdListItr);
539 holdListItr = holdList.begin();
543 // Tell him to hold and what position he is.
544 // Not currently sure under which circumstances we do or don't bother transmitting this.
545 string trns = t->plane.callsign;
546 trns += " hold position";
548 //globals->get_ATC_display()->RegisterSingleMessage(trns, 0);
549 pending_transmission = trns;
552 // TODO - add some idea of what traffic is blocking him.
554 t->holdShortReported = false;
555 } else if(t->finalReported && !(t->finalAcknowledged)) {
556 //cout << "Tower " << ident << " is responding to finalReported...\n";
558 string trns = t->plane.callsign;
559 //cout << (t->nextOnRwy ? "Next on rwy " : "Not next!! ");
560 //cout << (rwyOccupied ? "RWY OCCUPIED!!\n" : "Rwy not occupied\n");
561 if(t->nextOnRwy && !rwyOccupied && !(t->instructedToGoAround)) {
562 if(t->landingType == FULL_STOP) {
563 trns += " cleared to land ";
565 trns += " cleared for the option ";
568 t->clearedToLand = true;
569 // Maybe remove report downwind from menu here as well incase user didn't bother to?
571 //cout << "ADD VACATED B\n";
572 // Put going around at the top (and hence default) since that'll be more desperate,
573 // or put rwy vacated at the top since that'll be more common?
574 current_atcdialog->add_entry(ident, "@CS Going Around", "Report going around", TOWER, USER_REPORT_GOING_AROUND);
575 current_atcdialog->add_entry(ident, "@CS Clear of the runway", "Report runway vacated", TOWER, USER_REPORT_RWY_VACATED);
577 t->planePtr->RegisterTransmission(7);
579 } else if(t->eta < 20) {
580 // Do nothing - we'll be telling it to go around in less than 10 seconds if the
581 // runway doesn't clear so no point in calling "continue approach".
584 trns += " continue approach";
585 t->clearedToLand = false;
587 if(_display && disp) {
588 //globals->get_ATC_display()->RegisterSingleMessage(trns);
589 pending_transmission = trns;
592 t->finalAcknowledged = true;
593 } else if(t->rwyVacatedReported && !(t->rwyVacatedAcknowledged)) {
594 ProcessRunwayVacatedReport(t);
595 t->rwyVacatedAcknowledged = true;
598 //freqClear = true; // FIXME - set this to come true after enough time to render the message
599 _releaseCounter = 0.0;
601 _runReleaseCounter = true;
602 //cout << "Done Respond\n" << endl;
605 void FGTower::ProcessDownwindReport(TowerPlaneRec* t) {
607 int a = 0; // Count of preceding planes on approach
608 bool cf = false; // conflicting traffic on final
609 bool cc = false; // preceding traffic in circuit
610 TowerPlaneRec* tc = NULL;
611 for(tower_plane_rec_list_iterator twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
612 if((*twrItr)->plane.callsign == responseID) break;
616 if(i > 1) { cc = true; }
617 doThresholdETACalc();
618 TowerPlaneRec* tf = NULL;
619 for(tower_plane_rec_list_iterator twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
620 if((*twrItr)->eta < (t->eta + 45)) {
624 // This should set the flagged plane to be the last conflicting one, and hence the one to follow.
625 // It ignores the fact that we might have problems slotting into the approach traffic behind it -
626 // eventually we'll need some fancy algorithms for that!
629 string trns = t->plane.callsign;
631 trns += ConvertNumToSpokenDigits(i + a);
632 // This assumes that the number spoken is landing position, not circuit position, since some of the traffic might be on straight-in final.
634 TowerPlaneRec* tt = NULL;
635 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.
636 trns += "Cleared to land"; // TODO - clear for the option if appropriate
637 t->clearedToLand = true;
638 if(!t->isUser) t->planePtr->RegisterTransmission(7);
639 } else if((i+a) > 1) {
640 //First set tt to point to the correct preceding plane - final or circuit
642 tt = (tf->eta < tc->eta ? tf : tc);
648 // We should never get here!
649 SG_LOG(SG_ATC, SG_ALERT, "ALERT - Logic error in FGTower::ProcessDownwindReport");
652 trns += "Follow the ";
653 string s = tt->plane.callsign;
657 if((tt->opType) == CIRCUIT) {
662 leg = tt->planePtr->GetLeg();
666 } else if(leg == TURN4) {
667 trns += " turning final";
668 } else if(leg == BASE) {
670 } else if(leg == TURN3) {
671 trns += " turning base";
674 double miles_out = CalcDistOutMiles(tt);
676 trns += " on short final";
679 trns += ConvertNumToSpokenDigits((int)miles_out);
680 trns += " mile final";
685 //globals->get_ATC_display()->RegisterSingleMessage(trns);
686 pending_transmission = trns;
690 if(t->opType == TTT_UNKNOWN) t->opType = CIRCUIT;
691 //cout << "ADD VACATED A\n";
692 // Put going around at the top (and hence default) since that'll be more desperate,
693 // or put rwy vacated at the top since that'll be more common?
694 //cout << "ident = " << ident << ", adding go-around option\n";
695 current_atcdialog->add_entry(ident, "@CS Going Around", "Report going around", TOWER, USER_REPORT_GOING_AROUND);
696 current_atcdialog->add_entry(ident, "@CS Clear of the runway", "Report runway vacated", TOWER, USER_REPORT_RWY_VACATED);
700 void FGTower::ProcessRunwayVacatedReport(TowerPlaneRec* t) {
701 //cout << "Processing rwy vacated...\n";
702 if(t->isUser) current_atcdialog->remove_entry(ident, USER_REPORT_GOING_AROUND, TOWER);
703 string trns = t->plane.callsign;
705 trns += " Contact ground on ";
706 double f = globals->get_ATC_mgr()->GetFrequency(ident, GROUND) / 100.0;
708 sprintf(buf, "%.2f", f);
711 if(!t->isUser) t->planePtr->RegisterTransmission(5);
714 trns += " cleared for taxi to general aviation parking";
715 if(!t->isUser) t->planePtr->RegisterTransmission(6); // TODO - this is a mega-hack!!
717 //cout << "trns = " << trns << '\n';
719 //globals->get_ATC_display()->RegisterSingleMessage(trns);
720 pending_transmission = trns;
723 RemoveFromRwyList(t->plane.callsign);
725 // Maybe we should check that the plane really *has* vacated the runway!
728 // *********** END RESPONSE FUNCTIONS *****************
730 // Currently this assumes we *are* next on the runway and doesn't check for planes about to land -
731 // this should be done prior to calling this function.
732 void FGTower::ClearHoldingPlane(TowerPlaneRec* t) {
733 //cout << "Entering ClearHoldingPlane..." << endl;
735 string trns = t->plane.callsign;
736 //if(departed plane < some threshold in time away) {
738 //if(timeSinceLastDeparture <= 60.0 && departed == true) {
740 t->clearedToLineUp = true;
741 t->planePtr->RegisterTransmission(3); // cleared to line-up
742 //} else if(arriving plane < some threshold away) {
743 } else if(GetTrafficETA(2) < 150.0 && (timeSinceLastDeparture > 60.0 || departed == false)) { // Hack - hardwired time
744 trns += " cleared immediate take-off";
745 if(trafficList.size()) {
746 tower_plane_rec_list_iterator trfcItr = trafficList.begin();
747 trfcItr++; // At the moment the holding plane should be first in trafficList.
748 // Note though that this will break if holding planes aren't put in trafficList in the future.
749 TowerPlaneRec* trfc = *trfcItr;
750 trns += "... traffic is";
751 switch(trfc->plane.type) {
755 trns += " a Cessna"; // TODO - add ability to specify actual plane type somewhere
761 trns += " a King-air";
764 trns += " a Learjet";
767 trns += " a Regional";
776 //if(trfc->opType == STRAIGHT_IN || trfc->opType == TTT_UNKNOWN) {
777 if(trfc->opType == STRAIGHT_IN) {
778 double miles_out = CalcDistOutMiles(trfc);
783 trns += ConvertNumToSpokenDigits((int)miles_out);
784 trns += " mile final";
786 } else if(trfc->opType == CIRCUIT) {
787 //cout << "Getting leg of " << trfc->plane.callsign << '\n';
793 trns += " turning final";
799 trns += " turning base";
802 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.
804 // And to eliminate compiler warnings...
805 case TAKEOFF_ROLL: break;
806 case CLIMBOUT: break;
808 case CROSSWIND: break;
810 case LANDING_ROLL: break;
811 case LEG_UNKNOWN: break;
815 // By definition there should be some arriving traffic if we're cleared for immediate takeoff
816 SG_LOG(SG_ATC, SG_WARN, "Warning: Departing traffic cleared for *immediate* take-off despite no arriving traffic in FGTower");
818 t->clearedToTakeOff = true;
819 t->planePtr->RegisterTransmission(4); // cleared to take-off - TODO differentiate between immediate and normal take-off
821 timeSinceLastDeparture = 0.0;
823 //} else if(timeSinceLastDeparture > 60.0 || departed == false) { // Hack - test for timeSinceLastDeparture should be in lineup block eventually
824 trns += " cleared for take-off";
825 // TODO - add traffic is... ?
826 t->clearedToTakeOff = true;
827 t->planePtr->RegisterTransmission(4); // cleared to take-off
829 timeSinceLastDeparture = 0.0;
832 //globals->get_ATC_display()->RegisterSingleMessage(trns, 0);
833 pending_transmission = trns;
836 //cout << "Done ClearHoldingPlane " << endl;
840 // ***************************************************************************************
841 // ********** Functions to periodically check what the various traffic is doing **********
843 // Do one plane from the hold list
844 void FGTower::CheckHoldList(double dt) {
845 //cout << "Entering CheckHoldList..." << endl;
846 if(holdList.size()) {
847 //cout << "*holdListItr = " << *holdListItr << endl;
848 if(holdListItr == holdList.end()) {
849 holdListItr = holdList.begin();
851 //cout << "*holdListItr = " << *holdListItr << endl;
852 //Process(*holdListItr);
853 TowerPlaneRec* t = *holdListItr;
854 //cout << "t = " << t << endl;
855 if(t->holdShortReported) {
856 // NO-OP - leave it to the response handler.
857 } else { // not responding to report, but still need to clear if clear
859 //cout << "departed = " << departed << '\n';
860 //cout << "timeSinceLastDeparture = " << timeSinceLastDeparture << '\n';
863 } else if(timeSinceLastDeparture <= 60.0 && departed == true) {
864 // Do nothing - this is a bit of a hack - should maybe do line up be ready here
866 ClearHoldingPlane(t);
867 t->leg = TAKEOFF_ROLL;
868 rwyList.push_back(t);
870 holdList.erase(holdListItr);
871 holdListItr = holdList.begin();
874 // TODO - rationalise the considerable code duplication above!
878 //cout << "Done CheckHoldList" << endl;
881 // do the ciruit list
882 void FGTower::CheckCircuitList(double dt) {
883 //cout << "Entering CheckCircuitList..." << endl;
884 // Clear the constraints - we recalculate here.
886 downwind_leg_pos = 0.0;
887 crosswind_leg_pos = 0.0;
889 if(circuitList.size()) { // Do one plane from the circuit
890 if(circuitListItr == circuitList.end()) {
891 circuitListItr = circuitList.begin();
893 TowerPlaneRec* t = *circuitListItr;
894 //cout << ident << ' ' << circuitList.size() << ' ' << t->plane.callsign << " " << t->leg << " eta " << t->eta << '\n';
896 t->pos.setlon(user_lon_node->getDoubleValue());
897 t->pos.setlat(user_lat_node->getDoubleValue());
898 t->pos.setelev(user_elev_node->getDoubleValue());
899 //cout << ident << ' ' << circuitList.size() << ' ' << t->plane.callsign << " " << t->leg << " eta " << t->eta << '\n';
901 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.
902 t->landingType = t->planePtr->GetLandingOption();
903 //cout << "AI plane landing option is " << t->landingType << '\n';
905 Point3D tortho = ortho.ConvertToLocal(t->pos);
907 // Need to figure out which leg he's on
908 //cout << "rwy.hdg = " << rwy.hdg << " user hdg = " << user_hdg_node->getDoubleValue();
909 double ho = GetAngleDiff_deg(user_hdg_node->getDoubleValue(), rwy.hdg);
910 //cout << " ho = " << ho << " abs(ho = " << abs(ho) << '\n';
911 // TODO FIXME - get the wind and convert this to track, or otherwise use track somehow!!!
912 // If it's gusty might need to filter the value, although we are leaving 30 degrees each way leeway!
914 // could be either takeoff, climbout or landing - check orthopos.y
915 //cout << "tortho.y = " << tortho.y() << '\n';
916 if((tortho.y() < 0) || (t->leg == TURN4) || (t->leg == FINAL)) {
920 t->leg = CLIMBOUT; // TODO - check elev wrt. apt elev to differentiate takeoff roll and climbout
921 //cout << "Climbout\n";
922 // If it's the user we may be unsure of his/her intentions.
923 // (Hopefully the AI planes won't try confusing the sim!!!)
924 //cout << "tortho.y = " << tortho.y() << '\n';
925 if(t->opType == TTT_UNKNOWN) {
926 if(tortho.y() > 5000) {
927 // 5 km out from threshold - assume it's a departure
928 t->opType = OUTBOUND; // TODO - could check if the user has climbed significantly above circuit altitude as well.
929 // Since we are unknown operation we should be in depList already.
930 //cout << ident << " Removing user from circuitList (TTT_UNKNOWN)\n";
931 circuitList.erase(circuitListItr);
932 RemoveFromTrafficList(t->plane.callsign);
933 circuitListItr = circuitList.begin();
935 } else if(t->opType == CIRCUIT) {
936 if(tortho.y() > 10000) {
937 // 10 km out - assume the user has abandoned the circuit!!
938 t->opType = OUTBOUND;
939 depList.push_back(t);
940 //cout << ident << " removing user from circuitList (CIRCUIT)\n";
941 circuitList.erase(circuitListItr);
942 circuitListItr = circuitList.begin();
946 } else if(fabs(ho) < 60) {
948 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
949 if((t->leg == CLIMBOUT) || (t->leg == TURN1)) {
956 } else if(fabs(ho) < 120) {
958 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
959 if((t->leg == TURN1) || (t->leg == CROSSWIND)) {
961 //cout << "Crosswind\n";
966 } else if(fabs(ho) < 150) {
968 // TODO - either fix or doublecheck this hack by looking at heading and pattern direction
969 if((t->leg == CROSSWIND) || (t->leg == TURN2)) {
974 // Probably safe now to assume the user is flying a circuit
981 //cout << "Downwind\n";
983 if(t->leg == FINAL) {
984 if(OnActiveRunway(t->pos)) {
985 t->leg = LANDING_ROLL;
989 t->leg = t->planePtr->GetLeg();
992 // Set the constraints IF this is the first plane in the circuit
993 // 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!!
994 if(circuitListItr == circuitList.begin()) {
997 // 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.
998 base_leg_pos = tortho.y();
999 //cout << "base_leg_pos = " << base_leg_pos << '\n';
1002 // Fall through to base
1004 base_leg_pos = tortho.y();
1005 //cout << "base_leg_pos = " << base_leg_pos << '\n';
1008 // Fall through to downwind
1010 // Only have the downwind leg pos as turn-to-base constraint if more negative than we already have.
1011 base_leg_pos = (tortho.y() < base_leg_pos ? tortho.y() : base_leg_pos);
1012 //cout << "base_leg_pos = " << base_leg_pos;
1013 downwind_leg_pos = tortho.x(); // Assume that a following plane can simply be constrained by the immediately in front downwind plane
1014 //cout << " downwind_leg_pos = " << downwind_leg_pos << '\n';
1017 // Fall through to crosswind
1019 crosswind_leg_pos = tortho.y();
1020 //cout << "crosswind_leg_pos = " << crosswind_leg_pos << '\n';
1021 t->instructedToGoAround = false;
1024 // Fall through to climbout
1026 // Only use current by constraint as largest
1027 crosswind_leg_pos = (tortho.y() > crosswind_leg_pos ? tortho.y() : crosswind_leg_pos);
1028 //cout << "crosswind_leg_pos = " << crosswind_leg_pos << '\n';
1041 if(t->leg == FINAL && !(t->instructedToGoAround)) {
1042 doThresholdETACalc();
1043 doThresholdUseOrder();
1046 cout << "Checking USER on final... ";
1047 cout << "eta " << t->eta;
1048 if(t->clearedToLand) cout << " cleared to land\n";
1051 //cout << "YES FINAL, t->eta = " << t->eta << ", rwyList.size() = " << rwyList.size() << '\n';
1052 if(t->landingType == FULL_STOP) {
1053 t->opType = INBOUND;
1054 //cout << "\n******** SWITCHING TO INBOUND AT POINT AAA *********\n\n";
1056 if(t->eta < 12 && rwyList.size()) {
1057 // TODO - need to make this more sophisticated
1058 // eg. is the plane accelerating down the runway taking off [OK],
1059 // or stationary near the start [V. BAD!!].
1060 // For now this should stop the AI plane landing on top of the user.
1061 string trns = t->plane.callsign;
1062 trns += " GO AROUND TRAFFIC ON RUNWAY I REPEAT GO AROUND";
1063 pending_transmission = trns;
1064 ImmediateTransmit();
1065 t->instructedToGoAround = true;
1066 t->clearedToLand = false;
1067 // Assume it complies!!!
1068 t->opType = CIRCUIT;
1071 //cout << "Registering Go-around transmission with AI plane\n";
1072 t->planePtr->RegisterTransmission(13);
1074 } else if(!t->clearedToLand) {
1075 // The whip through the appList is a hack since currently t->nextOnRwy doesn't always work
1078 for(tower_plane_rec_list_iterator twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1079 if((*twrItr)->eta < t->eta) {
1083 if(t->nextOnRwy && !cf) {
1084 if(!rwyList.size()) {
1085 string trns = t->plane.callsign;
1086 trns += " Cleared to land";
1087 pending_transmission = trns;
1089 //if(t->isUser) cout << "Transmitting cleared to Land!!!\n";
1090 t->clearedToLand = true;
1092 t->planePtr->RegisterTransmission(7);
1096 //if(t->isUser) cout << "Not next\n";
1099 } else if(t->leg == LANDING_ROLL) {
1100 //cout << t->plane.callsign << " has landed - adding to rwyList\n";
1101 rwyList.push_front(t);
1102 // TODO - if(!clearedToLand) shout something!!
1103 t->clearedToLand = false;
1104 RemoveFromTrafficList(t->plane.callsign);
1106 t->opType = TTT_UNKNOWN;
1107 } // TODO - allow the user to specify opType via ATC menu
1108 //cout << ident << " Removing " << t->plane.callsign << " from circuitList..." << endl;
1109 circuitListItr = circuitList.erase(circuitListItr);
1110 if(circuitListItr == circuitList.end() ) {
1111 circuitListItr = circuitList.begin();
1112 // avoid increment of circuitListItr (would increment to second element, or crash if no element left)
1118 //cout << "Done CheckCircuitList" << endl;
1121 // 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!!
1122 // FIXME - at the moment it looks like we're only doing the first plane from the rwy list.
1123 // (However, at the moment there should only be one airplane on the rwy at once, until we
1124 // start allowing planes to line up whilst previous arrival clears the rwy.)
1125 void FGTower::CheckRunwayList(double dt) {
1126 //cout << "Entering CheckRunwayList..." << endl;
1128 if(!rwyList.size()) {
1129 rwyOccupied = false;
1131 rwyListItr = rwyList.begin();
1132 TowerPlaneRec* t = *rwyListItr;
1134 t->pos.setlon(user_lon_node->getDoubleValue());
1135 t->pos.setlat(user_lat_node->getDoubleValue());
1136 t->pos.setelev(user_elev_node->getDoubleValue());
1138 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.
1140 bool on_rwy = OnActiveRunway(t->pos);
1142 // TODO - for all of these we need to check what the user is *actually* doing!
1143 if((t->opType == INBOUND) || (t->opType == STRAIGHT_IN)) {
1144 //cout << "Tower " << ident << " is removing plane " << t->plane.callsign << " from rwy list (vacated)\n";
1145 //cout << "Size of rwylist was " << rwyList.size() << '\n';
1146 //cout << "Size of vacatedList was " << vacatedList.size() << '\n';
1147 RemoveFromRwyList(t->plane.callsign);
1148 AddToVacatedList(t);
1149 //cout << "Size of rwylist is " << rwyList.size() << '\n';
1150 //cout << "Size of vacatedList is " << vacatedList.size() << '\n';
1151 // At the moment we wait until Runway Vacated is reported by the plane before telling to contact ground etc.
1152 // It's possible we could be a bit more proactive about this.
1153 } else if(t->opType == OUTBOUND) {
1154 depList.push_back(t);
1155 rwyList.pop_front();
1157 timeSinceLastDeparture = 0.0;
1158 } else if(t->opType == CIRCUIT) {
1159 //cout << ident << " adding " << t->plane.callsign << " to circuitList" << endl;
1160 circuitList.push_back(t);
1161 AddToTrafficList(t);
1162 rwyList.pop_front();
1164 timeSinceLastDeparture = 0.0;
1165 } else if(t->opType == TTT_UNKNOWN) {
1166 depList.push_back(t);
1167 //cout << ident << " adding " << t->plane.callsign << " to circuitList" << endl;
1168 circuitList.push_back(t);
1169 AddToTrafficList(t);
1170 rwyList.pop_front();
1172 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.
1174 // HELP - we shouldn't ever get here!!!
1179 //cout << "Done CheckRunwayList" << endl;
1182 // Do one plane from the approach list
1183 void FGTower::CheckApproachList(double dt) {
1184 //cout << "CheckApproachList called for " << ident << endl;
1185 //cout << "AppList.size is " << appList.size() << endl;
1186 if(appList.size()) {
1187 if(appListItr == appList.end()) {
1188 appListItr = appList.begin();
1190 TowerPlaneRec* t = *appListItr;
1191 //cout << "t = " << t << endl;
1192 //cout << "Checking " << t->plane.callsign << endl;
1194 t->pos.setlon(user_lon_node->getDoubleValue());
1195 t->pos.setlat(user_lat_node->getDoubleValue());
1196 t->pos.setelev(user_elev_node->getDoubleValue());
1198 // TODO - set/update the position if it's an AI plane
1200 doThresholdETACalc(); // We need this here because planes in the lists are not guaranteed to *always* have the correct ETA
1201 //cout << "eta is " << t->eta << ", rwy is " << (rwyList.size() ? "occupied " : "clear ") << '\n';
1202 if(t->eta < 12 && rwyList.size() && !(t->instructedToGoAround)) {
1203 // TODO - need to make this more sophisticated
1204 // eg. is the plane accelerating down the runway taking off [OK],
1205 // or stationary near the start [V. BAD!!].
1206 // For now this should stop the AI plane landing on top of the user.
1207 string trns = t->plane.callsign;
1208 trns += " GO AROUND TRAFFIC ON RUNWAY I REPEAT GO AROUND";
1209 pending_transmission = trns;
1210 ImmediateTransmit();
1211 t->instructedToGoAround = true;
1212 t->clearedToLand = false;
1213 t->nextOnRwy = false; // But note this is recalculated so don't rely on it
1214 // Assume it complies!!!
1215 t->opType = CIRCUIT;
1219 //cout << "Registering Go-around transmission with AI plane\n";
1220 t->planePtr->RegisterTransmission(13);
1223 // TODO - add Go-around ack to comm options,
1224 // remove report rwy vacated. (possibly).
1226 } else if(t->eta < 90 && !t->clearedToLand) {
1227 //doThresholdETACalc();
1228 doThresholdUseOrder();
1229 // The whip through the appList is a hack since currently t->nextOnRwy doesn't always work
1232 for(tower_plane_rec_list_iterator twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1233 if((*twrItr)->eta < t->eta) {
1237 if(t->nextOnRwy && !cf) {
1238 if(!rwyList.size()) {
1239 string trns = t->plane.callsign;
1240 trns += " Cleared to land";
1241 pending_transmission = trns;
1243 //if(t->isUser) cout << "Transmitting cleared to Land!!!\n";
1244 t->clearedToLand = true;
1246 t->planePtr->RegisterTransmission(7);
1250 //if(t->isUser) cout << "Not next\n";
1254 // Check for landing...
1255 bool landed = false;
1258 if(t->planePtr->GetLeg() == LANDING_ROLL) {
1262 SG_LOG(SG_ATC, SG_ALERT, "WARNING - not user and null planePtr in CheckApproachList!");
1265 if(OnActiveRunway(t->pos)) {
1271 // Duplicated in CheckCircuitList - must be able to rationalise this somehow!
1272 //cout << "A " << t->plane.callsign << " has landed, adding to rwyList...\n";
1273 rwyList.push_front(t);
1274 // TODO - if(!clearedToLand) shout something!!
1275 t->clearedToLand = false;
1276 RemoveFromTrafficList(t->plane.callsign);
1278 // t->opType = TTT_UNKNOWN;
1279 //} // TODO - allow the user to specify opType via ATC menu
1280 appListItr = appList.erase(appListItr);
1281 if(appListItr == appList.end() ) {
1282 appListItr = appList.begin();
1288 //cout << "Done" << endl;
1291 // Do one plane from the departure list
1292 void FGTower::CheckDepartureList(double dt) {
1293 if(depList.size()) {
1294 if(depListItr == depList.end()) {
1295 depListItr = depList.begin();
1297 TowerPlaneRec* t = *depListItr;
1298 //cout << "Dep list, checking " << t->plane.callsign;
1300 double distout; // meters
1301 if(t->isUser) distout = dclGetHorizontalSeparation(Point3D(lon, lat, elev), Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), user_elev_node->getDoubleValue()));
1302 else distout = dclGetHorizontalSeparation(Point3D(lon, lat, elev), t->planePtr->GetPos());
1303 //cout << " distout = " << distout << '\n';
1304 if(distout > 10000) {
1305 string trns = t->plane.callsign;
1306 trns += " You are now clear of my airspace, good day";
1307 pending_transmission = trns;
1310 // Change the communication options
1311 RemoveAllUserDialogOptions();
1312 //cout << "ADD A\n";
1313 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);
1315 // Send a clear-of-airspace signal
1316 // TODO - implement this once we actually have departing AI traffic (currently all circuits or arrivals).
1318 RemovePlane(t->plane.callsign);
1325 // ********** End periodic check functions ***********************************************
1326 // ***************************************************************************************
1329 // Remove all dialog options for this tower.
1330 void FGTower::RemoveAllUserDialogOptions() {
1331 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_DEPARTURE, TOWER);
1332 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL, TOWER);
1333 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL_FULL_STOP, TOWER);
1334 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL_TOUCH_AND_GO, TOWER);
1335 current_atcdialog->remove_entry(ident, USER_REPORT_3_MILE_FINAL, TOWER);
1336 current_atcdialog->remove_entry(ident, USER_REPORT_DOWNWIND, TOWER);
1337 current_atcdialog->remove_entry(ident, USER_REPORT_RWY_VACATED, TOWER);
1338 current_atcdialog->remove_entry(ident, USER_REPORT_GOING_AROUND, TOWER);
1341 // Returns true if positions of crosswind/downwind/base leg turns should be constrained by previous traffic
1342 // plus the constraint position as a rwy orientated orthopos (meters)
1343 bool FGTower::GetCrosswindConstraint(double& cpos) {
1344 if(crosswind_leg_pos != 0.0) {
1345 cpos = crosswind_leg_pos;
1352 bool FGTower::GetDownwindConstraint(double& dpos) {
1353 if(fabs(downwind_leg_pos) > nominal_downwind_leg_pos) {
1354 dpos = downwind_leg_pos;
1361 bool FGTower::GetBaseConstraint(double& bpos) {
1362 if(base_leg_pos < nominal_base_leg_pos) {
1363 bpos = base_leg_pos;
1366 bpos = nominal_base_leg_pos;
1372 // Figure out which runways are active.
1373 // For now we'll just be simple and do one active runway - eventually this will get much more complex
1374 // This is a private function - public interface to the results of this is through GetActiveRunway
1375 void FGTower::DoRwyDetails() {
1376 //cout << "GetRwyDetails called" << endl;
1378 // Based on the airport-id and wind get the active runway
1381 double hdg = wind_from_hdg->getDoubleValue();
1382 double speed = wind_speed_knots->getDoubleValue();
1383 hdg = (speed == 0.0 ? 270.0 : hdg);
1384 //cout << "Heading = " << hdg << '\n';
1387 bool rwyGood = globals->get_runways()->search(ident, int(hdg), &runway);
1389 //cout << "RUNWAY GOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOD\n";
1390 activeRwy = runway._rwy_no;
1391 rwy.rwyID = runway._rwy_no;
1392 SG_LOG(SG_ATC, SG_INFO, "Active runway for airport " << ident << " is " << activeRwy);
1394 // Get the threshold position
1395 double other_way = runway._heading - 180.0;
1396 while(other_way <= 0.0) {
1399 // move to the +l end/center of the runway
1400 //cout << "Runway center is at " << runway._lon << ", " << runway._lat << '\n';
1401 Point3D origin = Point3D(runway._lon, runway._lat, aptElev);
1402 Point3D ref = origin;
1403 double tshlon, tshlat, tshr;
1404 double tolon, tolat, tor;
1405 rwy.length = runway._length * SG_FEET_TO_METER;
1406 rwy.width = runway._width * SG_FEET_TO_METER;
1407 geo_direct_wgs_84 ( aptElev, ref.lat(), ref.lon(), other_way,
1408 rwy.length / 2.0 - 25.0, &tshlat, &tshlon, &tshr );
1409 geo_direct_wgs_84 ( aptElev, ref.lat(), ref.lon(), runway._heading,
1410 rwy.length / 2.0 - 25.0, &tolat, &tolon, &tor );
1411 // Note - 25 meters in from the runway end is a bit of a hack to put the plane ahead of the user.
1412 // now copy what we need out of runway into rwy
1413 rwy.threshold_pos = Point3D(tshlon, tshlat, aptElev);
1414 Point3D takeoff_end = Point3D(tolon, tolat, aptElev);
1415 //cout << "Threshold position = " << tshlon << ", " << tshlat << ", " << aptElev << '\n';
1416 //cout << "Takeoff position = " << tolon << ", " << tolat << ", " << aptElev << '\n';
1417 rwy.hdg = runway._heading;
1418 // Set the projection for the local area based on this active runway
1419 ortho.Init(rwy.threshold_pos, rwy.hdg);
1420 rwy.end1ortho = ortho.ConvertToLocal(rwy.threshold_pos); // should come out as zero
1421 rwy.end2ortho = ortho.ConvertToLocal(takeoff_end);
1423 // Set the pattern direction
1424 // TODO - we'll check for a facilities file with this in eventually - for now assume left traffic except
1425 // for certain circumstances (RH parallel rwy).
1426 rwy.patternDirection = -1; // Left
1427 if(rwy.rwyID.size() == 3) {
1428 rwy.patternDirection = (rwy.rwyID.substr(2,1) == "R" ? 1 : -1);
1430 //cout << "Doing details, rwy.patterDirection is " << rwy.patternDirection << '\n';
1432 SG_LOG(SG_ATC, SG_ALERT, "Help - can't get good runway in FGTower!!");
1438 // Figure out if a given position lies on the active runway
1439 // Might have to change when we consider more than one active rwy.
1440 bool FGTower::OnActiveRunway(const Point3D& pt) {
1441 // TODO - check that the centre calculation below isn't confused by displaced thesholds etc.
1442 Point3D xyc((rwy.end1ortho.x() + rwy.end2ortho.x())/2.0, (rwy.end1ortho.y() + rwy.end2ortho.y())/2.0, 0.0);
1443 Point3D xyp = ortho.ConvertToLocal(pt);
1445 //cout << "Length offset = " << fabs(xyp.y() - xyc.y()) << '\n';
1446 //cout << "Width offset = " << fabs(xyp.x() - xyc.x()) << '\n';
1448 double rlen = rwy.length/2.0 + 5.0;
1449 double rwidth = rwy.width/2.0;
1450 double ldiff = fabs(xyp.y() - xyc.y());
1451 double wdiff = fabs(xyp.x() - xyc.x());
1453 return((ldiff < rlen) && (wdiff < rwidth));
1457 // Figure out if a given position lies on any runway or not
1458 // Only call this at startup - reading the runways database is expensive and needs to be fixed!
1459 bool FGTower::OnAnyRunway(const Point3D& pt) {
1461 double dist = current_commlist->FindClosest(lon, lat, elev, ad, TOWER, 10.0);
1465 // Based on the airport-id, go through all the runways and check for a point in them
1467 // TODO - do we actually need to search for the airport - surely we already know our ident and
1468 // can just search runways of our airport???
1469 //cout << "Airport ident is " << ad.ident << '\n';
1471 bool rwyGood = globals->get_runways()->search(ad.ident, &runway);
1473 SG_LOG(SG_ATC, SG_WARN, "Unable to find any runways for airport ID " << ad.ident << " in FGTower");
1476 while(runway._id == ad.ident) {
1477 on = OnRunway(pt, runway);
1478 //cout << "Runway " << runway._rwy_no << ": On = " << (on ? "true\n" : "false\n");
1479 if(on) return(true);
1480 globals->get_runways()->next(&runway);
1486 // Returns true if successful
1487 bool FGTower::RemoveFromTrafficList(const string& id) {
1488 tower_plane_rec_list_iterator twrItr;
1489 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
1490 TowerPlaneRec* tpr = *twrItr;
1491 if(tpr->plane.callsign == id) {
1492 trafficList.erase(twrItr);
1493 trafficListItr = trafficList.begin();
1497 SG_LOG(SG_ATC, SG_WARN, "Warning - unable to remove aircraft " << id << " from trafficList in FGTower");
1502 // Returns true if successful
1503 bool FGTower::RemoveFromAppList(const string& id) {
1504 tower_plane_rec_list_iterator twrItr;
1505 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1506 TowerPlaneRec* tpr = *twrItr;
1507 if(tpr->plane.callsign == id) {
1508 appList.erase(twrItr);
1509 appListItr = appList.begin();
1513 //SG_LOG(SG_ATC, SG_WARN, "Warning - unable to remove aircraft " << id << " from appList in FGTower");
1517 // Returns true if successful
1518 bool FGTower::RemoveFromRwyList(const string& id) {
1519 tower_plane_rec_list_iterator twrItr;
1520 for(twrItr = rwyList.begin(); twrItr != rwyList.end(); twrItr++) {
1521 TowerPlaneRec* tpr = *twrItr;
1522 if(tpr->plane.callsign == id) {
1523 rwyList.erase(twrItr);
1524 rwyListItr = rwyList.begin();
1528 //SG_LOG(SG_ATC, SG_WARN, "Warning - unable to remove aircraft " << id << " from rwyList in FGTower");
1533 // Add a tower plane rec with ETA to the traffic list in the correct position ETA-wise
1534 // and set nextOnRwy if so.
1535 // Returns true if this could cause a threshold ETA conflict with other traffic, false otherwise.
1536 // For planes holding they are put in the first position with time to go, and the return value is
1537 // true if in the first position (nextOnRwy) and false otherwise.
1538 // See the comments in FGTower::doThresholdUseOrder for notes on the ordering
1539 bool FGTower::AddToTrafficList(TowerPlaneRec* t, bool holding) {
1540 //cout << "ADD: " << trafficList.size();
1541 //cout << "AddToTrafficList called, currently size = " << trafficList.size() << ", holding = " << holding << endl;
1542 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.
1543 double departure_sep_time = 60.0; // Separation time behind departing airplanes. Comments above also apply.
1544 bool conflict = false;
1545 double lastETA = 0.0;
1546 bool firstTime = true;
1547 // FIXME - make this more robust for different plane types eg. light following heavy.
1548 tower_plane_rec_list_iterator twrItr;
1549 //twrItr = trafficList.begin();
1551 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
1552 //if(twrItr == trafficList.end()) {
1554 // trafficList.push_back(t);
1555 // return(holding ? firstTime : conflict);
1557 TowerPlaneRec* tpr = *twrItr;
1559 //cout << (tpr->isUser ? "USER!\n" : "NOT user\n");
1560 //cout << "tpr->eta - lastETA = " << tpr->eta - lastETA << '\n';
1561 double dep_allowance = (timeSinceLastDeparture < departure_sep_time ? departure_sep_time - timeSinceLastDeparture : 0.0);
1562 double slot_time = (firstTime ? separation_time + dep_allowance : separation_time + departure_sep_time);
1563 // separation_time + departure_sep_time in the above accounts for the fact that the arrival could be touch and go,
1564 // and if not needs time to clear the rwy anyway.
1565 if(tpr->eta - lastETA > slot_time) {
1566 t->nextOnRwy = firstTime;
1567 trafficList.insert(twrItr, t);
1568 //cout << "\tH\t" << trafficList.size() << '\n';
1573 if(t->eta < tpr->eta) {
1574 // Ugg - this one's tricky.
1575 // It depends on what the two planes are doing and whether there's a conflict what we do.
1576 if(tpr->eta - t->eta > separation_time) { // No probs, plane 2 can squeeze in before plane 1 with no apparent conflict
1577 if(tpr->nextOnRwy) {
1578 tpr->nextOnRwy = false;
1579 t->nextOnRwy = true;
1581 trafficList.insert(twrItr, t);
1582 } else { // Ooops - this ones tricky - we have a potential conflict!
1584 // HACK - just add anyway for now and flag conflict - TODO - FIX THIS using CIRCUIT/STRAIGHT_IN and VFR/IFR precedence rules.
1585 if(tpr->nextOnRwy) {
1586 tpr->nextOnRwy = false;
1587 t->nextOnRwy = true;
1589 trafficList.insert(twrItr, t);
1591 //cout << "\tC\t" << trafficList.size() << '\n';
1598 // If we get here we must be at the end of the list, or maybe the list is empty.
1599 if(!trafficList.size()) {
1600 t->nextOnRwy = true;
1601 // conflict and firstTime should be false and true respectively in this case anyway.
1603 t->nextOnRwy = false;
1605 trafficList.push_back(t);
1606 //cout << "\tE\t" << trafficList.size() << endl;
1607 return(holding ? firstTime : conflict);
1610 // Add a tower plane rec with ETA to the circuit list in the correct position ETA-wise
1611 // Returns true if this might cause a separation conflict (based on ETA) with other traffic, false otherwise.
1612 // Safe to add a plane that is already in - planes with the same callsign are not added.
1613 bool FGTower::AddToCircuitList(TowerPlaneRec* t) {
1615 //cout << "**********************************************\n";
1616 //cout << "AddToCircuitList called with NULL pointer!!!!!\n";
1617 //cout << "**********************************************\n";
1620 //cout << "ADD: " << circuitList.size();
1621 //cout << ident << " AddToCircuitList called for " << t->plane.callsign << ", currently size = " << circuitList.size() << endl;
1622 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.
1623 bool conflict = false;
1624 tower_plane_rec_list_iterator twrItr;
1625 // First check if the plane is already in the list
1626 //cout << "A" << endl;
1627 //cout << "Checking whether " << t->plane.callsign << " is already in circuit list..." << endl;
1628 //cout << "B" << endl;
1629 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
1630 if((*twrItr)->plane.callsign == t->plane.callsign) {
1631 //cout << "In list - returning...\n";
1635 //cout << "Not in list - adding..." << endl;
1637 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
1638 TowerPlaneRec* tpr = *twrItr;
1639 //cout << tpr->plane.callsign << " eta is " << tpr->eta << '\n';
1640 //cout << "New eta is " << t->eta << '\n';
1641 if(t->eta < tpr->eta) {
1642 // Ugg - this one's tricky.
1643 // It depends on what the two planes are doing and whether there's a conflict what we do.
1644 if(tpr->eta - t->eta > separation_time) { // No probs, plane 2 can squeeze in before plane 1 with no apparent conflict
1645 circuitList.insert(twrItr, t);
1646 } else { // Ooops - this ones tricky - we have a potential conflict!
1648 // HACK - just add anyway for now and flag conflict.
1649 circuitList.insert(twrItr, t);
1651 //cout << "\tC\t" << circuitList.size() << '\n';
1655 // If we get here we must be at the end of the list, or maybe the list is empty.
1656 //cout << ident << " adding " << t->plane.callsign << " to circuitList" << endl;
1657 circuitList.push_back(t); // TODO - check the separation with the preceding plane for the conflict flag.
1658 //cout << "\tE\t" << circuitList.size() << endl;
1662 // Add to vacated list only if not already present
1663 void FGTower::AddToVacatedList(TowerPlaneRec* t) {
1664 tower_plane_rec_list_iterator twrItr;
1666 for(twrItr = vacatedList.begin(); twrItr != vacatedList.end(); twrItr++) {
1667 if((*twrItr)->plane.callsign == t->plane.callsign) {
1672 vacatedList.push_back(t);
1676 // Calculate the eta of a plane to the threshold.
1677 // For ground traffic this is the fastest they can get there.
1678 // For air traffic this is the middle approximation.
1679 void FGTower::CalcETA(TowerPlaneRec* tpr, bool printout) {
1680 // For now we'll be very crude and hardwire expected speeds to C172-like values
1681 // The speeds below are specified in knots IAS and then converted to m/s
1682 double app_ias = 100.0 * 0.514444; // Speed during straight-in approach
1683 double circuit_ias = 80.0 * 0.514444; // Speed around circuit
1684 double final_ias = 70.0 * 0.514444; // Speed during final approach
1687 //cout << "In CalcETA, airplane ident = " << tpr->plane.callsign << '\n';
1688 //cout << (tpr->isUser ? "USER\n" : "AI\n");
1692 // Sign convention - dist_out is -ve for approaching planes and +ve for departing planes
1693 // dist_across is +ve in the pattern direction - ie a plane correctly on downwind will have a +ve dist_across
1695 Point3D op = ortho.ConvertToLocal(tpr->pos);
1697 //if(!tpr->isUser) cout << "Orthopos is " << op.x() << ", " << op.y() << ' ';
1698 //cout << "opType is " << tpr->opType << '\n';
1700 double dist_out_m = op.y();
1701 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
1702 //cout << "Doing ETA calc for " << tpr->plane.callsign << '\n';
1704 if(tpr->opType == STRAIGHT_IN || tpr->opType == INBOUND) {
1705 //cout << "CASE 1\n";
1706 double dist_to_go_m = sqrt((dist_out_m * dist_out_m) + (dist_across_m * dist_across_m));
1707 if(dist_to_go_m < 1000) {
1708 tpr->eta = dist_to_go_m / final_ias;
1710 tpr->eta = (1000.0 / final_ias) + ((dist_to_go_m - 1000.0) / app_ias);
1712 } else if(tpr->opType == CIRCUIT || tpr->opType == TTT_UNKNOWN) { // Hack alert - UNKNOWN has sort of been added here as a temporary hack.
1713 //cout << "CASE 2\n";
1714 // It's complicated - depends on if base leg is delayed or not
1716 //cout << "Leg = " << tpr->leg << '\n';
1718 if(tpr->leg == LANDING_ROLL) {
1720 } else if((tpr->leg == FINAL) || (tpr->leg == TURN4)) {
1721 //cout << "dist_out_m = " << dist_out_m << '\n';
1722 tpr->eta = fabs(dist_out_m) / final_ias;
1723 } else if((tpr->leg == BASE) || (tpr->leg == TURN3)) {
1724 tpr->eta = (fabs(dist_out_m) / final_ias) + (dist_across_m / circuit_ias);
1726 // Need to calculate where base leg is likely to be
1727 // FIXME - for now I'll hardwire it to 1000m which is what AILocalTraffic uses!!!
1728 // 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
1729 double nominal_base_dist_out_m = -1000;
1730 double current_base_dist_out_m;
1731 if(!GetBaseConstraint(current_base_dist_out_m)) {
1732 current_base_dist_out_m = nominal_base_dist_out_m;
1734 //cout << "current_base_dist_out_m = " << current_base_dist_out_m << '\n';
1735 double nominal_dist_across_m = 1000; // Hardwired value from AILocalTraffic
1736 double current_dist_across_m;
1737 if(!GetDownwindConstraint(current_dist_across_m)) {
1738 current_dist_across_m = nominal_dist_across_m;
1740 double nominal_cross_dist_out_m = 2000; // Bit of a guess - AI plane turns to crosswind at 700ft agl.
1741 tpr->eta = fabs(current_base_dist_out_m) / final_ias; // final
1742 //cout << "a = " << tpr->eta << '\n';
1743 if((tpr->leg == DOWNWIND) || (tpr->leg == TURN2)) {
1744 tpr->eta += dist_across_m / circuit_ias;
1745 //cout << "b = " << tpr->eta << '\n';
1746 tpr->eta += fabs(current_base_dist_out_m - dist_out_m) / circuit_ias;
1747 //cout << "c = " << tpr->eta << '\n';
1748 } else if((tpr->leg == CROSSWIND) || (tpr->leg == TURN1)) {
1749 //cout << "CROSSWIND calc: ";
1750 //cout << tpr->eta << ' ';
1751 if(dist_across_m > nominal_dist_across_m) {
1752 tpr->eta += dist_across_m / circuit_ias;
1755 tpr->eta += nominal_dist_across_m / circuit_ias;
1758 //cout << tpr->eta << ' ';
1759 // should we use the dist across of the previous plane if there is previous still on downwind?
1760 //if(printout) cout << "bb = " << tpr->eta << '\n';
1761 if(dist_out_m > nominal_cross_dist_out_m) {
1762 tpr->eta += fabs(current_base_dist_out_m - dist_out_m) / circuit_ias;
1765 tpr->eta += fabs(current_base_dist_out_m - nominal_cross_dist_out_m) / circuit_ias;
1768 //cout << tpr->eta << ' ';
1769 //if(printout) cout << "cc = " << tpr->eta << '\n';
1770 if(nominal_dist_across_m > dist_across_m) {
1771 tpr->eta += (nominal_dist_across_m - dist_across_m) / circuit_ias;
1777 //cout << tpr->eta << '\n';
1778 //if(printout) cout << "dd = " << tpr->eta << '\n';
1780 // We've only just started - why not use a generic estimate?
1785 // cout << "ETA = " << tpr->eta << '\n';
1787 //if(!tpr->isUser) cout << tpr->plane.callsign << '\t' << tpr->eta << '\n';
1794 // Calculate the distance of a plane to the threshold in meters
1795 // TODO - Modify to calculate flying distance of a plane in the circuit
1796 double FGTower::CalcDistOutM(TowerPlaneRec* tpr) {
1797 return(dclGetHorizontalSeparation(rwy.threshold_pos, tpr->pos));
1801 // Calculate the distance of a plane to the threshold in miles
1802 // TODO - Modify to calculate flying distance of a plane in the circuit
1803 double FGTower::CalcDistOutMiles(TowerPlaneRec* tpr) {
1804 return(CalcDistOutM(tpr) / 1600.0); // FIXME - use a proper constant if possible.
1808 // Iterate through all the lists, update the position of, and call CalcETA for all the planes.
1809 void FGTower::doThresholdETACalc() {
1810 //cout << "Entering doThresholdETACalc..." << endl;
1811 tower_plane_rec_list_iterator twrItr;
1812 // Do the approach list first
1813 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1814 TowerPlaneRec* tpr = *twrItr;
1815 if(!(tpr->isUser)) tpr->pos = tpr->planePtr->GetPos();
1819 // Then the circuit list
1820 //cout << "Circuit list size is " << circuitList.size() << '\n';
1821 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
1822 TowerPlaneRec* tpr = *twrItr;
1823 if(!(tpr->isUser)) tpr->pos = tpr->planePtr->GetPos();
1827 //cout << "Done doThresholdETCCalc" << endl;
1831 // Check that the planes in traffic list are correctly ordered,
1832 // that the nearest (timewise) is flagged next on rwy, and return
1833 // true if any threshold use conflicts are detected, false otherwise.
1834 bool FGTower::doThresholdUseOrder() {
1835 //cout << "Entering doThresholdUseOrder..." << endl;
1836 bool conflict = false;
1838 // Wipe out traffic list, go through circuit, app and hold list, and reorder them in traffic list.
1839 // Here's the rather simplistic assumptions we're using:
1840 // Currently all planes are assumed to be GA light singles with corresponding speeds and separation times.
1841 // In order of priority for runway use:
1842 // STRAIGHT_IN > CIRCUIT > HOLDING_FOR_DEPARTURE
1843 // No modification of planes speeds occurs - conflicts are resolved by delaying turn for base,
1844 // and holding planes until a space.
1845 // When calculating if a holding plane can use the runway, time clearance from last departure
1846 // as well as time clearance to next arrival must be considered.
1848 trafficList.clear();
1850 tower_plane_rec_list_iterator twrItr;
1851 // Do the approach list first
1852 //if(ident == "KRHV") cout << "A" << flush;
1853 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
1854 TowerPlaneRec* tpr = *twrItr;
1855 //if(ident == "KRHV") cout << tpr->plane.callsign << '\n';
1856 conflict = AddToTrafficList(tpr);
1858 // Then the circuit list
1859 //if(ident == "KRHV") cout << "C" << flush;
1860 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
1861 TowerPlaneRec* tpr = *twrItr;
1862 //if(ident == "KRHV") cout << tpr->plane.callsign << '\n';
1863 conflict = AddToTrafficList(tpr);
1865 // And finally the hold list
1866 //cout << "H" << endl;
1867 for(twrItr = holdList.begin(); twrItr != holdList.end(); twrItr++) {
1868 TowerPlaneRec* tpr = *twrItr;
1869 AddToTrafficList(tpr, true);
1874 //if(ident == "KRHV") {
1876 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
1877 TowerPlaneRec* tpr = *twrItr;
1878 cout << tpr->plane.callsign << '\t' << tpr->eta << '\t';
1883 //cout << "Done doThresholdUseOrder" << endl;
1888 // Return the ETA of plane no. list_pos (1-based) in the traffic list.
1889 // i.e. list_pos = 1 implies next to use runway.
1890 double FGTower::GetTrafficETA(unsigned int list_pos, bool printout) {
1891 if(trafficList.size() < list_pos) {
1895 tower_plane_rec_list_iterator twrItr;
1896 twrItr = trafficList.begin();
1897 for(unsigned int i = 1; i < list_pos; i++, twrItr++);
1898 TowerPlaneRec* tpr = *twrItr;
1899 CalcETA(tpr, printout);
1900 //cout << "ETA returned = " << tpr->eta << '\n';
1905 void FGTower::ContactAtHoldShort(const PlaneRec& plane, FGAIPlane* requestee, tower_traffic_type operation) {
1906 // HACK - assume that anything contacting at hold short is new for now - FIXME LATER
1907 TowerPlaneRec* t = new TowerPlaneRec;
1909 t->planePtr = requestee;
1910 t->holdShortReported = true;
1911 t->clearedToLineUp = false;
1912 t->clearedToTakeOff = false;
1913 t->opType = operation;
1914 t->pos = requestee->GetPos();
1916 //cout << "Hold Short reported by " << plane.callsign << '\n';
1917 SG_LOG(SG_ATC, SG_BULK, "Hold Short reported by " << plane.callsign);
1920 bool next = AddToTrafficList(t, true);
1922 double teta = GetTrafficETA(2);
1924 t->clearanceCounter = 7.0; // This reduces the delay before response to 3 secs if an immediate takeoff is reqd
1925 //cout << "Reducing response time to request due imminent traffic\n";
1930 // TODO - possibly add the reduced interval to clearance when immediate back in under the new scheme
1932 holdList.push_back(t);
1934 responseReqd = true;
1937 // Register the presence of an AI plane at a point where contact would already have been made in real life
1938 // CAUTION - currently it is assumed that this plane's callsign is unique - it is up to AIMgr to generate unique callsigns.
1939 void FGTower::RegisterAIPlane(const PlaneRec& plane, FGAIPlane* ai, const tower_traffic_type& op, const PatternLeg& lg) {
1940 // At the moment this is only going to be tested with inserting an AI plane on downwind
1941 TowerPlaneRec* t = new TowerPlaneRec;
1946 t->pos = ai->GetPos();
1950 if(op == CIRCUIT && lg != LEG_UNKNOWN) {
1951 AddToCircuitList(t);
1956 doThresholdUseOrder();
1959 void FGTower::DeregisterAIPlane(const string& id) {
1963 // Contact tower for VFR approach
1964 // eg "Cessna Charlie Foxtrot Golf Foxtrot Sierra eight miles South of the airport for full stop with Bravo"
1965 // This function probably only called via user interaction - AI planes will have an overloaded function taking a planerec.
1966 // opt defaults to AIP_LT_UNKNOWN
1967 void FGTower::VFRArrivalContact(const string& ID, const LandingType& opt) {
1968 //cout << "USER Request Landing Clearance called for ID " << ID << '\n';
1970 // For now we'll assume that the user is a light plane and can get him/her to join the circuit if necessary.
1973 string usercall = fgGetString("/sim/user/callsign");
1974 if(ID == "USER" || ID == usercall) {
1975 t = FindPlane(usercall);
1977 //cout << "NOT t\n";
1978 t = new TowerPlaneRec;
1980 t->pos.setlon(user_lon_node->getDoubleValue());
1981 t->pos.setlat(user_lat_node->getDoubleValue());
1982 t->pos.setelev(user_elev_node->getDoubleValue());
1985 // Oops - the plane is already registered with this tower - maybe we took off and flew a giant circuit without
1986 // quite getting out of tower airspace - just ignore for now and treat as new arrival.
1987 // TODO - Maybe should remove from departure and circuit list if in there though!!
1990 // Oops - something has gone wrong - put out a warning
1991 cout << "WARNING - FGTower::VFRContact(string ID, LandingType lt) called with ID " << ID << " which does not appear to be the user.\n";
1997 // Calculate where the plane is in relation to the active runway and it's circuit
1998 // and set the op-type as appropriate.
2000 // HACK - to get up and running I'm going to assume that the user contacts tower on a staight-in final for now.
2001 t->opType = STRAIGHT_IN;
2003 t->plane.type = GA_SINGLE; // FIXME - Another assumption!
2004 t->plane.callsign = usercall;
2006 t->vfrArrivalReported = true;
2007 responseReqd = true;
2009 appList.push_back(t); // Not necessarily permanent
2010 AddToTrafficList(t);
2012 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL, TOWER);
2013 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL_FULL_STOP, TOWER);
2014 current_atcdialog->remove_entry(ident, USER_REQUEST_VFR_ARRIVAL_TOUCH_AND_GO, TOWER);
2017 // landingType defaults to AIP_LT_UNKNOWN
2018 void FGTower::VFRArrivalContact(const PlaneRec& plane, FGAIPlane* requestee, const LandingType& lt) {
2019 //cout << "VFRArrivalContact called for plane " << plane.callsign << " at " << ident << '\n';
2020 // Possible hack - assume this plane is new for now - TODO - should check really
2021 TowerPlaneRec* t = new TowerPlaneRec;
2023 t->planePtr = requestee;
2024 t->landingType = lt;
2025 t->pos = requestee->GetPos();
2027 //cout << "Hold Short reported by " << plane.callsign << '\n';
2028 SG_LOG(SG_ATC, SG_BULK, "VFR arrival contact made by " << plane.callsign);
2029 //cout << "VFR arrival contact made by " << plane.callsign << '\n';
2031 // HACK - to get up and running I'm going to assume a staight-in final for now.
2032 t->opType = STRAIGHT_IN;
2034 t->vfrArrivalReported = true;
2035 responseReqd = true;
2037 //cout << "Before adding, appList.size = " << appList.size() << " at " << ident << '\n';
2038 appList.push_back(t); // Not necessarily permanent
2039 //cout << "After adding, appList.size = " << appList.size() << " at " << ident << '\n';
2040 AddToTrafficList(t);
2043 void FGTower::RequestDepartureClearance(const string& ID) {
2044 //cout << "Request Departure Clearance called...\n";
2047 void FGTower::ReportFinal(const string& ID) {
2048 //cout << "Report Final Called at tower " << ident << " by plane " << ID << '\n';
2051 uid = fgGetString("/sim/user/callsign");
2052 current_atcdialog->remove_entry(ident, USER_REPORT_3_MILE_FINAL, TOWER);
2054 TowerPlaneRec* t = FindPlane(uid);
2056 t->finalReported = true;
2057 t->finalAcknowledged = false;
2058 if(!(t->clearedToLand)) {
2059 responseReqd = true;
2061 // possibly respond with wind even if already cleared to land?
2062 t->finalReported = false;
2063 t->finalAcknowledged = true;
2064 // HACK!! - prevents next reporting being misinterpreted as this one.
2067 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportFinal(...)");
2071 void FGTower::ReportLongFinal(const string& ID) {
2074 uid = fgGetString("/sim/user/callsign");
2075 current_atcdialog->remove_entry(ident, USER_REPORT_3_MILE_FINAL, TOWER);
2077 TowerPlaneRec* t = FindPlane(uid);
2079 t->longFinalReported = true;
2080 t->longFinalAcknowledged = false;
2081 if(!(t->clearedToLand)) {
2082 responseReqd = true;
2083 } // possibly respond with wind even if already cleared to land?
2085 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportLongFinal(...)");
2089 //void FGTower::ReportOuterMarker(string ID);
2090 //void FGTower::ReportMiddleMarker(string ID);
2091 //void FGTower::ReportInnerMarker(string ID);
2093 void FGTower::ReportRunwayVacated(const string& ID) {
2094 //cout << "Report Runway Vacated Called at tower " << ident << " by plane " << ID << '\n';
2097 uid = fgGetString("/sim/user/callsign");
2098 current_atcdialog->remove_entry(ident, USER_REPORT_RWY_VACATED, TOWER);
2100 TowerPlaneRec* t = FindPlane(uid);
2102 //cout << "Found it...\n";
2103 t->rwyVacatedReported = true;
2104 responseReqd = true;
2106 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportRunwayVacated(...)");
2107 SG_LOG(SG_ATC, SG_ALERT, "A WARNING: Unable to find plane " << ID << " in FGTower::ReportRunwayVacated(...)");
2108 //cout << "WARNING: Unable to find plane " << ID << " in FGTower::ReportRunwayVacated(...)\n";
2112 TowerPlaneRec* FGTower::FindPlane(const string& ID) {
2113 //cout << "FindPlane called for " << ID << "...\n";
2114 tower_plane_rec_list_iterator twrItr;
2115 // Do the approach list first
2116 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
2117 //cout << "appList callsign is " << (*twrItr)->plane.callsign << '\n';
2118 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2120 // Then the circuit list
2121 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
2122 //cout << "circuitList callsign is " << (*twrItr)->plane.callsign << '\n';
2123 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2125 // Then the runway list
2126 //cout << "rwyList.size() is " << rwyList.size() << '\n';
2127 for(twrItr = rwyList.begin(); twrItr != rwyList.end(); twrItr++) {
2128 //cout << "rwyList callsign is " << (*twrItr)->plane.callsign << '\n';
2129 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2132 for(twrItr = holdList.begin(); twrItr != holdList.end(); twrItr++) {
2133 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2135 // And finally the vacated list
2136 for(twrItr = vacatedList.begin(); twrItr != vacatedList.end(); twrItr++) {
2137 //cout << "vacatedList callsign is " << (*twrItr)->plane.callsign << '\n';
2138 if((*twrItr)->plane.callsign == ID) return(*twrItr);
2140 SG_LOG(SG_ATC, SG_WARN, "Unable to find " << ID << " in FGTower::FindPlane(...)");
2145 void FGTower::RemovePlane(const string& ID) {
2146 //cout << ident << " RemovePlane called for " << ID << '\n';
2147 // We have to be careful here - we want to erase the plane from all lists it is in,
2148 // but we can only delete it once, AT THE END.
2149 TowerPlaneRec* t = NULL;
2150 tower_plane_rec_list_iterator twrItr;
2151 for(twrItr = appList.begin(); twrItr != appList.end(); twrItr++) {
2152 if((*twrItr)->plane.callsign == ID) {
2154 twrItr = appList.erase(twrItr);
2155 appListItr = appList.begin();
2159 for(twrItr = depList.begin(); twrItr != depList.end(); twrItr++) {
2160 if((*twrItr)->plane.callsign == ID) {
2162 twrItr = depList.erase(twrItr);
2163 depListItr = depList.begin();
2167 for(twrItr = circuitList.begin(); twrItr != circuitList.end(); twrItr++) {
2168 if((*twrItr)->plane.callsign == ID) {
2170 twrItr = circuitList.erase(twrItr);
2171 circuitListItr = circuitList.begin();
2175 for(twrItr = holdList.begin(); twrItr != holdList.end(); twrItr++) {
2176 if((*twrItr)->plane.callsign == ID) {
2178 twrItr = holdList.erase(twrItr);
2179 holdListItr = holdList.begin();
2183 for(twrItr = rwyList.begin(); twrItr != rwyList.end(); twrItr++) {
2184 if((*twrItr)->plane.callsign == ID) {
2186 twrItr = rwyList.erase(twrItr);
2187 rwyListItr = rwyList.begin();
2191 for(twrItr = vacatedList.begin(); twrItr != vacatedList.end(); twrItr++) {
2192 if((*twrItr)->plane.callsign == ID) {
2194 twrItr = vacatedList.erase(twrItr);
2195 vacatedListItr = vacatedList.begin();
2199 for(twrItr = trafficList.begin(); twrItr != trafficList.end(); twrItr++) {
2200 if((*twrItr)->plane.callsign == ID) {
2202 twrItr = trafficList.erase(twrItr);
2203 trafficListItr = trafficList.begin();
2207 // And finally, delete the record.
2211 void FGTower::ReportDownwind(const string& ID) {
2212 //cout << "ReportDownwind(...) called\n";
2215 uid = fgGetString("/sim/user/callsign");
2216 current_atcdialog->remove_entry(ident, USER_REPORT_DOWNWIND, TOWER);
2218 TowerPlaneRec* t = FindPlane(uid);
2220 t->downwindReported = true;
2221 responseReqd = true;
2222 // If the plane is in the app list, remove it and put it in the circuit list instead.
2223 // Ideally we might want to do this at the 2 mile report prior to 45 deg entry, but at
2224 // the moment that would b&gg?r up the constraint position calculations.
2225 RemoveFromAppList(ID);
2228 t->pos.setlon(user_lon_node->getDoubleValue());
2229 t->pos.setlat(user_lat_node->getDoubleValue());
2230 t->pos.setelev(user_elev_node->getDoubleValue());
2232 // ASSERT(t->planePtr != NULL);
2233 t->pos = t->planePtr->GetPos();
2236 AddToCircuitList(t);
2238 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportDownwind(...)");
2242 void FGTower::ReportGoingAround(const string& ID) {
2245 uid = fgGetString("/sim/user/callsign");
2246 RemoveAllUserDialogOptions(); // TODO - it would be much more efficient if ATCDialog simply had a clear() function!!!
2247 current_atcdialog->add_entry(ident, "@AP Tower @CS Downwind @RW", "Report Downwind", TOWER, (int)USER_REPORT_DOWNWIND);
2249 TowerPlaneRec* t = FindPlane(uid);
2251 //t->goAroundReported = true; // No need to set this until we start responding to it.
2252 responseReqd = false; // might change in the future but for now we'll not distract them during the go-around.
2253 // If the plane is in the app list, remove it and put it in the circuit list instead.
2254 RemoveFromAppList(ID);
2257 t->pos.setlon(user_lon_node->getDoubleValue());
2258 t->pos.setlat(user_lat_node->getDoubleValue());
2259 t->pos.setelev(user_elev_node->getDoubleValue());
2261 // ASSERT(t->planePtr != NULL);
2262 t->pos = t->planePtr->GetPos();
2265 AddToCircuitList(t);
2267 SG_LOG(SG_ATC, SG_WARN, "WARNING: Unable to find plane " << ID << " in FGTower::ReportDownwind(...)");
2271 string FGTower::GenText(const string& m, int c) {
2272 const int cmax = 300;
2282 string usercall = fgGetString("/sim/user/callsign");
2284 //transmission_list_type tmissions = transmissionlist_station[station];
2285 //transmission_list_iterator current = tmissions.begin();
2286 //transmission_list_iterator last = tmissions.end();
2288 //for ( ; current != last ; ++current ) {
2289 // if ( current->get_code().c1 == code.c1 &&
2290 // current->get_code().c2 == code.c2 &&
2291 // current->get_code().c3 == code.c3 ) {
2293 //if ( ttext ) message = current->get_transtext();
2294 //else message = current->get_menutext();
2295 strcpy( &mes[0], m.c_str() );
2297 // Replace all the '@' parameters with the actual text.
2298 int check = 0; // If mes gets overflowed the while loop can go infinite
2299 while ( strchr(&mes[0], crej) != NULL ) { // ie. loop until no more occurances of crej ('@') found
2300 pos = strchr( &mes[0], crej );
2301 memmove(&tag[0], pos, 3);
2305 for ( i=0; i<cmax; i++ ) {
2306 if ( mes[i] == crej ) {
2311 strncpy( &dum[0], &mes[0], len );
2314 if ( strcmp ( tag, "@ST" ) == 0 )
2315 //strcat( &dum[0], tpars.station.c_str() );
2316 strcat(&dum[0], ident.c_str());
2317 else if ( strcmp ( tag, "@AP" ) == 0 )
2318 //strcat( &dum[0], tpars.airport.c_str() );
2319 strcat(&dum[0], name.c_str());
2320 else if ( strcmp ( tag, "@CS" ) == 0 )
2321 //strcat( &dum[0], tpars.callsign.c_str() );
2322 strcat(&dum[0], usercall.c_str());
2323 else if ( strcmp ( tag, "@TD" ) == 0 ) {
2325 if ( tpars.tdir == 1 ) {
2326 char buf[] = "left";
2327 strcat( &dum[0], &buf[0] );
2330 char buf[] = "right";
2331 strcat( &dum[0], &buf[0] );
2335 else if ( strcmp ( tag, "@HE" ) == 0 ) {
2338 sprintf( buf, "%i", (int)(tpars.heading) );
2339 strcat( &dum[0], &buf[0] );
2342 else if ( strcmp ( tag, "@VD" ) == 0 ) {
2344 if ( tpars.VDir == 1 ) {
2345 char buf[] = "Descend and maintain";
2346 strcat( &dum[0], &buf[0] );
2348 else if ( tpars.VDir == 2 ) {
2349 char buf[] = "Maintain";
2350 strcat( &dum[0], &buf[0] );
2352 else if ( tpars.VDir == 3 ) {
2353 char buf[] = "Climb and maintain";
2354 strcat( &dum[0], &buf[0] );
2358 else if ( strcmp ( tag, "@AL" ) == 0 ) {
2361 sprintf( buf, "%i", (int)(tpars.alt) );
2362 strcat( &dum[0], &buf[0] );
2365 else if ( strcmp ( tag, "@MI" ) == 0 ) {
2367 //sprintf( buf, "%3.1f", tpars.miles );
2368 int dist_miles = (int)dclGetHorizontalSeparation(Point3D(lon, lat, elev), Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), user_elev_node->getDoubleValue())) / 1600;
2369 sprintf(buf, "%i", dist_miles);
2370 strcat( &dum[0], &buf[0] );
2372 else if ( strcmp ( tag, "@FR" ) == 0 ) {
2375 sprintf( buf, "%6.2f", tpars.freq );
2376 strcat( &dum[0], &buf[0] );
2379 else if ( strcmp ( tag, "@RW" ) == 0 ) {
2380 strcat(&dum[0], ConvertRwyNumToSpokenString(activeRwy).c_str());
2381 } else if(strcmp(tag, "@CD") == 0) { // @CD = compass direction
2382 double h = GetHeadingFromTo(Point3D(lon, lat, elev), Point3D(user_lon_node->getDoubleValue(), user_lat_node->getDoubleValue(), user_elev_node->getDoubleValue()));
2383 while(h < 0.0) h += 360.0;
2384 while(h > 360.0) h -= 360.0;
2385 if(h < 22.5 || h > 337.5) {
2386 strcat(&dum[0], "North");
2387 } else if(h < 67.5) {
2388 strcat(&dum[0], "North-East");
2389 } else if(h < 112.5) {
2390 strcat(&dum[0], "East");
2391 } else if(h < 157.5) {
2392 strcat(&dum[0], "South-East");
2393 } else if(h < 202.5) {
2394 strcat(&dum[0], "South");
2395 } else if(h < 247.5) {
2396 strcat(&dum[0], "South-West");
2397 } else if(h < 292.5) {
2398 strcat(&dum[0], "West");
2400 strcat(&dum[0], "North-West");
2403 cout << "Tag " << tag << " not found" << endl;
2406 strcat( &dum[0], &mes[len+3] );
2407 strcpy( &mes[0], &dum[0] );
2411 SG_LOG(SG_ATC, SG_WARN, "WARNING: Possibly endless loop terminated in FGTransmissionlist::gen_text(...)");
2416 //cout << mes << endl;
2420 if ( mes != "" ) return mes;
2421 else return "No transmission found";
2424 ostream& operator << (ostream& os, tower_traffic_type ttt) {
2426 case(CIRCUIT): return(os << "CIRCUIT");
2427 case(INBOUND): return(os << "INBOUND");
2428 case(OUTBOUND): return(os << "OUTBOUND");
2429 case(TTT_UNKNOWN): return(os << "UNKNOWN");
2430 case(STRAIGHT_IN): return(os << "STRAIGHT_IN");
2432 return(os << "ERROR - Unknown switch in tower_traffic_type operator << ");