RemainingRouteInfo.h

/***************************************************************************
 *   Copyright (C) 2022-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 "geomaps/Waypoint.h"
#include "units/Angle.h"
#include "units/Distance.h"
#include "units/Timespan.h"
 
#include <QQmlEngine>
 
 
namespace Navigation {
 
class Navigator;

 
class RemainingRouteInfo {
    Q_GADGET
    QML_VALUE_TYPE(remainingRouteInfo)
 
    
    friend auto operator==(const Navigation::RemainingRouteInfo&, const Navigation::RemainingRouteInfo&) -> bool;
    friend class Navigation::Navigator;
 
public:
    enum Status : quint8 {
        NoRoute,

        PositionUnknown,

        OffRoute,

        NearDestination,

        OnRoute
    };
    Q_ENUM(Status)
 
    //
    // PROPERTIES
    //
 
    
    Q_PROPERTY(GeoMaps::Waypoint nextWP MEMBER nextWP CONSTANT)

    Q_PROPERTY(Units::Distance nextWP_DIST MEMBER nextWP_DIST CONSTANT)

    Q_PROPERTY(Units::Timespan nextWP_ETE MEMBER nextWP_ETE CONSTANT)

    Q_PROPERTY(QDateTime nextWP_ETA MEMBER nextWP_ETA CONSTANT)

    Q_PROPERTY(QString nextWP_ETAAsUTCString READ nextWP_ETAAsUTCString CONSTANT)

    Q_PROPERTY(Units::Angle nextWP_TC MEMBER nextWP_TC CONSTANT)

    Q_PROPERTY(GeoMaps::Waypoint finalWP MEMBER finalWP CONSTANT)

    Q_PROPERTY(Units::Distance finalWP_DIST MEMBER finalWP_DIST CONSTANT)

    Q_PROPERTY(Units::Timespan finalWP_ETE MEMBER finalWP_ETE CONSTANT)

    Q_PROPERTY(QDateTime finalWP_ETA MEMBER finalWP_ETA CONSTANT)

    Q_PROPERTY(QString finalWP_ETAAsUTCString READ finalWP_ETAAsUTCString CONSTANT)

    Q_PROPERTY(QString note MEMBER note CONSTANT)

    Q_PROPERTY(Navigation::RemainingRouteInfo::Status status MEMBER status CONSTANT)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] auto nextWP_ETAAsUTCString() const -> QString {
        if (nextWP_ETE.isFinite()) {
            return nextWP_ETA.toString(QStringLiteral("H:mm"));
        }
        return QStringLiteral("-:--");
    }

    [[nodiscard]] auto finalWP_ETAAsUTCString() const -> QString {
        if (finalWP_ETE.isFinite()) {
            return finalWP_ETA.toString(QStringLiteral("H:mm"));
        }
        return QStringLiteral("-:--");
    }
 
private:
    Status status {NoRoute};
    QString note;
 
    GeoMaps::Waypoint nextWP;
    Units::Distance nextWP_DIST{};
    Units::Timespan nextWP_ETE {};
    QDateTime nextWP_ETA;
    Units::Angle nextWP_TC{};
 
    GeoMaps::Waypoint finalWP;
    Units::Distance finalWP_DIST{};
    Units::Timespan finalWP_ETE {};
    QDateTime finalWP_ETA;
};

auto operator==(const Navigation::RemainingRouteInfo&, const Navigation::RemainingRouteInfo&) -> bool;
 
 
} // namespace Navigation
 
// Make enums available in QML
namespace RemainingRouteInfoQML
{
    Q_NAMESPACE
    QML_FOREIGN_NAMESPACE(Navigation::RemainingRouteInfo)
    QML_NAMED_ELEMENT(RemainingRouteInfo)
} // namespace RemainingRouteInfoQML
 
// Declare meta types
Q_DECLARE_METATYPE(Navigation::RemainingRouteInfo)