Waypoint.h

/***************************************************************************
 *   Copyright (C) 2019-2024 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 <QGeoCoordinate>
#include <QJsonObject>
#include <QMap>
#include <QQmlEngine>
#include <QXmlStreamWriter>
 
#include "units/Angle.h"
 
 
namespace GeoMaps {

 
class Waypoint
{
    Q_GADGET
    QML_VALUE_TYPE(waypoint)
 
    
    friend size_t qHash(const GeoMaps::Waypoint& waypoint);
 
public:
    Waypoint();

    Waypoint(const QGeoCoordinate& coordinate, const QString& name = {});

    explicit Waypoint(const QJsonObject& geoJSONObject);
 
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(QString category READ category CONSTANT)
 
    
    Q_PROPERTY(QGeoCoordinate coordinate READ coordinate WRITE setCoordinate)

    Q_PROPERTY(QString extendedName READ extendedName)

    Q_PROPERTY(QString ICAOCode READ ICAOCode CONSTANT)

    Q_PROPERTY(QString icon READ icon CONSTANT)
 
    /* \brief Validity
     *
     * This property is set to true if the waypoint has a valid coordinate and
     * if the properties satisfy the specifications outlined
     * [here](https://github.com/Akaflieg-Freiburg/enrouteServer/wiki/GeoJSON-files-used-in-enroute-flight-navigation).
     */
    Q_PROPERTY(bool isValid READ isValid)

    Q_PROPERTY(QString name READ name WRITE setName)

    Q_PROPERTY(QString notes READ notes WRITE setNotes)

    Q_PROPERTY(QString shortName READ shortName CONSTANT)
 
    /* \brief Verbose description of waypoint properties
     *
     * This property holds a list of strings in meaningful order that describe
     * the waypoint properties.  This includes airport frequency, runway
     * information, etc. The data is returned as a list of strings where the
     * first four letters of each string indicate the type of data with an
     * abbreviation that will be understood by pilots ("RWY ", "ELEV", etc.).
     * The rest of the string will then contain the actual data.
     */
    Q_PROPERTY(QList<QString> tabularDescription READ tabularDescription)

    Q_PROPERTY(QString twoLineTitle READ twoLineTitle)

    Q_PROPERTY(QString type READ type CONSTANT)

    Q_PROPERTY(Units::Angle variation READ variation CONSTANT)
 
 
    //
    // GETTER METHODS
    //

    [[nodiscard]] auto category() const -> QString
    {
        return m_properties.value(QStringLiteral("CAT")).toString();
    }

    [[nodiscard]] auto coordinate() const -> QGeoCoordinate
    {
        return m_coordinate;
    }

    [[nodiscard]] auto extendedName() const -> QString;

    [[nodiscard]] auto ICAOCode() const -> QString
    {
        return m_properties.value(QStringLiteral("COD")).toString();
    }

    [[nodiscard]] auto icon() const -> QString;

    [[nodiscard]] auto isValid() const -> bool;

    [[nodiscard]] auto name() const -> QString
    {
        return m_properties.value(QStringLiteral("NAM")).toString();
    }

    [[nodiscard]] auto notes() const -> QString
    {
        return m_properties.value(QStringLiteral("NOT")).toString();
    }

    [[nodiscard]] auto shortName() const -> QString
    {
        if (ICAOCode().isEmpty()) {
            return name();
        }
        return ICAOCode();
    }

    [[nodiscard]] auto tabularDescription() const -> QList<QString>;

    [[nodiscard]] auto twoLineTitle() const -> QString;

    [[nodiscard]] auto type() const -> QString
    {
        return m_properties.value(QStringLiteral("TYP")).toString();
    }

    [[nodiscard]] auto variation() const -> Units::Angle;
 
 
    //
    // SETTER METHODS
    //

    void setCoordinate(const QGeoCoordinate& newCoordinate)
    {
        m_coordinate = newCoordinate;
    }

    void setName(const QString &newName)
    {
        m_properties.insert(QStringLiteral("NAM"), newName);
    }

    void setNotes(const QString &newNotes)
    {
        m_properties.insert(QStringLiteral("NOT"), newNotes);
    }
 
 
    //
    // METHODS
    //

    [[nodiscard]] Q_INVOKABLE bool operator==(const GeoMaps::Waypoint& other) const = default;

    [[nodiscard]] Q_INVOKABLE bool operator!=(const GeoMaps::Waypoint& other) const = default;

    [[nodiscard]] Q_INVOKABLE GeoMaps::Waypoint copy() const
    {
        return *this;
    }

    [[nodiscard]] Q_INVOKABLE bool isNear(const GeoMaps::Waypoint& other) const;

    [[nodiscard]] QJsonObject toJSON() const;

    void toGPX(QXmlStreamWriter& stream) const;
 
protected:
    QGeoCoordinate m_coordinate;
    QMap<QString, QVariant> m_properties;
};

auto qHash(const GeoMaps::Waypoint& waypoint) -> size_t;
 
} // namespace GeoMaps
 
// Declare meta types
Q_DECLARE_METATYPE(GeoMaps::Waypoint)