TAF.h

/***************************************************************************
 *   Copyright (C) 2019-2022 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 <QDataStream>
#include <QGeoCoordinate>
#include <QXmlStreamReader>
 
#include "weather/Decoder.h"
 
 
namespace Weather {
 
class WeatherDataProvider;
 

 
class TAF {
    Q_GADGET
    QML_VALUE_TYPE(taf)
 
    friend QDataStream& operator<<(QDataStream& stream, const TAF& taf);
    friend QDataStream& operator>>(QDataStream& stream, Weather::TAF& taf);
 
public:
 
    //
    // Constructors and destructors
    //

    TAF() = default;

    explicit TAF(QXmlStreamReader& xml);

    ~TAF() = default;

    TAF(const TAF&) = default;

    TAF(TAF&&) = default;

 
    TAF& operator=(const TAF&) = default;

 
    TAF& operator=(TAF&&) = default;

    bool operator==(const TAF& other) const = default;
 
 
    //
    // Properties
    //

    Q_PROPERTY(QGeoCoordinate coordinate READ coordinate CONSTANT)

    Q_PROPERTY(QDateTime expiration READ expiration CONSTANT)

    Q_PROPERTY(QString ICAOCode READ ICAOCode CONSTANT)

    Q_PROPERTY(bool isValid READ isValid CONSTANT)

    Q_PROPERTY(QDateTime issueTime READ issueTime CONSTANT)

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

    [[nodiscard]] QGeoCoordinate coordinate() const
    {
        return m_location;
    }

    [[nodiscard]] QDateTime expiration() const
    {
        return m_expirationTime;
    }

    [[nodiscard]] QString ICAOCode() const
    {
        return m_ICAOCode;
    }

    [[nodiscard]] bool isValid() const;

    [[nodiscard]] QDateTime issueTime() const
    {
        return m_issueTime;
    }

    [[nodiscard]] QString rawText() const
    {
        return m_rawText;
    }
 
 
    //
    // Methods
    //

    [[nodiscard]] Q_INVOKABLE QString decodedText(const Navigation::Aircraft& act, const QDateTime& time)
    {
        // Paranoid safety checks
        if (m_decoder.isNull())
        {
            return {};
        }
 
        return m_decoder->decodedText(act, time);
    }
 
private:
    // Expiration time
    QDateTime m_expirationTime;
 
    // Station ID, as returned by the Aviation Weather Center
    QString m_ICAOCode;
 
    // Issue time, as returned by the Aviation Weather Center
    QDateTime m_issueTime;
 
    // Station coordinate, as returned by the Aviation Weather Center
    QGeoCoordinate m_location;
 
    // Raw TAF text, as returned by the Aviation Weather Center
    QString m_rawText;
 
    // Decoder
    QSharedPointer<Weather::Decoder> m_decoder;
};

QDataStream& operator<<(QDataStream& stream, const TAF& taf);
 

QDataStream& operator>>(QDataStream& stream, Weather::TAF& taf);
 
} // namespace Weather