Airspace.h

/***************************************************************************
 *   Copyright (C) 2019-2025 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 <QGeoPolygon>
#include <QJsonObject>
 
#include "units/Distance.h"
#include "units/Pressure.h"
 
namespace GeoMaps {

 
class Airspace {
    Q_GADGET

    friend auto operator==(const GeoMaps::Airspace&, const GeoMaps::Airspace&) -> bool;
 
public:
    Airspace() = default;

    explicit Airspace(const QJsonObject &geoJSONObject);

    [[nodiscard]] Units::Distance estimatedLowerBoundMSL(Units::Distance terrainElevation, Units::Pressure QNH, Units::Distance ownshipGeometricAltitude, Units::Distance ownshipBarometricAltitude) const;

    [[nodiscard]] Units::Distance estimatedUpperBoundMSL(Units::Distance terrainElevation, Units::Pressure QNH, Units::Distance ownshipGeometricAltitude, Units::Distance ownshipBarometricAltitude) const;

    Q_PROPERTY(bool isValid READ isValid CONSTANT)
 
    
    [[nodiscard]] auto isValid() const -> bool { return !m_polygon.isEmpty(); }

    Q_PROPERTY(QString lowerBound READ lowerBound CONSTANT)
 
    
    [[nodiscard]] auto lowerBound() const -> QString { return m_lowerBound; }

    Q_PROPERTY(QString lowerBoundMetric READ lowerBoundMetric CONSTANT)
 
    
    [[nodiscard]] auto lowerBoundMetric() const -> QString { return makeMetric(m_lowerBound); }
 
    /* \brief Name of the airspace, such as "ED-R 31" */
    Q_PROPERTY(QString name READ name CONSTANT)
 
    
    [[nodiscard]] auto name() const -> QString { return m_name; }

    Q_PROPERTY(QGeoPolygon polygon READ polygon CONSTANT)
 
    
    [[nodiscard]] auto polygon() const -> QGeoPolygon { return m_polygon; }
 
    /* \brief Category of the airspace
     *
     * A string with the category of the airspace, as described in the GeoJSON
     * file specification
     * [here](https://github.com/Akaflieg-Freiburg/enrouteServer/wiki/GeoJSON-files-used-in-enroute-flight-navigation).
     */
    Q_PROPERTY(QString CAT READ CAT CONSTANT)
 
    
    [[nodiscard]] auto CAT() const -> QString { return m_CAT; }

    Q_PROPERTY(QString upperBound READ upperBound CONSTANT)
 
    
    [[nodiscard]] auto upperBound() const -> QString { return m_upperBound; }

    Q_PROPERTY(QString upperBoundMetric READ upperBoundMetric CONSTANT)
 
    
    [[nodiscard]] auto upperBoundMetric() const -> QString { return makeMetric(m_upperBound); }
 
private:
    // Transforms a height string such as "4500", "1500 GND" or "FL 130" into a
    // string that describes the height in meters. If the height string cannot
    // be parsed, returns the original string
    [[nodiscard]] static auto makeMetric(const QString& standard) -> QString;
 
    // Function used by estimatedLowerBoundMSL() and estimatedUpperBoundMSL()
    [[nodiscard]] static Units::Distance estimateBoundMSL(const QString& boundString, Units::Distance terrainElevation, Units::Pressure QNH, Units::Distance ownshipGeometricAltitude, Units::Distance ownshipBarometricAltitude);
 
    QString m_name;
    QString m_CAT;
    QString m_upperBound;
    QString m_lowerBound;
    QGeoPolygon m_polygon;
};

auto operator==(const GeoMaps::Airspace&, const GeoMaps::Airspace&) -> bool;

auto qHash(const GeoMaps::Airspace& as) -> size_t;
 
} // namespace GeoMaps
 
 
// Declare meta types
Q_DECLARE_METATYPE(GeoMaps::Airspace)