TimeSpan.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: TimeSpan
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Time.h>
#include <NDEVR/LibAssert.h>
#include <NDEVR/ObjectInfo.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Stores a time span, or difference between two times, with an optional start time. 
    
    Note: timespans can be negative to represent times in the past from an optional start time or positive
    to represent a time in the future from a given start time.
    **/
    class TimeSpan
    {
    public:
        constexpr TimeSpan()
            : m_start_time(Constant<Time>::Invalid)
            , m_elapsed_time(Constant<sint08>::Invalid)
        {}
        constexpr explicit TimeSpan(sint04 elapsed_nano_seconds)
            : m_start_time(Constant<Time>::Invalid)
            , m_elapsed_time(elapsed_nano_seconds)
        {}
        constexpr explicit TimeSpan(const sint08 elapsed_nano_seconds)
            : m_start_time(Constant<Time>::Invalid)
            , m_elapsed_time(elapsed_nano_seconds)
        {}
        constexpr explicit TimeSpan(uint04 elapsed_nano_seconds)
            : m_start_time(Constant<Time>::Invalid)
            , m_elapsed_time(cast<sint08>(elapsed_nano_seconds))
        {}
        constexpr explicit TimeSpan(const uint08 elapsed_nano_seconds)
            : m_start_time(Constant<Time>::Invalid)
            , m_elapsed_time(cast<sint08>(elapsed_nano_seconds))
        {}
        constexpr explicit TimeSpan(const fltp08 elapsed_seconds)
            : m_start_time(Constant<Time>::Invalid)
            , m_elapsed_time(cast<sint08>(elapsed_seconds * Time::SECOND))
        {}
        TimeSpan(const Time& start, const Time& end)
            : m_start_time(start)
            , m_elapsed_time(cast<sint08>(end.getNanoSeconds()) - cast<sint08>(start.getNanoSeconds()))
        {
        }
        constexpr TimeSpan(const Time& start, const sint08& elapsed_nano_seconds)
            : m_start_time(start)
            , m_elapsed_time(elapsed_nano_seconds)
        {}
 
        constexpr TimeSpan(const Time& start, const fltp08& elapsed_seconds)
            : m_start_time(start)
            , m_elapsed_time(cast<sint08>(elapsed_seconds* Time::SECOND))
        {}
 
        NDEVR_BASE_API fltp08 elapsedPercent(Time time, bool clip_time) const;
        NDEVR_BASE_API String getTimeString(const String& format_string) const;
 
        [[nodiscard]] constexpr Time startTime() const
        {
            return m_start_time;
        }
        constexpr void setStartTime(Time time)
        {
            m_start_time = time;
        }
        constexpr void setEndTime(Time time)
        {
            m_elapsed_time = (time.getNanoSeconds() - m_start_time.getNanoSeconds());
        }
        NDEVR_BASE_API bool contains(const Time& time) const;
 
        [[nodiscard]] NDEVR_BASE_API Time endTime() const;
 
        [[nodiscard]] constexpr sint08 elapsedNanoseconds() const
        {
            return m_elapsed_time;
        }
 
        [[nodiscard]] constexpr fltp08 elapsedSeconds() const
        {
            if (IsInvalid(m_elapsed_time))
                return Constant<fltp08>::Invalid;
            return cast<fltp08>(m_elapsed_time) / cast<fltp08>(Time::SECOND);
        }
 
        template<class t_type = fltp08>
        [[nodiscard]] constexpr t_type elapsedMilliseconds() const
        {
            if (IsInvalid(m_elapsed_time))
                return Constant<fltp08>::Invalid;
            return cast<t_type>(m_elapsed_time) / cast<t_type>(Time::MILLISECOND);
        }
 
        [[nodiscard]] constexpr fltp08 elapsedMinutes() const
        {
            if (IsInvalid(m_elapsed_time))
                return Constant<fltp08>::Invalid;
            return cast<fltp08>(m_elapsed_time) / cast<fltp08>(Time::MINUTE);
        }
        NDEVR_BASE_API sint08 elapsedDays() const;
        NDEVR_BASE_API sint08 elapsedMonths() const;
        constexpr bool operator==(const TimeSpan& time) const
        {
            return m_elapsed_time == time.m_elapsed_time;
        }
        constexpr bool operator!=(const TimeSpan& time) const
        {
            return m_elapsed_time != time.m_elapsed_time;
        }
        constexpr bool operator>(const TimeSpan& other) const
        {
            return m_elapsed_time > other.m_elapsed_time;
        }
        constexpr bool operator>=(const TimeSpan& other) const
        {
            return m_elapsed_time >= other.m_elapsed_time;
        }
        constexpr bool operator<(const TimeSpan& other) const
        {
            return m_elapsed_time < other.m_elapsed_time;
        }
        constexpr bool operator<=(const TimeSpan& other) const
        {
            return m_elapsed_time <= other.m_elapsed_time;
        }
 
        constexpr fltp08 operator/(const TimeSpan& time_2) const
        {
            return cast<fltp08>(m_elapsed_time) / cast<fltp08>(time_2.m_elapsed_time);
        }
        constexpr TimeSpan operator/(const sint08& den) const
        {
            return TimeSpan(m_start_time, m_elapsed_time / den);
        }
        constexpr TimeSpan operator/(const fltp08& den) const
        {
            return TimeSpan(m_start_time, cast<sint08>(cast<fltp08>(m_elapsed_time) / den));
        }
 
        constexpr TimeSpan operator*(const sint08& mult) const
        {
            return TimeSpan(m_start_time, m_elapsed_time * mult);
        }
        constexpr TimeSpan operator*(const fltp08& mult) const
        {
            return TimeSpan(m_start_time, cast<sint08>(cast<fltp08>(m_elapsed_time) * mult));
        }
        constexpr TimeSpan& operator*=(const sint08& mult)
        {
            m_elapsed_time = cast<sint08>(cast<fltp08>(m_elapsed_time) * mult);
            return *this;
        }
        constexpr TimeSpan& operator*=(const fltp08& mult)
        {
            m_elapsed_time = cast<sint08>(cast<fltp08>(m_elapsed_time) * mult);
            return *this;
        }
        constexpr TimeSpan operator+(const TimeSpan& other) const
        {
            return TimeSpan(m_elapsed_time + other.m_elapsed_time);
        }
        constexpr TimeSpan& operator+=(const TimeSpan& other)
        {
            m_elapsed_time = m_elapsed_time + other.m_elapsed_time;
            return *this;
        }
        constexpr TimeSpan operator-(const TimeSpan& other) const
        {
            return TimeSpan(m_elapsed_time - other.m_elapsed_time);
        }
        constexpr TimeSpan operator-() const
        {
            return TimeSpan(-m_elapsed_time);
        }
        constexpr TimeSpan& operator-=(const TimeSpan& other)
        {
            m_elapsed_time = m_elapsed_time - other.m_elapsed_time;
            return *this;
        }
    protected:
        Time m_start_time;
        sint08 m_elapsed_time;
    };
 
    /**--------------------------------------------------------------------------------------------------
    Struct: ObjectInfo<TimeSpan>
 
    Information about the object.
 
    Author: Tyler Parke
 
    Date: 2020-09-13
    **/
    template<>
    struct ObjectInfo<TimeSpan, false, false>
    {
        static const uint01 Dimensions = 0;
        static const bool Vector = false;
        static const bool Primitive = true;
        static const bool Pointer = false;
        static const bool Unsigned = false;
        static const bool Float = true;
        static const bool Integer = false;
        static const bool Number = true;
        static const bool String = false;
        static const bool Color = false;
        static const bool Buffer = false;
        static const bool Boolean = false;
        static constexpr ObjectInfo<TimeSpan, false, false> VectorSub() { return ObjectInfo<TimeSpan, false, false>(); }
    };
    NDEVR_BASE_API TimeSpan operator-(const Time& time, const Time& value);
 
    NDEVR_BASE_API Time operator+(const Time& time, const TimeSpan& value);
    NDEVR_BASE_API Time operator-(const Time& time, const TimeSpan& value);
    NDEVR_BASE_API Time& operator+=(Time& time, const TimeSpan& value);
    NDEVR_BASE_API Time& operator-=(Time& time, const TimeSpan& value);
    constexpr TimeSpan abs(const TimeSpan& value)
    {
        return value >= TimeSpan(0) ? value : -value;
    }
    constexpr TimeSpan operator%(const Time& time, const TimeSpan& duration)
    {
        lib_assert(duration.elapsedNanoseconds() > 0, "Bad duration");
        sint08 nano = cast<sint08>(time.getNanoSeconds() % cast<uint08>(duration.elapsedNanoseconds()));
        return TimeSpan(Time(time.getNanoSeconds() - nano), nano);
    }
 
    
 
    template<> constexpr TimeSpan Constant<TimeSpan>::Invalid = TimeSpan(Constant<sint08>::Invalid);
    template<> constexpr TimeSpan Constant<TimeSpan>::Max = TimeSpan(Constant<sint08>::Max);
    template<> constexpr TimeSpan Constant<TimeSpan>::Min = TimeSpan(Constant<sint08>::Min);
}