dynamics.hxx

Go to the documentation of this file.

/*
 * SPDX-FileName: dynamics.hxx
 * SPDX-FileComment: a class to manage the higher order airport ground activities
 * SPDX-FileCopyrightText: Written by Durk Talsma, started December 2004.
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#pragma once
 
#include <set>
 
#include <simgear/structure/SGReferenced.hxx>
#include <simgear/structure/SGWeakReferenced.hxx>
#include <simgear/timing/timestamp.hxx>
 
#include <ATC/ApproachController.hxx>
#include <ATC/EnRouteController.hxx>
#include <ATC/GroundController.hxx>
#include <ATC/StartupController.hxx>
#include <ATC/TowerController.hxx>
#include <ATC/trafficcontrol.hxx>
#include <ATC/AirportGroundRadar.hxx>
 
#include "airports_fwd.hxx"
#include "parking.hxx"
#include "runwayprefs.hxx"
 
 
namespace RunwayAction {
    enum Type {
        TAKEOFF = 1,
        LANDING = 2
    };
    }
    
class ParkingAssignment
{
public:
    ParkingAssignment();
    ~ParkingAssignment();
 
    // create a parking assignment (and mark it as unavailable)
    ParkingAssignment(FGParking* pk, FGAirportDynamics* apt);
 
    ParkingAssignment(const ParkingAssignment& aOther);
    void operator=(const ParkingAssignment& aOther);
 
    bool isValid() const;
    FGParking* parking() const;
 
    void release();
 
private:
    void clear();
 
    class ParkingAssignmentPrivate;
    ParkingAssignmentPrivate* _sharedData;
};
 
class FGAirportDynamics : public SGWeakReferenced
{
private:
    FGAirport* _ap;
 
    typedef std::set<FGParkingRef> ParkingSet;
    // if a parking item is in this set, it is occupied
    ParkingSet occupiedParkings;
 
    FGRunwayPreference rwyPrefs;

    SGSharedPtr<AirportGroundRadar> groundRadar;
    ActiveRunwayVec activeRunways;
 
    FGStartupController startupController;
    FGTowerController towerController;
    FGApproachController approachController;
    FGGroundController groundController;
 
    time_t lastUpdate;
    std::string prevTrafficType;
    stringVec landing;
    stringVec takeoff;
    stringVec milActive, comActive, genActive, ulActive;
    stringVec* currentlyActive{nullptr};
 
    int atisSequenceIndex;
    double atisSequenceTimeStamp;
 
    std::string chooseRunwayFallback();
    bool innerGetActiveRunway(const std::string& trafficType, int action, std::string& runway, double heading);
    std::string chooseRwyByHeading(stringVec rwys, double heading);
 
    FGParking* innerGetAvailableParking(double radius, const std::string& flType,
                                        const std::string& airline,
                                        bool skipEmptyAirlineCode);
 
    std::string fallbackGetActiveRunway(int action, double heading);
 
    // runway preference fallback data
    SGTimeStamp _lastFallbackUpdate;
    FGRunwayList _fallbackDepartureRunways,
        _fallbackArrivalRunways;
    unsigned int _fallbackRunwayCounter{0};
 
public:
    explicit FGAirportDynamics(FGAirport* ap);
    virtual ~FGAirportDynamics();
 
    void init();
 
    double getElevation() const;
    const std::string getId() const;
 
    FGAirport* parent() const
    {
        return _ap;
    }
 
    void getActiveRunway(const std::string& trafficType,
                         int action,
                         std::string& runway,
                         double heading);
 
    bool hasParking(FGParking* parking) const;
 
    bool hasParkings() const;

    ParkingAssignment getAvailableParking(double radius, const std::string& fltype,
                                          const std::string& acType, const std::string& airline);
 
    void setParkingAvailable(FGParking* park, bool available);
 
    bool isParkingAvailable(FGParking* parking) const;
 
    void releaseParking(FGParking* id);
 
    FGParkingList getParkings(bool onlyAvailable, const std::string& type) const;

    ParkingAssignment getParkingByName(const std::string& name) const;

    ParkingAssignment getAvailableParkingByName(const std::string& name);
 
    FGParkingRef getOccupiedParkingByName(const std::string& name) const;
 
    // ATC related functions.
    FGStartupController* getStartupController()
    {
        return &startupController;
    };
    FGGroundController* getGroundController()
    {
        return &groundController;
    };
    FGTowerController* getTowerController()
    {
        return &towerController;
    };
    FGApproachController* getApproachController()
    {
        return &approachController;
    };
 
    int getApproachFrequency(unsigned nr);
    int getGroundFrequency(unsigned leg);
    int getTowerFrequency(unsigned nr);

    const std::string getAtisSequence();

    int updateAtisSequence(int interval, bool forceUpdate);
 
    void setRwyUse(const FGRunwayPreference& ref);
 
    ActiveRunwayQueue* getRunwayQueue(const std::string& name);
};