Leg.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 <QGeoPath>
#include <QQmlEngine>
 
#include "geomaps/Waypoint.h"
#include "navigation/Aircraft.h"
#include "positioning/PositionInfo.h"
#include "units/Angle.h"
#include "units/Units.h"
#include "weather/Wind.h"
 
namespace Navigation {

 
class Leg {
    Q_GADGET
    QML_VALUE_TYPE(leg)
 
public:
 
    //
    // Constructors and destructors
    //

    explicit Leg(GeoMaps::Waypoint  start, GeoMaps::Waypoint  end);
 
    // Default constructor
    explicit Leg() = default;
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(Units::Distance distance READ distance CONSTANT)
 
    
    Q_PROPERTY(GeoMaps::Waypoint endPoint READ endPoint CONSTANT)

    Q_PROPERTY(bool isValid READ isValid CONSTANT)

    Q_PROPERTY(Units::Distance nearThreshold MEMBER nearThreshold CONSTANT)

    Q_PROPERTY(GeoMaps::Waypoint startPoint READ startPoint CONSTANT)

    Q_PROPERTY(Units::Angle TC READ TC CONSTANT)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] auto distance() const -> Units::Distance;

    [[nodiscard]] auto endPoint()  const -> GeoMaps::Waypoint { return m_end; }

    [[nodiscard]] auto isValid() const -> bool;

    [[nodiscard]] auto startPoint()  const -> GeoMaps::Waypoint { return m_start; }

    [[nodiscard]] auto TC() const -> Units::Angle;
 
 
    //
    // Methods
    //

    [[nodiscard]] Q_INVOKABLE QString description(Weather::Wind wind, const Navigation::Aircraft& aircraft) const;

    [[nodiscard]] Q_INVOKABLE Units::Timespan ETE(Weather::Wind wind, const Navigation::Aircraft& aircraft) const
    {
        return distance()/GS(wind, aircraft);
    }

    [[nodiscard]] Q_INVOKABLE Units::Volume Fuel(Weather::Wind wind, const Navigation::Aircraft& aircraft) const;

    [[nodiscard]] Q_INVOKABLE Units::Speed GS(Weather::Wind wind, const Navigation::Aircraft& aircraft) const;

    [[nodiscard]] Q_INVOKABLE bool isFollowing(const Positioning::PositionInfo& positionInfo) const;

    [[nodiscard]] Q_INVOKABLE bool isNear(const Positioning::PositionInfo& positionInfo) const;

    [[nodiscard]] Q_INVOKABLE Units::Angle TH(Weather::Wind wind, const Navigation::Aircraft& aircraft) const
    {
        return TC()+WCA(wind, aircraft);
    }

    [[nodiscard]] Q_INVOKABLE Units::Angle WCA(Weather::Wind wind, const Navigation::Aircraft& aircraft) const;
 
 
    //
    // Members and constants
    //
 
    // Width of the leg. A position is considered near the leg if the distance is less.
    static constexpr Units::Distance nearThreshold = Units::Distance::fromNM(5.0);
 
private:
    // Necessary data for computation of wind triangle?
    [[nodiscard]] static auto hasDataForWindTriangle(Weather::Wind wind, const Navigation::Aircraft& aircraft) -> bool;
 
    // Minimum length of the leg in meters. If shorter, no courses are computed.
    static constexpr Units::Distance minLegLength = Units::Distance::fromM(100.0);
 
    GeoMaps::Waypoint m_start;
    GeoMaps::Waypoint m_end;
    QGeoPath m_geoPath;
};
 
} // namespace Navigation
 
// Declare meta types
Q_DECLARE_METATYPE(Navigation::Leg)