FlightRoute.h

/***************************************************************************
 *   Copyright (C) 2019-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 <QBindable>
#include <QFile>
#include <QGeoRectangle>
#include <QJsonDocument>
#include <QLocale>
#include <QPointer>
#include <QQmlEngine>
#include <QXmlStreamReader>
 
#include "geomaps/Waypoint.h"
#include "navigation/Leg.h"
 
namespace GeoMaps
{
    class GeoMapProvider;
    class Waypoint;
} // namespace GeoMaps
 
class GlobalSettings;
 
namespace Navigation
{

 
    class FlightRoute : public QObject
    {
        Q_OBJECT
        QML_ELEMENT
 
    public:
        //
        // Constructors and destructors
        //

        explicit FlightRoute(QObject *parent = nullptr);
 
        // Standard destructor
        ~FlightRoute() override = default;
 
        //
        // PROPERTIES
        //

        Q_PROPERTY(QGeoRectangle boundingRectangle READ boundingRectangle NOTIFY waypointsChanged)
 
        
        Q_PROPERTY(QList<QGeoCoordinate> geoPath READ geoPath BINDABLE bindableGeoPath)

        Q_PROPERTY(QList<GeoMaps::Waypoint> midFieldWaypoints READ midFieldWaypoints NOTIFY waypointsChanged)

        Q_PROPERTY(QList<Navigation::Leg> legs READ legs BINDABLE bindableLegs)

        Q_PROPERTY(qsizetype size READ size NOTIFY waypointsChanged)

        Q_PROPERTY(QString summary READ summary NOTIFY summaryChanged)

        Q_PROPERTY(QList<GeoMaps::Waypoint> waypoints READ waypoints NOTIFY waypointsChanged)
 
 
        //
        // Getter Methods
        //

        [[nodiscard]] auto boundingRectangle() const -> QGeoRectangle;

        [[nodiscard]] QList<QGeoCoordinate> geoPath() const {return m_geoPath.value();}

        [[nodiscard]] QBindable<QList<QGeoCoordinate>> bindableGeoPath() const {return &m_geoPath;}

        [[nodiscard]] auto midFieldWaypoints() const -> QList<GeoMaps::Waypoint>;

        [[nodiscard]] QList<Navigation::Leg> legs() const { return m_legs.value(); }

        [[nodiscard]] QBindable<QList<Navigation::Leg>> bindableLegs() const { return &m_legs; }

        [[nodiscard]] auto size() const -> qsizetype { return m_waypoints.value().size(); }

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

        [[nodiscard]] auto waypoints() const -> QList<GeoMaps::Waypoint> {return {m_waypoints};}
 
 
        //
        // METHODS
        //

        Q_INVOKABLE void append(const GeoMaps::Waypoint& waypoint);

        Q_INVOKABLE void append(const QGeoCoordinate& position);

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

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

        Q_INVOKABLE void clear();

        [[nodiscard]] Q_INVOKABLE bool contains(const GeoMaps::Waypoint& waypoint) const;

        [[nodiscard]] Q_INVOKABLE qsizetype currentLeg(const Positioning::PositionInfo& pInfo) const;

        Q_INVOKABLE void directTo(const GeoMaps::Waypoint& target, const Positioning::PositionInfo& pInfo = {});

        Q_INVOKABLE void insert(const GeoMaps::Waypoint& waypoint);

        [[nodiscard]] Q_INVOKABLE qsizetype lastIndexOf(const GeoMaps::Waypoint& waypoint) const;

        Q_INVOKABLE QString load(const QString& fileName);

        Q_INVOKABLE void moveDown(int idx);

        Q_INVOKABLE void moveUp(int idx);

        Q_INVOKABLE void removeWaypoint(int idx);

        Q_INVOKABLE void replaceWaypoint(int idx, const GeoMaps::Waypoint& newWaypoint);

        Q_INVOKABLE void reverse();

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

        [[nodiscard]] Q_INVOKABLE QString suggestedFilename() const;

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

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

        [[nodiscard]] Q_INVOKABLE QString toVfrFlightPlan() const;
 
    signals:
        void waypointsChanged();

        void summaryChanged();
 
    private slots:
 
    private:
        Q_DISABLE_COPY_MOVE(FlightRoute)
 
        // Helper function for method toGPX
        [[nodiscard]] auto gpxElements(const QString& indent, const QString& tag) const -> QString;
 
        QProperty<QList<QGeoCoordinate>> m_geoPath;
        QList<QGeoCoordinate> computeGeoPath();
 
        Q_OBJECT_BINDABLE_PROPERTY(Navigation::FlightRoute, QVector<GeoMaps::Waypoint>, m_waypoints, &Navigation::FlightRoute::waypointsChanged);
 
        QProperty<QVector<Leg>> m_legs;
        QVector<Leg> computeLegs();
 
        QLocale myLocale;
    };
 
} // namespace Navigation