route_mgr.hxx

Go to the documentation of this file.

// route_mgr.hxx - manage a route (i.e. a collection of waypoints)
/*
 * SPDX-FileCopyrightText: (C) 2004 Curtis L. Olson http://www.flightgear.org/~curt
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 
#pragma once
 
#include <simgear/props/props.hxx>
#include <simgear/structure/subsystem_mgr.hxx>
 
#include <Navaids/FlightPlan.hxx>
 
// forward decls
class SGPath;
class PropertyWatcher;
class RoutePath;

 
class FGRouteMgr : public SGSubsystem,
                   public flightgear::FlightPlan::Delegate
{
public:
    FGRouteMgr();
    ~FGRouteMgr();
 
    // Subsystem API.
    void bind() override;
    void init() override;
    void postinit() override;
    void unbind() override;
    void update(double dt) override;
 
    // Subsystem identification.
    static const char* staticSubsystemClassId() { return "route-manager"; }
 
    bool isRouteActive() const;
 
    int currentIndex() const;
 
    void setFlightPlan(const flightgear::FlightPlanRef& plan);
    flightgear::FlightPlanRef flightPlan() const;
 
    void clearRoute();
 
    flightgear::Waypt* currentWaypt() const;
 
    int numLegs() const;
 
    // deprecated
    int numWaypts() const
    { return numLegs(); }
 
    // deprecated
    flightgear::Waypt* wayptAtIndex(int index) const;
 
    SGPropertyNode_ptr wayptNodeAtIndex(int index) const;
 
    void removeLegAtIndex(int aIndex);

    bool activate();

    void deactivate();

    void jumpToIndex(int index);
 
    bool saveRoute(const SGPath& p);
    bool loadRoute(const SGPath& p);

    flightgear::WayptRef waypointFromString(const std::string& target, int insertPosition);
 
private:
    bool commandDefineUserWaypoint(const SGPropertyNode * arg, SGPropertyNode * root);
    bool commandDeleteUserWaypoint(const SGPropertyNode * arg, SGPropertyNode * root);
 
    flightgear::FlightPlanRef _plan;
 
    time_t _takeoffTime;
    time_t _touchdownTime;
 
    // automatic inputs
    SGPropertyNode_ptr magvar;
 
    // automatic outputs
    SGPropertyNode_ptr departure; 
    SGPropertyNode_ptr destination; 
    SGPropertyNode_ptr alternate; 
    SGPropertyNode_ptr cruise; 
 
    SGPropertyNode_ptr totalDistance;
    SGPropertyNode_ptr distanceToGo;
    SGPropertyNode_ptr ete;
    SGPropertyNode_ptr elapsedFlightTime;
 
    SGPropertyNode_ptr active;
    SGPropertyNode_ptr airborne;
 
    SGPropertyNode_ptr wp0;
    SGPropertyNode_ptr wp1;
    SGPropertyNode_ptr wpn;
 
 
    SGPropertyNode_ptr _pathNode;
    SGPropertyNode_ptr _currentWpt;
    SGPropertyNode_ptr _isRoute;

    SGPropertyNode_ptr _edited;

    SGPropertyNode_ptr _finished;
 
    SGPropertyNode_ptr _flightplanChanged;
 
    void setETAPropertyFromDistance(SGPropertyNode_ptr aProp, double aDistance);

    double cachedLegPathDistanceM(int index) const;
    double cachedWaypointPathTotalDistance(int index) const;
 
    class InputListener : public SGPropertyChangeListener {
    public:
        InputListener(FGRouteMgr *m) : mgr(m) {}
        virtual void valueChanged (SGPropertyNode * prop);
    private:
        FGRouteMgr *mgr;
    };
 
    SGPropertyNode_ptr input;
    SGPropertyNode_ptr weightOnWheels;
    SGPropertyNode_ptr groundSpeed;
 
    InputListener *listener;
    SGPropertyNode_ptr mirror;
 
    std::unique_ptr<RoutePath> _routePath;

    void waypointsChanged() override;
    void arrivalChanged() override;
    void departureChanged() override;
 
    void update_mirror();
 
    void currentWaypointChanged() override;
    
    // tied getters and setters
    std::string getDepartureICAO() const;
    std::string getDepartureName() const;
    void setDepartureICAO(const std::string& aIdent);
 
    std::string getDepartureRunway() const;
    void setDepartureRunway(const std::string& aIdent);
 
    std::string getSID() const;
    void setSID(const std::string& aIdent);
 
    std::string getDestinationICAO() const;
    std::string getDestinationName() const;
    void setDestinationICAO(const std::string& aIdent);
 
    std::string getDestinationRunway() const;
    void setDestinationRunway(const std::string& aIdent);
 
    std::string getApproach() const;
    void setApproach(const std::string& aIdent);
 
    std::string getSTAR() const;
    void setSTAR(const std::string& aIdent);
 
    double getDepartureFieldElevation() const;
    double getDestinationFieldElevation() const;
 
    int getCruiseAltitudeFt() const;
    void setCruiseAltitudeFt(int ft);
 
    int getCruiseFlightLevel() const;
    void setCruiseFlightLevel(int fl);
 
    int getCruiseSpeedKnots() const;
    void setCruiseSpeedKnots(int kts);
 
    double getCruiseSpeedMach() const;
    void setCruiseSpeedMach(double m);
 
    std::string getAlternate() const;
    std::string getAlternateName() const;
    void setAlternate(const std::string &icao);
};