#include <simgear/compiler.h>
#include <simgear/math/point3d.hxx>
#include <simgear/misc/sgstream.hxx>
-#include <simgear/math/sg_geodesy.hxx>
+//#include <simgear/math/sg_geodesy.hxx>
#include <plib/sg.h>
+//#include <Airports/runways.hxx>
#include STL_IOSTREAM
#include STL_STRING
#include "ATC.hxx"
//#include "ATCmgr.hxx"
#include "ground.hxx"
+#include "ATCProjection.hxx"
+#include "AIPlane.hxx"
//DCL - a complete guess for now.
#define FG_TOWER_DEFAULT_RANGE 30
+enum tower_traffic_type {
+ CIRCUIT,
+ INBOUND,
+ OUTBOUND,
+ TTT_UNKNOWN, // departure, but we don't know if for circuits or leaving properly
+ STRAIGHT_IN
+ // Umm - what's the difference between INBOUND and STRAIGHT_IN ?
+}; // TODO - need some differentiation of IFR and VFR traffic in order to give the former priority.
+
// Structure for holding details of a plane under tower control.
// Not fixed yet - may include more stuff later.
class TowerPlaneRec {
- public:
+public:
TowerPlaneRec();
- TowerPlaneRec(string ID);
+ TowerPlaneRec(PlaneRec p);
TowerPlaneRec(Point3D pt);
- TowerPlaneRec(string ID, Point3D pt);
+ TowerPlaneRec(PlaneRec p, Point3D pt);
+
+ FGAIPlane* planePtr; // This might move to the planeRec eventually
+ PlaneRec plane;
- string id;
Point3D pos;
- double eta; // minutes
- double dist_out; // miles from theshold
+ double eta; // seconds
+ double dist_out; // meters from theshold
bool clearedToLand;
- bool clearedToDepart;
+ bool clearedToLineUp;
+ bool clearedToTakeOff;
// ought to add time cleared to depart so we can nag if necessary
+ bool holdShortReported;
bool longFinalReported;
bool longFinalAcknowledged;
bool finalReported;
bool finalAcknowledged;
- bool onRwy;
- // enum type - light, medium, heavy etc - we need someway of approximating the aircraft type and performance.
+ bool onRwy; // is physically on the runway
+ bool nextOnRwy; // currently projected by tower to be the next on the runway
+
+ double clearanceCounter; // Hack for communication timing - counter since clearance requested in seconds
+
+ // Type of operation the plane is doing
+ tower_traffic_type opType;
+
+ // Whereabouts in circuit if doing circuits
+ PatternLeg leg;
+
+ bool isUser; // true if this plane is the user
};
+
typedef list < TowerPlaneRec* > tower_plane_rec_list_type;
-typedef list < TowerPlaneRec* >::iterator tower_plane_rec_list_iterator;
-typedef list < TowerPlaneRec* >::const_iterator tower_plane_rec_list_const_iterator;
+typedef tower_plane_rec_list_type::iterator tower_plane_rec_list_iterator;
+typedef tower_plane_rec_list_type::const_iterator tower_plane_rec_list_const_iterator;
class FGTower : public FGATC {
- public:
+public:
FGTower();
~FGTower();
void Init();
- void Update();
+ void Update(double dt);
void RequestLandingClearance(string ID);
void RequestDepartureClearance(string ID);
void ReportInnerMarker(string ID);
void ReportGoingAround(string ID);
void ReportRunwayVacated(string ID);
+ void ReportReadyForDeparture(string ID);
+
+ // Contact tower when at a hold short for departure - for now we'll assume plane - maybe vehicles might want to cross runway eventually?
+ void ContactAtHoldShort(PlaneRec plane, FGAIPlane* requestee, tower_traffic_type operation);
+
+ // Public interface to the active runway - this will get more complex
+ // in the future and consider multi-runway use, airplane weight etc.
+ inline string GetActiveRunway() { return activeRwy; }
+ inline RunwayDetails GetActiveRunwayDetails() { return rwy; }
+
+ inline void SetDisplay() { display = true; }
+ inline void SetNoDisplay() { display = false; }
- // Parse a literal message to decide which of above it represents.
- // (a long term project that eventually will hopefully receive the output from voice recognition software.)
- void LiteralTransmission(string trns, string ID);
-
- inline void SetDisplay() {display = true;}
- inline void SetNoDisplay() {display = false;}
-
- inline char get_type() const { return type; }
- inline double get_lon() const { return lon; }
- inline double get_lat() const { return lat; }
- inline double get_elev() const { return elev; }
- inline double get_x() const { return x; }
- inline double get_y() const { return y; }
- inline double get_z() const { return z; }
- inline int get_freq() const { return freq; }
- inline int get_range() const { return range; }
- inline const char* GetIdent() { return ident.c_str(); }
inline string get_trans_ident() { return trans_ident; }
- inline string get_name() { return name; }
inline atc_type GetType() { return TOWER; }
- // Make a request of tower control
- //void Request(tower_request request);
+ inline FGGround* GetGroundPtr() { return ground; }
+
+ // Returns true if positions of crosswind/downwind/base leg turns should be constrained by previous traffic
+ // plus the constraint position as a rwy orientated orthopos (meters)
+ bool GetCrosswindConstraint(double& cpos);
+ bool GetDownwindConstraint(double& dpos);
+ bool GetBaseConstraint(double& bpos);
+
+ // Returns true if OK to transmit on this frequency
+ inline bool FreqClear() { return freqClear; }
+ // Indicate that the frequency is in use
+ inline void FreqInUse() { freqClear = false; }
+ // The idea is that AI traffic or the user ATC dialog box calls FreqInUse() when they begin transmitting,
+ // and that the tower control sets freqClear back to true following a reply.
+ // AI traffic should check FreqClear() is true prior to transmitting.
+ // The user will just have to wait for a gap in dialog as in real life.
+
+private:
+ FGATCMgr* ATCmgr;
+ // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
+
+ // Figure out if a given position lies on the active runway
+ // Might have to change when we consider more than one active rwy.
+ bool OnActiveRunway(Point3D pt);
+
+ // Figure out if a given position lies on a runway or not
+ bool OnAnyRunway(Point3D pt);
+
+ // Calculate the eta of a plane to the threshold.
+ // For ground traffic this is the fastest they can get there.
+ // For air traffic this is the middle approximation.
+ void CalcETA(TowerPlaneRec* tpr);
+
+ // Iterate through all the lists and call CalcETA for all the planes.
+ void doThresholdETACalc();
+
+ // Order the list of traffic as per expected threshold use and flag any conflicts
+ bool doThresholdUseOrder();
- private:
+ // Calculate the crow-flys distance of a plane to the threshold in meters
+ double CalcDistOutM(TowerPlaneRec* tpr);
+
+ // Calculate the crow-flys distance of a plane to the threshold in miles
+ double CalcDistOutMiles(TowerPlaneRec* tpr);
+
+ void doCommunication();
void IssueLandingClearance(TowerPlaneRec* tpr);
void IssueGoAround(TowerPlaneRec* tpr);
void IssueDepartureClearance(TowerPlaneRec* tpr);
- char type;
- double lon, lat;
- double elev;
- double x, y, z;
- int freq;
- int range;
bool display; // Flag to indicate whether we should be outputting to the ATC display.
bool displaying; // Flag to indicate whether we are outputting to the ATC display.
- string ident; // Code of the airport its at.
- string name; // Name generally used in transmissions.
-
+
+ bool freqClear; // Flag to indicate if the frequency is clear of ongoing dialog
+
+ // environment - need to make sure we're getting the surface winds and not winds aloft.
+ SGPropertyNode* wind_from_hdg; //degrees
+ SGPropertyNode* wind_speed_knots; //knots
+
+ double aptElev; // Airport elevation
+ string activeRwy; // Active runway number - For now we'll disregard multiple / alternate runway operation.
+ RunwayDetails rwy; // Assumed to be the active one for now.
+ bool rwyOccupied; // Active runway occupied flag. For now we'll disregard land-and-hold-short operations.
+ FGATCAlignedProjection ortho; // Orthogonal mapping of the local area with the active runway threshold at the origin
+
+ // Figure out which runways are active.
+ // For now we'll just be simple and do one active runway - eventually this will get much more complex
+ // This is a private function - public interface to the results of this is through GetActiveRunway
+ void DoRwyDetails();
// Need a data structure to hold details of the various active planes
// or possibly another data structure with the positions of the inactive planes.
// Need a data structure to hold outstanding communications from aircraft.
- // Linked-list of planes on approach ordered with nearest first (timewise).
+ // Linked-list of planes on approach to active rwy ordered with nearest first (timewise).
// Includes planes that have landed but not yet vacated runway.
// Somewhat analagous to the paper strips used (used to be used?) in real life.
+ // Doesn't include planes in circuit until they turn onto base/final?
+ // TODO - may need to alter this for operation to more than one active rwy.
tower_plane_rec_list_type appList;
+ tower_plane_rec_list_iterator appListItr;
+
+ // What should we do with planes approaching the airport to join the circuit somewhere
+ // but not on straight-in though? - put them in here for now.
+ tower_plane_rec_list_type circuitAppList;
+ tower_plane_rec_list_iterator circuitAppListItr;
- // List of departed planes
+ // List of departed planes (planes doing circuits go into circuitList not depList after departure)
tower_plane_rec_list_type depList;
+ tower_plane_rec_list_iterator depListItr;
+
+ // List of planes in the circuit (ordered by nearest to landing first)
+ tower_plane_rec_list_type circuitList;
+ tower_plane_rec_list_iterator circuitListItr;
// List of planes waiting to depart
tower_plane_rec_list_type holdList;
-
+ tower_plane_rec_list_iterator holdListItr;
+
// List of planes on rwy
tower_plane_rec_list_type rwyList;
+ tower_plane_rec_list_iterator rwyListItr;
+
+ // List of all planes due to use a given rwy arranged in projected order of rwy use
+ tower_plane_rec_list_type trafficList; // TODO - needs to be expandable to more than one rwy
+ tower_plane_rec_list_iterator trafficListItr;
+
+ // Returns true if successful
+ bool RemoveFromTrafficList(string id);
+
+ // Return the ETA of plane no. list_pos (1-based) in the traffic list.
+ // i.e. list_pos = 1 implies next to use runway.
+ double GetTrafficETA(unsigned int list_pos);
+
+ // Add a tower plane rec with ETA to the traffic list in the correct position ETA-wise.
+ // Returns true if this could cause a threshold ETA conflict with other traffic, false otherwise.
+ bool AddToTrafficList(TowerPlaneRec* t, bool holding = false);
// Ground can be separate or handled by tower in real life.
// In the program we will always use a separate FGGround class, but we need to know
// whether it is supposed to be separate or not to give the correct instructions.
bool separateGround; // true if ground control is separate
- FGGround* groundPtr; // The ground control associated with this airport.
-
+ FGGround* ground; // The ground control associated with this airport.
// for failure modeling
string trans_ident; // transmitted ident
bool tower_failed; // tower failed?
- friend istream& operator>> ( istream&, FGTower& );
-};
-
-
-inline istream&
-operator >> ( istream& in, FGTower& t )
-{
- double f;
- char ch;
-
- in >> t.type;
-
- if ( t.type == '[' )
- return in >> skipeol;
-
- in >> t.lat >> t.lon >> t.elev >> f >> t.range
- >> t.ident;
-
- t.name = "";
- in >> ch;
- t.name += ch;
- while(1) {
- //in >> noskipws
- in.unsetf(ios::skipws);
- in >> ch;
- t.name += ch;
- if((ch == '"') || (ch == 0x0A)) {
- break;
- } // we shouldn't need the 0x0A but it makes a nice safely in case someone leaves off the "
- }
- in.setf(ios::skipws);
- //cout << "tower.name = " << t.name << '\n';
-
- t.freq = (int)(f*100.0 + 0.5);
+ // Pointers to current users position and orientation
+ SGPropertyNode* user_lon_node;
+ SGPropertyNode* user_lat_node;
+ SGPropertyNode* user_elev_node;
+ SGPropertyNode* user_hdg_node;
- // cout << t.ident << endl;
+ // Details of the general traffic flow etc in the circuit
+ double crosswind_leg_pos; // Distance from threshold crosswind leg is being turned to in meters (actual operation - *not* ideal circuit)
+ double downwind_leg_pos; // Actual offset distance in meters from the runway that planes are flying the downwind leg
+ // Currently not sure whether the above should be always +ve or just take the natural orthopos sign (+ve for RH circuit, -ve for LH).
+ double base_leg_pos; // Actual offset distance from the threshold (-ve) that planes are turning to base leg.
- // generate cartesian coordinates
- Point3D geod( t.lon * SGD_DEGREES_TO_RADIANS, t.lat * SGD_DEGREES_TO_RADIANS, t.elev );
- Point3D cart = sgGeodToCart( geod );
- t.x = cart.x();
- t.y = cart.y();
- t.z = cart.z();
-
- t.trans_ident = t.ident;
- t.tower_failed = false;
-
- return in >> skipeol;
-}
-
+ friend istream& operator>> ( istream&, FGTower& );
+};
#endif //_FG_TOWER_HXX