METAR.h

/***************************************************************************
 *   Copyright (C) 2019-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 <QCoreApplication>
#include <QDataStream>
#include <QGeoCoordinate>
#include <QXmlStreamReader>
 
#include "navigation/Aircraft.h"
#include "units/Distance.h"
#include "units/Pressure.h"
#include "units/Speed.h"
#include "units/Temperature.h"
#include "weather/Decoder.h"
 
namespace Weather {
 
class WeatherDataProvider;

 
class METAR {
    Q_DECLARE_TR_FUNCTIONS(Weather::METAR)
    Q_GADGET
    QML_VALUE_TYPE(metar)
 
    friend QDataStream& operator<<(QDataStream& stream, const METAR& metar);
    friend QDataStream& operator>>(QDataStream& stream, METAR& metar);
 
public:
    enum FlightCategory : quint8
    {
        VFR,     
        MVFR,    
        IFR,     
        LIFR,    
        unknown  
    };
    Q_ENUM(FlightCategory)
 
 
 
    //
    // Constructors and destructors
    //
 
    
    METAR() = default;

    explicit METAR(QXmlStreamReader& xml);

    ~METAR() = default;

    METAR(const METAR&) = default;

    METAR(METAR&&) = default;

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

    METAR& operator=(METAR&&) = default;

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

    Q_PROPERTY(QGeoCoordinate coordinate READ coordinate CONSTANT)

    Q_PROPERTY(QDateTime expiration READ expiration CONSTANT)

    Q_PROPERTY(QString flightCategoryColor READ flightCategoryColor CONSTANT)

    Q_PROPERTY(FlightCategory flightCategory READ flightCategory CONSTANT)

    Q_PROPERTY(QString ICAOCode READ ICAOCode CONSTANT)

    Q_PROPERTY(bool isValid READ isValid CONSTANT)

    Q_PROPERTY(QDateTime observationTime READ observationTime CONSTANT)

    Q_PROPERTY(Units::Pressure QNH READ QNH CONSTANT)

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

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

    [[nodiscard]] QDateTime expiration() const;

    [[nodiscard]] QString flightCategoryColor() const;

    [[nodiscard]] FlightCategory flightCategory() const
    {
        return m_flightCategory;
    }

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

    [[nodiscard]] bool isValid() const;

    [[nodiscard]] QDateTime observationTime() const
    {
        return m_observationTime;
    }

    [[nodiscard]] Units::Pressure QNH() const
    {
        return m_qnh;
    }

    [[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);
    }

    [[nodiscard]] Q_INVOKABLE QString derivedData(const Navigation::Aircraft& aircraft, bool showPerformanceWarning, bool explainPerformanceWarning) const;

    [[nodiscard]] Q_INVOKABLE QString summary(const Navigation::Aircraft& aircraft, const QDateTime& currentTime) const;
 
 
private:
    // Flight category, as returned by the Aviation Weather Center
    FlightCategory m_flightCategory {unknown};
 
    // Gust speed, as returned by the Aviation Weather Center
    Units::Speed m_gust;
 
    // Station ID, as returned by the Aviation Weather Center
    QString m_ICAOCode;
 
    // Station coordinate, as returned by the Aviation Weather Center
    QGeoCoordinate m_location;
 
    // Observation time, as returned by the Aviation Weather Center
    QDateTime m_observationTime;
 
    // QNH in hPa, as returned by the Aviation Weather Center
    Units::Pressure m_qnh;
 
    // Raw METAR text, as returned by the Aviation Weather Center
    QString m_rawText;
 
    // Wind speed, as returned by the Aviation Weather Center
    Units::Speed m_wind;
 
    // Temperature, as returned by the Aviation Weather Center
    Units::Temperature m_temperature;
 
    // Dewpoint, as returned by the Aviation Weather Center
    Units::Temperature m_dewpoint;
 
    // Density altitude, derived data
    Units::Distance m_densityAltitude;
 
    // Decoder
    QSharedPointer<Weather::Decoder> m_decoder;
};

QDataStream& operator<<(QDataStream& outstream, const METAR& metar);

QDataStream& operator>>(QDataStream& instream, METAR& metar);
 
} // namespace Weather