NOTAMList.h

/***************************************************************************
 *   Copyright (C) 2023-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 <QQmlEngine>
 
#include "geomaps/Waypoint.h"
#include "notam/NOTAM.h"
#include "units/Timespan.h"
 
namespace NOTAM {
 

 
class NOTAMList {
    Q_GADGET
    QML_VALUE_TYPE(notamList)
 
    friend QDataStream& operator<<(QDataStream& stream, const NOTAMList& notamList);
    friend QDataStream& operator>>(QDataStream& stream, NOTAMList& notamList);
 
public:
    NOTAMList() = default;

    NOTAMList(const QJsonDocument& jsonDoc, const QGeoCircle& region, QSet<QString>* cancelledNotamNumbers=nullptr);
 
 
    //
    // Properties
    //

    Q_PROPERTY(bool isEmpty READ isEmpty CONSTANT)

    Q_PROPERTY(bool isValid READ isValid CONSTANT)

    Q_PROPERTY(QList<NOTAM> notams READ notams CONSTANT)

    Q_PROPERTY(QGeoCircle region READ region CONSTANT)

    Q_PROPERTY(QDateTime retrieved READ retrieved CONSTANT)

    Q_PROPERTY(QString summary READ summary CONSTANT)
 
 
 
    //
    // Getter Methods
    //

    Q_REQUIRED_RESULT bool isEmpty() const { return m_notams.isEmpty(); }

    Q_REQUIRED_RESULT bool isValid() const { return m_retrieved.isValid() && m_region.isValid(); }

    Q_REQUIRED_RESULT QList<NOTAM> notams() const { return m_notams; }

    Q_REQUIRED_RESULT QGeoCircle region() const { return m_region; }

    Q_REQUIRED_RESULT QDateTime retrieved() const { return m_retrieved; }

    Q_REQUIRED_RESULT QString summary() const;
 
 
 
    //
    // Methods
    //

    Q_REQUIRED_RESULT Units::Timespan age() const;

    Q_REQUIRED_RESULT NOTAMList cleaned(const QSet<QString>& cancelledNotamNumbers) const;

    Q_REQUIRED_RESULT bool isOutdated() const { auto _age = age(); return !_age.isFinite() || (_age > Units::Timespan::fromH(24)); }

    Q_REQUIRED_RESULT bool needsUpdate() const { auto _age = age(); return !_age.isFinite() || (_age > Units::Timespan::fromH(12)); }

    Q_REQUIRED_RESULT NOTAMList restricted(const GeoMaps::Waypoint& waypoint) const;

    static constexpr Units::Distance restrictionRadius = Units::Distance::fromNM(20.0);
 
private:
    /* List of Notams */
    QList<NOTAM> m_notams;
 
    /* Region */
    QGeoCircle m_region;
 
    /* Time of request */
    QDateTime m_retrieved;
};

QDataStream& operator<<(QDataStream& stream, const NOTAMList& notamList);

QDataStream& operator>>(QDataStream& stream, NOTAMList& notamList);
 
} // namespace NOTAM
 
 
// Declare meta types
Q_DECLARE_METATYPE(NOTAM::NOTAMList)