TrafficFactor_Abstract.h

/***************************************************************************
 *   Copyright (C) 2021-2025 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 <QObjectBindableProperty>
#include <QTimer>
 
#include "units/Distance.h"
 
using namespace std::chrono_literals;
 
 
namespace Traffic {

 
class TrafficFactor_Abstract : public QObject {
    Q_OBJECT
 
public:
    static constexpr auto lifeTime = 10s;

    enum AircraftType : quint8
    {
        unknown, 
        Aircraft, 
        Airship, 
        Balloon, 
        Copter, 
        Drone, 
        Glider, 
        HangGlider, 
        Jet, 
        Paraglider, 
        Skydiver, 
        StaticObstacle, 
        TowPlane 
    };
    Q_ENUM(AircraftType)
 
    
    explicit TrafficFactor_Abstract(QObject* parent = nullptr);
 
    // Standard destructor
    ~TrafficFactor_Abstract() override = default;
 
 
    //
    // Methods
    //

    void copyFrom(const TrafficFactor_Abstract& other)
    {
        setAlarmLevel(other.alarmLevel());
        setCallSign(other.callSign());
        setHDist(other.hDist());
        setID(other.ID());
        setType(other.type());
        setVDist(other.vDist());
        updateDescription();
    }

    [[nodiscard]] auto hasHigherPriorityThan(const TrafficFactor_Abstract& rhs) const -> bool;

    void startLiveTime();
 
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(int alarmLevel READ alarmLevel WRITE setAlarmLevel NOTIFY alarmLevelChanged BINDABLE bindableAlarmLevel)
 
    
    Q_PROPERTY(bool animate READ animate WRITE setAnimate NOTIFY animateChanged)

    Q_PROPERTY(QString callSign READ callSign WRITE setCallSign NOTIFY callSignChanged)

    Q_PROPERTY(QString color READ color NOTIFY colorChanged)

    Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)

    Q_PROPERTY(Units::Distance hDist READ hDist WRITE setHDist NOTIFY hDistChanged BINDABLE bindableHDist)

    Q_PROPERTY(QString ID READ ID WRITE setID NOTIFY IDChanged)

    Q_PROPERTY(bool relevant READ relevant BINDABLE bindableRelevant)

    Q_PROPERTY(QString relevantString READ relevantString BINDABLE bindableRelevantString)

    Q_PROPERTY(AircraftType type READ type WRITE setType NOTIFY typeChanged BINDABLE bindableType)

    Q_PROPERTY(QString typeString READ typeString BINDABLE bindableTypeString)

    Q_PROPERTY(bool valid READ valid NOTIFY validChanged BINDABLE bindableValid)

    Q_PROPERTY(Units::Distance vDist READ vDist WRITE setVDist NOTIFY vDistChanged BINDABLE bindableVDist)
 
 
    //
    // Getter/Setter Methods
    //

    [[nodiscard]] int alarmLevel() const {return m_alarmLevel.value();}

    [[nodiscard]] QBindable<int> bindableAlarmLevel() {return &m_alarmLevel;}

    [[nodiscard]] auto animate() const -> bool
    {
        return m_animate;
    }

    [[nodiscard]] auto callSign() const -> QString
    {
        return m_callSign;
    }

    [[nodiscard]] auto color() const -> QString
    {
        if (m_alarmLevel == 0) {
            return QStringLiteral("green");
        }
        if (m_alarmLevel == 1) {
            return QStringLiteral("yellow");
        }
        return QStringLiteral("red");
    }

    [[nodiscard]] auto description() const -> QString
    {
        return m_description;
    }

    [[nodiscard]] Units::Distance hDist() const {return m_hDist.value();}

    [[nodiscard]] QBindable<Units::Distance> bindableHDist() {return &m_hDist;}

    [[nodiscard]] auto ID() const -> QString
    {
        return m_ID;
    }

    [[nodiscard]] bool relevant() const {return m_relevant.value();}

    [[nodiscard]] QBindable<bool> bindableRelevant() {return &m_relevant;}

    [[nodiscard]] QString relevantString() const {return m_relevantString.value();}

    [[nodiscard]] QBindable<bool> bindableRelevantString() {return &m_relevantString;}

    [[nodiscard]] Traffic::TrafficFactor_Abstract::AircraftType type() const {return m_type.value();}

    [[nodiscard]] QBindable<Traffic::TrafficFactor_Abstract::AircraftType> bindableType() {return &m_type;}

    [[nodiscard]] QString typeString() const {return m_typeString.value();}

    [[nodiscard]] QBindable<QString> bindableTypeString() {return &m_typeString;}

    [[nodiscard]] bool valid() const {return m_valid.value();}

    [[nodiscard]] QBindable<bool> bindableValid() {return &m_valid;}

    [[nodiscard]] Units::Distance vDist() const {return m_vDist.value();}

    [[nodiscard]] QBindable<Units::Distance> bindableVDist() {return &m_vDist;}
 
 
    //
    // Setter Methods
    //

    void setAlarmLevel(int newAlarmLevel)
    {
        // Safety checks
        if ((newAlarmLevel < 0) || (newAlarmLevel > 3)) {
            return;
        }
        startLiveTime();
        m_alarmLevel = newAlarmLevel;
    }

    void setAnimate(bool newAnimate) {
        if (m_animate == newAnimate) {
            return;
        }
        m_animate = newAnimate;
        emit animateChanged();
    }

    void setCallSign(const QString& newCallSign) {
        if (m_callSign == newCallSign) {
            return;
        }
        m_callSign = newCallSign;
        emit callSignChanged();
    }

    void setHDist(Units::Distance newHDist) {m_hDist = newHDist;}

    void setID(const QString& newID) {
        if (m_ID == newID) {
            return;
        }
        m_ID = newID;
        emit IDChanged();
    }

    void setType(Traffic::TrafficFactor_Abstract::AircraftType newType) {m_type = newType;}

    void setVDist(Units::Distance newVDist) {m_vDist = newVDist;}
 
 
    //
    // Constants
    //

    static constexpr Units::Distance maxVerticalDistance = Units::Distance::fromM(1500.0);

    static constexpr Units::Distance maxHorizontalDistance = Units::Distance::fromNM(20.0);
 
signals:
    void alarmLevelChanged();

    void animateChanged();

    void callSignChanged();

    void colorChanged();

    void descriptionChanged();

    void hDistChanged();

    void IDChanged();

    void typeChanged();

    void vDistChanged();

    void validChanged();
 
 
protected:
    // Setter function for the property valid.  This function is virtual and must not be
    // called or accessed from the constructor. For this reason, we have a special function
    // "dispatchUpdateValid", which whose address is already known to the constructor.
    virtual void updateValid();
    void dispatchUpdateValid();
    Q_OBJECT_BINDABLE_PROPERTY_WITH_ARGS(Traffic::TrafficFactor_Abstract, bool, m_valid, false, &Traffic::TrafficFactor_Abstract::validChanged);
 
    // Setter function for the property "description". This function is virtual and must not be
    // called or accessed from the constructor. For this reason, we have a special function
    // "dispatchUpdateDescription", which whose address is already known to the constructor.
    virtual void updateDescription();
    void dispatchUpdateDescription();
    QString m_description;
 
private:
    Q_DISABLE_COPY_MOVE(TrafficFactor_Abstract)
 
    //
    // Property values
    //
    Q_OBJECT_BINDABLE_PROPERTY_WITH_ARGS(Traffic::TrafficFactor_Abstract, int, m_alarmLevel, 0, &Traffic::TrafficFactor_Abstract::alarmLevelChanged);
    bool m_animate {false};
    QString m_callSign;
    QString m_color{QStringLiteral("red")};
    Q_OBJECT_BINDABLE_PROPERTY(Traffic::TrafficFactor_Abstract, Units::Distance, m_hDist, &Traffic::TrafficFactor_Abstract::hDistChanged);
    QString m_ID;
    Q_OBJECT_BINDABLE_PROPERTY_WITH_ARGS(Traffic::TrafficFactor_Abstract, Traffic::TrafficFactor_Abstract::AircraftType, m_type, unknown, &Traffic::TrafficFactor_Abstract::typeChanged);
    QProperty<bool> m_relevant {false};
    QProperty<QString> m_relevantString;
    QProperty<QString> m_typeString;
    Q_OBJECT_BINDABLE_PROPERTY(Traffic::TrafficFactor_Abstract, Units::Distance, m_vDist, &Traffic::TrafficFactor_Abstract::vDistChanged);
 
    // Timer for timeout. Traffic objects become invalid if their data has not been
    // refreshed for longer than timeout.
    QTimer lifeTimeCounter;
};
 
} // namespace Traffic