Distance.h

/***************************************************************************
 *   Copyright (C) 2019-2023 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 <QObject>
#include <QQmlEngine>
#include <QtMath>
 
 
namespace Units {

    class Distance {
        Q_GADGET
        QML_VALUE_TYPE(distance)
 
    public:
        enum DistanceUnit : quint8 {
            Feet,
            Meter,
            Kilometer,
            StatuteMile,
            NauticalMile,
        };
        Q_ENUM(DistanceUnit)
 
        
        Q_INVOKABLE static constexpr Units::Distance fromM(double distanceInM)
        {
            Distance result;
            result.m_distanceInM = distanceInM;
            return result;
        }

        Q_INVOKABLE static constexpr Units::Distance fromKM(double distanceInKM)
        {
            Distance result;
            result.m_distanceInM = 1000.0*distanceInKM;
            return result;
        }

        Q_INVOKABLE static constexpr Units::Distance fromNM(double distanceInNM)
        {
            Distance result;
            result.m_distanceInM = distanceInNM*MetersPerNauticalMile;
            return result;
        }

        Q_INVOKABLE static constexpr Units::Distance fromMIL(double distanceInMIL)
        {
            Distance result;
            result.m_distanceInM = distanceInMIL*MetersPerMile;
            return result;
        }

        Q_INVOKABLE static constexpr Units::Distance fromFT(double distanceInFT)
        {
            Distance result;
            result.m_distanceInM = distanceInFT * MetersPerFeet;
            return result;
        }

        Q_INVOKABLE static constexpr Units::Distance nan()
        {
            return {};
        }

        Q_INVOKABLE Units::Distance& operator+=(Units::Distance other)
        {
            m_distanceInM += other.m_distanceInM;
            return *this;
        }

        [[nodiscard]] Q_INVOKABLE bool isFinite() const
        {
            return std::isfinite(m_distanceInM);
        }

        [[nodiscard]] Q_INVOKABLE bool isNegative() const
        {
            return m_distanceInM < 0.0;
        }

        [[nodiscard]] Q_INVOKABLE Units::Distance operator+(Units::Distance rhs) const
        {
            return fromM(m_distanceInM + rhs.m_distanceInM);
        }

        [[nodiscard]] Q_INVOKABLE Units::Distance operator-(Units::Distance rhs) const
        {
            return fromM(m_distanceInM - rhs.m_distanceInM);
        }

        [[nodiscard]] Q_INVOKABLE Units::Distance subtract(Units::Distance rhs) const
        {
            return fromM(m_distanceInM - rhs.m_distanceInM);
        }

        [[nodiscard]] Q_INVOKABLE double operator/(Units::Distance rhs) const
        {
            return m_distanceInM / rhs.m_distanceInM;
        }

        [[nodiscard]] Q_INVOKABLE Units::Distance operator*(double factor) const
        {
            return fromM(m_distanceInM*factor);
        }

        [[nodiscard]] Q_INVOKABLE std::partial_ordering operator<=>(const Units::Distance& rhs) const = default;

        [[nodiscard]] Q_INVOKABLE double toFeet() const
        {
            return m_distanceInM / MetersPerFeet;
        }

        [[nodiscard]] Q_INVOKABLE double toKM() const
        {
            return m_distanceInM / 1000.;
        }

        [[nodiscard]] Q_INVOKABLE double toM() const
        {
            return m_distanceInM;
        }

        [[nodiscard]] Q_INVOKABLE double toMIL() const
        {
            return m_distanceInM / MetersPerMile;
        }

        [[nodiscard]] Q_INVOKABLE double toNM() const
        {
            return m_distanceInM / MetersPerNauticalMile;
        }

        [[nodiscard]] Q_INVOKABLE QString toString(Units::Distance::DistanceUnit units, bool roundBigNumbers=false, bool forceSign=false) const;
 
    private:
        static constexpr double MetersPerFeet = 0.3048;
        static constexpr double MetersPerNauticalMile = 1852;
        static constexpr double MetersPerMile = 1609.344;
 
        // Speed in meters per second
        double m_distanceInM{ NAN };
    };
} // namespace Units

[[nodiscard]] Q_INVOKABLE inline Units::Distance operator*(double factor, const Units::Distance self)
{
    return self*factor;
}

QDataStream& operator<<(QDataStream& stream, const Units::Distance& distance);

QDataStream& operator>>(QDataStream& stream, Units::Distance& distance);
 
// Declare meta types
Q_DECLARE_METATYPE(Units::Distance)
Q_DECLARE_TYPEINFO(Units::Distance, Q_PRIMITIVE_TYPE);