]> git.mxchange.org Git - flightgear.git/blobdiff - src/ATC/tower.hxx
Mathias Fröhlich:
[flightgear.git] / src / ATC / tower.hxx
index 13a0b6833af3dde33233101364fafd4e99e590aa..aaaf5387b8ace7e2c6454a15d1cfbb4ed429b28a 100644 (file)
@@ -45,13 +45,27 @@ SG_USING_STD(ios);
 
 enum tower_traffic_type {
        CIRCUIT,
-       INBOUND,
+       INBOUND,        // CIRCUIT traffic gets changed to INBOUND when on final of the full-stop circuit.
        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 ?
 };
 
+ostream& operator << (ostream& os, tower_traffic_type ttt);
+
+enum tower_callback_type {
+       USER_REQUEST_VFR_DEPARTURE = 1,
+       USER_REQUEST_VFR_ARRIVAL = 2,
+       USER_REQUEST_VFR_ARRIVAL_FULL_STOP = 3,
+       USER_REQUEST_VFR_ARRIVAL_TOUCH_AND_GO = 4,
+       USER_REPORT_3_MILE_FINAL = 5,
+       USER_REPORT_DOWNWIND = 6,
+       USER_REPORT_RWY_VACATED = 7,
+       USER_REPORT_GOING_AROUND = 8
+};
+
+// 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 {
@@ -74,21 +88,29 @@ public:
        bool clearedToTakeOff;
        // ought to add time cleared to depart so we can nag if necessary
        bool holdShortReported;
+       bool downwindReported;
        bool longFinalReported;
        bool longFinalAcknowledged;
        bool finalReported;
        bool finalAcknowledged;
+       bool rwyVacatedReported;
+       bool rwyVacatedAcknowledged;
+       bool goAroundReported;          // set true if plane informs tower that it's going around.
+       bool instructedToGoAround;      // set true if plane told by tower to go around.
        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 
        
+       bool vfrArrivalReported;
+       bool vfrArrivalAcknowledged;
+
        // Type of operation the plane is doing
        tower_traffic_type opType;
        
        // Whereabouts in circuit if doing circuits
        PatternLeg leg;
        
+       LandingType landingType;
+       
        bool isUser;    // true if this plane is the user
 };
 
@@ -108,38 +130,86 @@ public:
        void Init();
        
        void Update(double dt);
+       
+       void ReceiveUserCallback(int code);
 
-       void RequestLandingClearance(string ID);
+       // Contact tower for VFR approach
+       // eg "Cessna Charlie Foxtrot Golf Foxtrot Sierra eight miles South of the airport for full stop with Bravo"
+       // This function probably only called via user interaction - AI planes will have an overloaded function taking a planerec.
+       void VFRArrivalContact(string ID, LandingType opt = AIP_LT_UNKNOWN);
+       // For the AI planes...
+       void VFRArrivalContact(PlaneRec plane, FGAIPlane* requestee, LandingType lt = AIP_LT_UNKNOWN);
+       
        void RequestDepartureClearance(string ID);      
        void ReportFinal(string ID);
        void ReportLongFinal(string ID);
        void ReportOuterMarker(string ID);
        void ReportMiddleMarker(string ID);
        void ReportInnerMarker(string ID);
-       void ReportGoingAround(string ID);
        void ReportRunwayVacated(string ID);
        void ReportReadyForDeparture(string ID);
+       void ReportDownwind(string ID);
+       void ReportGoingAround(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);
        
+       // Register the presence of an AI plane at a point where contact would already have been made in real life
+       // CAUTION - currently it is assumed that this plane's callsign is unique - it is up to AIMgr to generate unique callsigns.
+       void RegisterAIPlane(PlaneRec plane, FGAIPlane* ai, tower_traffic_type op, PatternLeg lg = LEG_UNKNOWN);
+       
+       // Deregister and remove an AI plane.
+       void DeregisterAIPlane(string id);
+       
        // 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; }
+       // Get the pattern direction of the active rwy.
+       inline int GetPatternDirection() { return rwy.patternDirection; }
        
        inline string get_trans_ident() { return trans_ident; }
-       inline atc_type GetType() { return TOWER; }
        
        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);
+       
+       string GenText(const string& m, int c);
 
 private:
        FGATCMgr* ATCmgr;       
        // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
-
+       
+       // Respond to a transmission
+       void Respond();
+       
+       void ProcessRunwayVacatedReport(TowerPlaneRec* t);
+       void ProcessDownwindReport(TowerPlaneRec* t);
+       
+       // Remove all options from the user dialog choice
+       void RemoveAllUserDialogOptions();
+       
+       // Periodic checks on the various traffic.
+       void CheckHoldList(double dt);
+       void CheckCircuitList(double dt);
+       void CheckRunwayList(double dt);
+       void CheckApproachList(double dt);
+       void CheckDepartureList(double dt);
+       
+       // Currently this assumes we *are* next on the runway and doesn't check for planes about to land - 
+       // this should be done prior to calling this function.
+       void ClearHoldingPlane(TowerPlaneRec* t);
+       
+       // Find a pointer to plane of callsign ID within the internal data structures
+       TowerPlaneRec* FindPlane(string ID);
+       
+       // Remove and delete all instances of a plane with a given ID
+       void RemovePlane(string ID);
+       
        // 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);
@@ -147,22 +217,36 @@ private:
        // Figure out if a given position lies on a runway or not
        bool OnAnyRunway(Point3D pt);
        
-       // Calculate the eta of each plane to the threshold.
+       // 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, bool printout = false);
+       
+       // 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();
        
+       // 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);
        
-       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.
+       unsigned int update_count;      // Convienince counter for speading computational load over several updates
+       unsigned int update_count_max;  // ditto.
+       
+       double timeSinceLastDeparture;  // Time in seconds since last departure from active rwy.
+       bool departed;  // set true when the above needs incrementing with time, false when it doesn't.
        
        // environment - need to make sure we're getting the surface winds and not winds aloft.
        SGPropertyNode* wind_from_hdg;  //degrees
@@ -183,12 +267,18 @@ private:
        // 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 (planes doing circuits go into circuitList not depList after departure)
        tower_plane_rec_list_type depList;
@@ -209,6 +299,28 @@ private:
        // 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;
+       
+       // List of planes that have vacated the runway inbound but not yet handed off to ground
+       tower_plane_rec_list_type vacatedList;
+       tower_plane_rec_list_iterator vacatedListItr;
+       
+       // Returns true if successful
+       bool RemoveFromTrafficList(string id);
+       bool RemoveFromAppList(string id);
+       bool RemoveFromRwyList(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, bool printout = false);
+       
+       // 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);
+       
+       bool AddToCircuitList(TowerPlaneRec* t);
+       
+       // Add to vacated list only if not already present
+       void AddToVacatedList(TowerPlaneRec* t);
 
        // 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
@@ -216,14 +328,17 @@ private:
        bool separateGround;    // true if ground control is separate
        FGGround* ground;       // The ground control associated with this airport.
        
+       bool _departureControlled;      // true if we need to hand off departing traffic to departure control
+       //FGDeparture* _departure;      // The relevant departure control (once we've actually written it!)
+       
        // for failure modeling
        string trans_ident;             // transmitted ident
        bool tower_failed;              // tower failed?
        
-    // Pointers to current users position and orientation
-    SGPropertyNode* user_lon_node;
-    SGPropertyNode* user_lat_node;
-    SGPropertyNode* user_elev_node;
+       // Pointers to current users position and orientation
+       SGPropertyNode* user_lon_node;
+       SGPropertyNode* user_lat_node;
+       SGPropertyNode* user_elev_node;
        SGPropertyNode* user_hdg_node;
        
        // Details of the general traffic flow etc in the circuit
@@ -232,6 +347,10 @@ private:
        // 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.
        
+       double nominal_crosswind_leg_pos;
+       double nominal_downwind_leg_pos;
+       double nominal_base_leg_pos;
+       
        friend istream& operator>> ( istream&, FGTower& );
 };