Aircraft.h

/***************************************************************************
 *   Copyright (C) 2019-2022 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 "units/Distance.h"
#include "units/Speed.h"
#include "units/Volume.h"
#include "units/VolumeFlow.h"
 
#include <QGeoCoordinate>
#include <QQmlEngine>
 
namespace Navigation {

 
class Aircraft {
    Q_GADGET
    QML_VALUE_TYPE(aircraft)
 
public:
    enum FuelConsumptionUnit : quint8 {
        LiterPerHour = 0,

        GallonPerHour = 1
    };
    Q_ENUM(FuelConsumptionUnit)
 
    
    enum HorizontalDistanceUnit : quint8 {
        NauticalMile = 0,

        Kilometer = 1,

        StatuteMile = 2
    };
    Q_ENUM(HorizontalDistanceUnit)
 
    
    enum VerticalDistanceUnit : quint8 {
        Feet = 0,

        Meters = 1
    };
    Q_ENUM(VerticalDistanceUnit)
 
 
    //
    // Properties
    //
 
    
    Q_PROPERTY(Units::Speed cruiseSpeed READ cruiseSpeed WRITE setCruiseSpeed)

    Q_PROPERTY(Units::Speed descentSpeed READ descentSpeed WRITE setDescentSpeed)

    Q_PROPERTY(Units::VolumeFlow fuelConsumption READ fuelConsumption WRITE setFuelConsumption)

    Q_PROPERTY(FuelConsumptionUnit fuelConsumptionUnit READ fuelConsumptionUnit WRITE setFuelConsumptionUnit)

    Q_PROPERTY(HorizontalDistanceUnit horizontalDistanceUnit READ horizontalDistanceUnit WRITE setHorizontalDistanceUnit)

    Q_PROPERTY(Units::Speed maxValidSpeed MEMBER maxValidSpeed CONSTANT)

    Q_PROPERTY(Units::VolumeFlow maxValidFuelConsumption MEMBER maxValidFuelConsumption CONSTANT)

    Q_PROPERTY(Units::Speed minimumSpeed READ minimumSpeed WRITE setMinimumSpeed)

    Q_PROPERTY(Units::VolumeFlow minValidFuelConsumption MEMBER minValidFuelConsumption CONSTANT)

    Q_PROPERTY(Units::Speed minValidSpeed MEMBER minValidSpeed CONSTANT)

    Q_PROPERTY(QString name READ name WRITE setName)

    Q_PROPERTY(VerticalDistanceUnit verticalDistanceUnit READ verticalDistanceUnit WRITE setVerticalDistanceUnit)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] auto cruiseSpeed() const -> Units::Speed { return m_cruiseSpeed; }

    [[nodiscard]] auto descentSpeed() const -> Units::Speed { return m_descentSpeed; }

    [[nodiscard]] auto fuelConsumption() const -> Units::VolumeFlow { return m_fuelConsumption; }

    [[nodiscard]] auto fuelConsumptionUnit() const -> FuelConsumptionUnit { return m_fuelConsumptionUnit; }

    [[nodiscard]] auto horizontalDistanceUnit() const -> HorizontalDistanceUnit { return m_horizontalDistanceUnit; }

    [[nodiscard]] auto minimumSpeed() const -> Units::Speed { return m_minimumSpeed; }

    [[nodiscard]] auto name() const -> QString { return m_name; }

    [[nodiscard]] auto verticalDistanceUnit() const -> VerticalDistanceUnit { return m_verticalDistanceUnit; }
 
 
    //
    // Setter Methods
    //

    void setCruiseSpeed(Units::Speed newSpeed);

    void setDescentSpeed(Units::Speed newSpeed);

    void setFuelConsumption(Units::VolumeFlow newFuelConsumption);

    void setFuelConsumptionUnit(FuelConsumptionUnit newUnit);

    void setHorizontalDistanceUnit(HorizontalDistanceUnit newUnit);

    void setMinimumSpeed(Units::Speed newSpeed);

    void setName(const QString& newName);

    void setVerticalDistanceUnit(VerticalDistanceUnit newUnit);
 
 
    //
    // Methods
    //

    [[nodiscard]] Q_INVOKABLE Navigation::Aircraft clone() const { return {*this}; }

    [[nodiscard]] Q_INVOKABLE QString describeWay(const QGeoCoordinate &from, const QGeoCoordinate &to) const;

    [[nodiscard]] Q_INVOKABLE QString horizontalDistanceToString(Units::Distance distance) const;

    [[nodiscard]] Q_INVOKABLE QString horizontalSpeedToString(Units::Speed speed) const;

    [[nodiscard]] Q_INVOKABLE QString loadFromJSON(const QString& fileName);

    [[nodiscard]] Q_INVOKABLE QString loadFromJSON(const QByteArray &JSON);

    Q_INVOKABLE bool operator==(const Navigation::Aircraft& other) const;

    [[nodiscard]] Q_INVOKABLE QString save(const QString& fileName) const;

    [[nodiscard]] Q_INVOKABLE QByteArray toJSON() const;

    [[nodiscard]] Q_INVOKABLE QString verticalDistanceToString(Units::Distance distance, bool forceSign=false) const;

    [[nodiscard]] Q_INVOKABLE QString verticalSpeedToString(Units::Speed speed) const;

    [[nodiscard]] Q_INVOKABLE QString volumeToString(Units::Volume volume) const;
 
private:
    static constexpr Units::Speed minValidSpeed = Units::Speed::fromKN(10.0);
    static constexpr Units::Speed maxValidSpeed = Units::Speed::fromKN(400.0);
    static constexpr Units::VolumeFlow minValidFuelConsumption = Units::VolumeFlow::fromLPH(0.0);
    static constexpr Units::VolumeFlow maxValidFuelConsumption = Units::VolumeFlow::fromLPH(300.0);
 
    Units::Speed m_cruiseSpeed {};
    Units::Speed m_descentSpeed {};
    Units::VolumeFlow m_fuelConsumption {};
    FuelConsumptionUnit m_fuelConsumptionUnit {LiterPerHour};
    HorizontalDistanceUnit m_horizontalDistanceUnit {NauticalMile};
    Units::Speed m_minimumSpeed {};
    QString m_name;
    VerticalDistanceUnit m_verticalDistanceUnit{Feet};
};
 
} // namespace Navigation
 
// Make enums available in QML
namespace AircraftQML {
Q_NAMESPACE
QML_FOREIGN_NAMESPACE(Navigation::Aircraft)
QML_NAMED_ELEMENT(Aircraft)
} // Namespace AircraftQML
 
// Declare meta types
Q_DECLARE_METATYPE(Navigation::Aircraft)