Timespan.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 <QObject>
#include <QQmlEngine>
#include <QtMath>
 
 
namespace Units {

class Timespan {
        Q_GADGET
        QML_VALUE_TYPE(time)
 
    public:        
        static constexpr auto fromH(double timeInH) -> Timespan {
            Timespan result;
            result.m_timeInS = timeInH*Seconds_per_Hour;
            return result;
        }

        static constexpr Timespan fromMS(double timeInMS)
        {
            Timespan result;
            result.m_timeInS = timeInMS/1000.0;
            return result;
        }

        static constexpr auto fromS(double timeInS)
        {
            Timespan result;
            result.m_timeInS = timeInS;
            return result;
        }

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

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

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

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

        [[nodiscard]] Q_INVOKABLE double toS() const
        {
            return m_timeInS;
        }

        [[nodiscard]] Q_INVOKABLE double toM() const
        {
            return m_timeInS / Seconds_per_Minute;
        }

        [[nodiscard]] Q_INVOKABLE double toH() const
        {
            return m_timeInS / Seconds_per_Hour;
        }

        [[nodiscard]] Q_INVOKABLE QString toHoursAndMinutes() const;
 
    private:
        static constexpr double Seconds_per_Minute = 60.0;
        static constexpr double Seconds_per_Hour = 60.0 * 60.0;
 
        // Speed in meters per second
        double m_timeInS {NAN};
    };
} // namespace Units
 
 
// Declare meta types
Q_DECLARE_METATYPE(Units::Timespan)