NOTAM.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 <QDateTime>
#include <QGeoCircle>
#include <QQmlEngine>
 
#include "units/Distance.h"
 
namespace NOTAM {

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

    explicit NOTAM(const QJsonObject& jsonObject);
 
 
    //
    // Properties
    //

    Q_PROPERTY(QString affectedFIR READ affectedFIR CONSTANT)

    Q_PROPERTY(QString cancels READ cancels CONSTANT)

    Q_PROPERTY(QGeoCoordinate coordinate READ coordinate CONSTANT)

    Q_PROPERTY(QDateTime effectiveEnd READ effectiveEnd CONSTANT)

    Q_PROPERTY(QDateTime effectiveStart READ effectiveStart CONSTANT)

    Q_PROPERTY(QJsonObject GeoJSON READ GeoJSON CONSTANT)

    Q_PROPERTY(QString icaoLocation READ icaoLocation CONSTANT)

    Q_PROPERTY(bool isValid READ isValid CONSTANT)

    Q_PROPERTY(QString number READ number CONSTANT)

    Q_PROPERTY(QGeoCircle region READ region CONSTANT)

    Q_PROPERTY(QString sectionTitle MEMBER m_sectionTitle)

    Q_PROPERTY(QString text READ text CONSTANT)

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

    Q_REQUIRED_RESULT QString affectedFIR() const { return m_affectedFIR; }

    Q_REQUIRED_RESULT QString cancels() const;

    Q_REQUIRED_RESULT QGeoCoordinate coordinate() const { return m_coordinate; }

    Q_REQUIRED_RESULT QDateTime effectiveEnd() const { return m_effectiveEnd; }

    Q_REQUIRED_RESULT QDateTime effectiveStart() const { return m_effectiveStart; }

    Q_REQUIRED_RESULT QJsonObject GeoJSON() const;

    Q_REQUIRED_RESULT QString icaoLocation() const { return m_icaoLocation; }

    Q_REQUIRED_RESULT bool isValid() const;

    Q_REQUIRED_RESULT QString number() const { return m_number; }

    Q_REQUIRED_RESULT QGeoCircle region() const { return m_region; }

    Q_REQUIRED_RESULT QString text() const { return m_text; }

    Q_REQUIRED_RESULT QString traffic() const { return m_traffic; }
 
 
 
    //
    // Methods
    //

    Q_REQUIRED_RESULT QString category() const;

    Q_REQUIRED_RESULT [[nodiscard]] Q_INVOKABLE bool operator==(const NOTAM& rhs) const = default;

    Q_REQUIRED_RESULT bool isOutdated() const
    {
        return m_effectiveEnd.isValid() && (m_effectiveEnd < QDateTime::currentDateTimeUtc());
    }

    Q_REQUIRED_RESULT Q_INVOKABLE QString richText(bool expandAbbreviations, const QDateTime& now) const;

    void updateSectionTitle();
 
private:
    /* NOTAM members, as described by the FAA */
    QString         m_affectedFIR;
    QGeoCoordinate  m_coordinate;
    QString         m_effectiveEndString;
    QString         m_effectiveStartString;
    QString         m_icaoLocation;
    QString         m_maximumFL;
    QString         m_minimumFL;
    QString         m_number;
    Units::Distance m_radius;
    QString         m_sectionTitle;
    QString         m_schedule;
    QString         m_selectionCode;
    QString         m_text;
    QString         m_traffic;
 
    /* Derivative data, obtained from the FAA notam members above */
    QDateTime       m_effectiveEnd;
    QDateTime       m_effectiveStart;
    QGeoCircle      m_region;
};
 

QGeoCoordinate interpretNOTAMCoordinates(const QString& string);

QDataStream& operator<<(QDataStream& stream, const NOTAM& notam);

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