]> git.mxchange.org Git - flightgear.git/blobdiff - src/ATC/tower.hxx
If it's a struct, it's not a class
[flightgear.git] / src / ATC / tower.hxx
index ace19d982c2d0d6798d9b637bbb89240cbde3694..a1ed67892db46d408cea193eb401c4ff03f98037 100644 (file)
@@ -16,7 +16,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
 #ifndef _FG_TOWER_HXX
 #define _FG_TOWER_HXX
@@ -24,9 +24,7 @@
 #include <simgear/compiler.h>
 #include <simgear/math/point3d.hxx>
 #include <simgear/misc/sgstream.hxx>
-//#include <simgear/math/sg_geodesy.hxx>
 #include <plib/sg.h>
-//#include <Airports/runways.hxx>
 
 #include STL_IOSTREAM
 #include STL_STRING
@@ -35,11 +33,12 @@ SG_USING_STD(string);
 SG_USING_STD(ios);
 
 #include "ATC.hxx"
-//#include "ATCmgr.hxx"
-#include "ground.hxx"
 #include "ATCProjection.hxx"
 #include "AIPlane.hxx"
 
+class FGATCMgr;
+class FGGround;
+
 //DCL - a complete guess for now.
 #define FG_TOWER_DEFAULT_RANGE 30
 
@@ -54,8 +53,14 @@ enum tower_traffic_type {
 ostream& operator << (ostream& os, tower_traffic_type ttt);
 
 enum tower_callback_type {
-       USER_REQUEST_DEPARTURE = 1,
-       USER_REQUEST_ARRIVAL = 2
+       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.
@@ -67,9 +72,9 @@ class TowerPlaneRec {
 public:
        
        TowerPlaneRec();
-       TowerPlaneRec(PlaneRec p);
-       TowerPlaneRec(Point3D pt);
-       TowerPlaneRec(PlaneRec p, Point3D pt);
+       TowerPlaneRec(const PlaneRec& p);
+       TowerPlaneRec(const Point3D& pt);
+       TowerPlaneRec(const PlaneRec& p, const Point3D& pt);
        
        FGAIPlane* planePtr;    // This might move to the planeRec eventually
        PlaneRec plane;
@@ -87,9 +92,15 @@ public:
        bool longFinalAcknowledged;
        bool finalReported;
        bool finalAcknowledged;
-       bool instructedToGoAround;      // set true if told by tower to go around
+       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
+       
+       bool vfrArrivalReported;
+       bool vfrArrivalAcknowledged;
 
        // Type of operation the plane is doing
        tower_traffic_type opType;
@@ -98,7 +109,6 @@ public:
        PatternLeg leg;
        
        LandingType landingType;
-       
        bool isUser;    // true if this plane is the user
 };
 
@@ -121,43 +131,52 @@ public:
        
        void ReceiveUserCallback(int code);
 
-       void RequestLandingClearance(string ID);
-       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);
+       // 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(const string& ID, const LandingType& opt = AIP_LT_UNKNOWN);
+       // For the AI planes...
+       void VFRArrivalContact(const PlaneRec& plane, FGAIPlane* requestee, const LandingType& lt = AIP_LT_UNKNOWN);
+       
+       void RequestDepartureClearance(const string& ID);
+       void ReportFinal(const string& ID);
+       void ReportLongFinal(const string& ID);
+       void ReportOuterMarker(const string& ID);
+       void ReportMiddleMarker(const string& ID);
+       void ReportInnerMarker(const string& ID);
+       void ReportRunwayVacated(const string& ID);
+       void ReportReadyForDeparture(const string& ID);
+       void ReportDownwind(const string& ID);
+       void ReportGoingAround(const 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);
+       void ContactAtHoldShort(const 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);
+       void RegisterAIPlane(const PlaneRec& plane, FGAIPlane* ai, const tower_traffic_type& op, const PatternLeg& lg = LEG_UNKNOWN);
+       
+       // Deregister and remove an AI plane.
+       void DeregisterAIPlane(const 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 const string& GetActiveRunway() const { return activeRwy; }
+       inline const RunwayDetails& GetActiveRunwayDetails() const { return rwy; }
+       // Get the pattern direction of the active rwy.
+       inline int GetPatternDirection() const { return rwy.patternDirection; }
        
-       inline void SetDisplay() { display = true; }
-       inline void SetNoDisplay() { display = false; }
+       inline const string& get_trans_ident() const { return trans_ident; }
        
-       inline string get_trans_ident() { return trans_ident; }
-       inline atc_type GetType() { return TOWER; }
-       
-       inline FGGround* GetGroundPtr() { return ground; }
+       inline FGGround* const GetGroundPtr() const { 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;       
@@ -166,27 +185,35 @@ private:
        // 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);
+       TowerPlaneRec* FindPlane(const string& ID);
+       
+       // Remove and delete all instances of a plane with a given ID
+       void RemovePlane(const 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);
+       bool OnActiveRunway(const Point3D& pt);
        
        // Figure out if a given position lies on a runway or not
-       bool OnAnyRunway(Point3D pt);
+       bool OnAnyRunway(const Point3D& pt);
        
        // Calculate the eta of a plane to the threshold.
        // For ground traffic this is the fastest they can get there.
@@ -216,9 +243,6 @@ private:
        unsigned int update_count;      // Convienince counter for speading computational load over several updates
        unsigned int update_count_max;  // ditto.
        
-       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.
-       
        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.
        
@@ -274,8 +298,14 @@ private:
        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 RemoveFromTrafficList(const string& id);
+       bool RemoveFromAppList(const string& id);
+       bool RemoveFromRwyList(const 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.
@@ -286,6 +316,9 @@ private:
        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
@@ -293,6 +326,9 @@ 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?