Navigator.h

/***************************************************************************
 *   Copyright (C) 2019-2023 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   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.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QQmlEngine>
#include <QStandardPaths>
 
#include "FlightRoute.h"
#include "GlobalObject.h"
#include "navigation/FlightRoute.h"
#include "navigation/RemainingRouteInfo.h"
 
 
namespace Navigation {

 
class Navigator : public GlobalObject
{
    Q_OBJECT
    QML_ELEMENT
    QML_SINGLETON
 
public:
    enum FlightStatus : quint8
      {
        Ground, 
        Flight, 
        Unknown 
      };
    Q_ENUM(FlightStatus)
 
 
 
    //
    // Constructors and Destructors
    //
 
    
    explicit Navigator(QObject* parent = nullptr);
 
    // deferred initialization
    void deferredInitialization() override;
 
    // No default constructor, important for QML singleton
    explicit Navigator() = delete;

    ~Navigator() override = default;
 
    // factory function for QML singleton
    static Navigation::Navigator* create(QQmlEngine* /*unused*/, QJSEngine* /*unused*/)
    {
        return GlobalObject::navigator();
    }
 
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(Navigation::Aircraft aircraft READ aircraft WRITE setAircraft NOTIFY aircraftChanged)
 
    
    Q_PROPERTY(Navigation::FlightRoute* flightRoute READ flightRoute CONSTANT)

    Q_PROPERTY(FlightStatus flightStatus READ flightStatus NOTIFY flightStatusChanged)

    Q_PROPERTY(Navigation::RemainingRouteInfo remainingRouteInfo READ remainingRouteInfo NOTIFY remainingRouteInfoChanged)

    Q_PROPERTY(Weather::Wind wind READ wind WRITE setWind NOTIFY windChanged)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] auto aircraft() const -> Navigation::Aircraft { return m_aircraft; }

    auto flightRoute() -> Navigation::FlightRoute*;

    [[nodiscard]] auto flightStatus() const -> FlightStatus { return m_flightStatus; }

    [[nodiscard]] auto remainingRouteInfo() const -> Navigation::RemainingRouteInfo { return m_remainingRouteInfo; }

    [[nodiscard]] auto wind() const -> Weather::Wind { return m_wind; }
 
 
    //
    // Setter Methods
    //

    void setAircraft(const Navigation::Aircraft& newAircraft);

    void setWind(Weather::Wind newWind);
 
signals:
    void aircraftChanged();

    void airspaceAltitudeLimitAdjusted();

    void flightStatusChanged();

    void remainingRouteInfoChanged();

    void windChanged();
 
private slots:
    // Check if altitude limit for flight maps needs to be lifted. Connected to positioning source.
    void updateAltitudeLimit();
 
    // Update flight status. Connected to positioning source.
    void updateFlightStatus();
 
    // Setter method. Only use this method to write to m_remainingRouteInfo
    void setRemainingRouteInfo(const Navigation::RemainingRouteInfo& rrInfo);
 
    // Re-computes the Remaining Route Info. The argument must be the current position info of the own aircraft.
    void updateRemainingRouteInfo();
 
private:
    Q_DISABLE_COPY_MOVE(Navigator)
 
    // Updater function for the property with the same name
    void setFlightStatus(FlightStatus newFlightStatus);
 
    // Hysteresis for flight speed
    static constexpr auto flightSpeedHysteresis = Units::Speed::fromKN(5.0);
 
    FlightStatus m_flightStatus {Unknown};
 
    Aircraft m_aircraft {};
 
    QPointer<FlightRoute> m_flightRoute {nullptr};
    const QString m_flightRouteFileName {QStandardPaths::writableLocation(QStandardPaths::AppDataLocation)+"/flight route.geojson"};
 
    Weather::Wind m_wind {};
 
    QString m_aircraftFileName;
 
    // RemainingRouteInfo only use the setter method to write to m_remainingRouteInfo
    RemainingRouteInfo m_remainingRouteInfo;
};
 
} // namespace Navigation