Time.h

Go to the documentation of this file.

// Copyright Onix Solutions Limited [OnixS]. All rights reserved.
//
// This software owned by Onix Solutions Limited [OnixS] and is
// protected by copyright law and international copyright treaties.
//
// Access to and use of the software is governed by the terms of the applicable
// OnixS Software Services Agreement (the Agreement) and Customer end user license
// agreements granting a non-assignable, non-transferable and non-exclusive license
// to use the software for it's own data processing purposes under the terms defined
// in the Agreement.
//
// Except as otherwise granted within the terms of the Agreement, copying or
// reproduction of any part of this source code or associated reference material
// to any other location for further reproduction or redistribution, and any
// amendments to this copyright notice, are expressly prohibited.
//
// Any reproduction or redistribution for sale or hiring of the Software not in
// accordance with the terms of the Agreement is a violation of copyright law.
//
 
#pragma once
 
#include <OnixS/ICE/BOE/messaging/Utils.h>
#include <OnixS/ICE/BOE/messaging/Integral.h>
#include <OnixS/ICE/BOE/messaging/StrRef.h>
 
#include <stdexcept>
 
ONIXS_ICEBOE_MESSAGING_NAMESPACE_BEGIN

struct TimeTraits
{
    constexpr
    static Int64 nanosecondsPerDay() noexcept
    {
        return 86400000000000ll;
    }

    constexpr
    static Int64 nanosecondsPerHour() noexcept
    {
        return 3600000000000ll;
    }

    constexpr
    static Int64 nanosecondsPerMinute() noexcept
    {
        return 60000000000ll;
    }

    constexpr
    static Int32 nanosecondsPerSecond() noexcept
    {
        return 1000000000;
    }

    constexpr
    static Int32 nanosecondsPerMillisecond() noexcept
    {
        return 1000000;
    }

    constexpr
    static Int32 nanosecondsPerMicrosecond() noexcept
    {
        return 1000;
    }

    constexpr
    static Int32 hoursPerDay() noexcept
    {
        return 24;
    }

    constexpr
    static Int32 minutesPerHour() noexcept
    {
        return 60;
    }

    constexpr
    static Int32 secondsPerMinute() noexcept
    {
        return 60;
    }

    constexpr
    static Int32 millisecondsPerSecond() noexcept
    {
        return 1000;
    }

    constexpr
    static Int32 microsecondsPerSecond() noexcept
    {
        return 1000000;
    }
};

struct TimeSpanFormat
{
    enum Enum
    {
        HHMMSS,

        HHMMSSmsec,

        HHMMSSusec,

        HHMMSSnsec,

        HHMMSSpsec,

        SDHHMMSSnsec
    };
};

class TimeSpan
{
public:
    typedef Int64 Ticks;

    typedef Int32 Days;

    typedef Int32 Hours;

    typedef Int32 Minutes;

    typedef Int32 Seconds;

    typedef Int32 Milliseconds;

    typedef Int32 Microseconds;

    typedef Int32 Nanoseconds;

    ONIXS_ICEBOE_NODISCARD
    std::string toString(TimeSpanFormat::Enum = TimeSpanFormat::SDHHMMSSnsec) const;

    explicit constexpr TimeSpan(Ticks ticks = 0) noexcept
        : ticks_(ticks)
    {
    }

    TimeSpan(Days days, Hours hours, Minutes minutes, Seconds seconds, Nanoseconds nanoseconds) noexcept
        : ticks_(
            numericCast<Ticks>(days) *
            TimeTraits::nanosecondsPerDay() +
            numericCast<Ticks>(hours) *
            TimeTraits::nanosecondsPerHour() +
            numericCast<Ticks>(minutes) *
            TimeTraits::nanosecondsPerMinute() +
            numericCast<Ticks>(seconds) *
            TimeTraits::nanosecondsPerSecond() +
            nanoseconds)
    {
    }

    TimeSpan(Hours hours, Minutes minutes, Seconds seconds, Nanoseconds nanoseconds) noexcept
        : ticks_(
            numericCast<Ticks>(hours) *
            TimeTraits::nanosecondsPerHour() +
            numericCast<Ticks>(minutes) *
            TimeTraits::nanosecondsPerMinute() +
            numericCast<Ticks>(seconds) *
            TimeTraits::nanosecondsPerSecond() +
            nanoseconds)
    {
    }

    Days days() const noexcept
    {
        return
            numericCast<Days>
            (ticks_ /
                TimeTraits::nanosecondsPerDay());
    }

    Hours hours() const noexcept
    {
        return
            numericCast<Hours>(
                (ticks_ /
                    TimeTraits::nanosecondsPerHour()) %
                TimeTraits::hoursPerDay()
            );
    }

    Minutes minutes() const noexcept
    {
        return
            numericCast<Minutes>(
                (ticks_ /
                    TimeTraits::nanosecondsPerMinute()) %
                TimeTraits::minutesPerHour()
            );
    }

    Seconds seconds() const noexcept
    {
        return
            numericCast<Seconds>(
                (ticks_ /
                    TimeTraits::nanosecondsPerSecond()) %
                TimeTraits::secondsPerMinute()
            );
    }

    Milliseconds milliseconds() const noexcept
    {
        return
            numericCast<Milliseconds>
                ((ticks_ /
                    TimeTraits::nanosecondsPerMillisecond()) %
                TimeTraits::millisecondsPerSecond()
            );
    }

    Microseconds microseconds() const noexcept
    {
        return
            numericCast<Microseconds>
                ((ticks_ /
                    TimeTraits::nanosecondsPerMicrosecond()) %
                TimeTraits::microsecondsPerSecond()
            );
    }

    Nanoseconds nanoseconds() const noexcept
    {
        return
            numericCast<Nanoseconds>
            (ticks_ %
                TimeTraits::nanosecondsPerSecond());
    }

    Ticks ticks() const noexcept
    {
        return ticks_;
    }

    TimeSpan& operator+=(const TimeSpan& other) noexcept
    {
        ticks_ += other.ticks_;
 
        return *this;
    }

    TimeSpan& operator-=(const TimeSpan& other) noexcept
    {
        ticks_ -= other.ticks_;
 
        return *this;
    }

    void swap(TimeSpan & other) noexcept
    {
        std::swap(ticks_, other.ticks_);
    }

    static TimeSpan fromStr(const std::string&);
    static TimeSpan fromStr(StrRef);
 
private:
    Ticks ticks_;
};

ONIXS_ICEBOE_PURE
inline bool operator==(const TimeSpan& left, const TimeSpan& right) noexcept
{
    return left.ticks() == right.ticks();
}

ONIXS_ICEBOE_PURE
inline bool operator!=(const TimeSpan& left, const TimeSpan& right) noexcept
{
    return left.ticks() != right.ticks();
}

ONIXS_ICEBOE_PURE
inline bool operator<(const TimeSpan& left, const TimeSpan& right) noexcept
{
    return left.ticks() < right.ticks();
}

ONIXS_ICEBOE_PURE
inline bool operator>(const TimeSpan& left, const TimeSpan& right) noexcept
{
    return left.ticks() > right.ticks();
}

ONIXS_ICEBOE_PURE
inline TimeSpan operator - (const TimeSpan& timeSpan) noexcept
{
    return TimeSpan(-timeSpan.ticks());
}

ONIXS_ICEBOE_EXPORTED
void toStrAsHHMMSS(std::string&, TimeSpan);

ONIXS_ICEBOE_EXPORTED
void toStrAsHHMMSSmsec(std::string&, TimeSpan);

ONIXS_ICEBOE_EXPORTED
void toStrAsHHMMSSusec(std::string&, TimeSpan);

ONIXS_ICEBOE_EXPORTED
void toStrAsHHMMSSnsec(std::string&, TimeSpan);

ONIXS_ICEBOE_EXPORTED
void toStrAsHHMMSSpsec(std::string&, TimeSpan);

ONIXS_ICEBOE_EXPORTED
void toStrAsSDHHMMSSnsec(std::string&, TimeSpan);

ONIXS_ICEBOE_EXPORTED
void toStr(std::string&, TimeSpan, TimeSpanFormat::Enum = TimeSpanFormat::SDHHMMSSnsec);

inline
std::string toStr(TimeSpan timeSpan, TimeSpanFormat::Enum format = TimeSpanFormat::SDHHMMSSnsec)
{
    std::string str;
 
    toStr(str, timeSpan, format);
 
    return str;
}

struct Month
{
    enum Enum
    {
        January = 1,
        February,
        March,
        April,
        May,
        June,
        July,
        August,
        September,
        October,
        November,
        December
    };
};

struct TimestampFormat
{
    enum Enum
    {
        YYYYMMDD,

        YYYYMMDDHHMMSS,

        YYYYMMDDHHMMSSmsec,

        YYYYMMDDHHMMSSusec,

        YYYYMMDDHHMMSSnsec,

        YYYYMMDDHHMMSSpsec
    };
};

class Timestamp
{
public:
    typedef UInt64 Ticks;

    typedef UInt32 Year;

    typedef ONIXS_ICEBOE_MESSAGING_NAMESPACE::Month::Enum Month;

    typedef UInt32 Day;

    typedef UInt32 Hour;

    typedef UInt32 Minute;

    typedef UInt32 Second;

    typedef UInt32 Millisecond;

    typedef UInt32 Microsecond;

    typedef UInt32 Nanosecond;

    ONIXS_ICEBOE_NODISCARD
    std::string toString(TimestampFormat::Enum = TimestampFormat::YYYYMMDDHHMMSSnsec) const;

    explicit constexpr Timestamp(Ticks ticks = 0) noexcept
        : sinceEpoch_(ticks)
    {
    }

    Timestamp(
        Year year,
        Month month,
        Day day,
        Hour hour = 0,
        Minute minute = 0,
        Second second = 0,
        Nanosecond nanosecond = 0)
        : sinceEpoch_(
            toTicks(
                year, month, day,
                hour, minute, second, nanosecond)
        )
    {
    }
 
    Timestamp(const Timestamp& other) noexcept
        : sinceEpoch_(other.sinceEpoch_)
    {
    }

    Year year() const
    {
        Year year; Month month; Day day;
 
        toDate(sinceEpoch_, year, month, day);
 
        return year;
    }

    Month month() const
    {
        Year year; Month month; Day day;
 
        toDate(sinceEpoch_, year, month, day);
 
        return month;
    }

    Day day() const
    {
        Year year; Month month; Day day;
 
        toDate(sinceEpoch_, year, month, day);
 
        return day;
    }

    Hour hour() const noexcept
    {
        return static_cast<Hour>(time().hours());
    }

    Minute minute() const noexcept
    {
        return static_cast<Minute>(time().minutes());
    }

    Second second() const noexcept
    {
        return static_cast<Second>(time().seconds());
    }

    Millisecond millisecond() const noexcept
    {
        return static_cast<Millisecond>(time().milliseconds());
    }

    Microsecond microsecond() const noexcept
    {
        return static_cast<Microsecond>(time().microseconds());
    }

    Nanosecond nanosecond() const noexcept
    {
        return static_cast<Nanosecond>(time().nanoseconds());
    }

    Timestamp date() const noexcept
    {
        return
            Timestamp(
                sinceEpoch_ -
                    sinceEpoch_ %
                    TimeTraits::nanosecondsPerDay());
    }

    TimeSpan time() const noexcept
    {
        return
            TimeSpan(
                sinceEpoch_ %
                TimeTraits::nanosecondsPerDay());
    }

    Ticks sinceEpoch() const noexcept
    {
        return sinceEpoch_;
    }
 
    Timestamp& operator=(const Timestamp& other) noexcept
    {
        sinceEpoch_ = other.sinceEpoch_;
 
        return *this;
    }

    void swap(Timestamp & other) noexcept
    {
        std::swap(sinceEpoch_, other.sinceEpoch_);
    }

    static Timestamp fromStr(const std::string&, TimestampFormat::Enum = TimestampFormat::YYYYMMDDHHMMSSnsec);
    static Timestamp fromStr(StrRef, TimestampFormat::Enum = TimestampFormat::YYYYMMDDHHMMSSnsec);
 
private:
    Ticks sinceEpoch_;

    ONIXS_ICEBOE_EXPORTED
    static Ticks toTicks(Year, Month, Day, Hour, Minute, Second, Nanosecond);
 
    // Extracts the ddate components from ticks.
    ONIXS_ICEBOE_EXPORTED
    static void toDate(Ticks, Year&, Month&, Day&);
};

ONIXS_ICEBOE_PURE
inline Timestamp makeTimestamp(Timestamp::Ticks ticks) noexcept
{
    return Timestamp(ticks);
}

ONIXS_ICEBOE_PURE
inline bool operator==(const Timestamp& left, const Timestamp& right) noexcept
{
    return (
        left.sinceEpoch() ==
        right.sinceEpoch()
    );
}

ONIXS_ICEBOE_PURE
inline bool operator!=(const Timestamp& left, const Timestamp& right) noexcept
{
    return (
        left.sinceEpoch() !=
        right.sinceEpoch()
    );
}

ONIXS_ICEBOE_PURE
inline bool operator<(const Timestamp& left, const Timestamp& right) noexcept
{
    return (
        left.sinceEpoch() <
        right.sinceEpoch()
    );
}

ONIXS_ICEBOE_PURE
inline bool operator<=(const Timestamp& left, const Timestamp& right) noexcept
{
    return (
        left.sinceEpoch() <=
        right.sinceEpoch()
    );
}

ONIXS_ICEBOE_PURE
inline bool operator>(const Timestamp& left, const Timestamp& right) noexcept
{
    return (
        left.sinceEpoch() >
        right.sinceEpoch()
    );
}

ONIXS_ICEBOE_PURE
inline bool operator>=(const Timestamp& left, const Timestamp& right) noexcept
{
    return (
        left.sinceEpoch() >=
        right.sinceEpoch()
    );
}

ONIXS_ICEBOE_PURE
inline Timestamp operator +(const Timestamp& timestamp, const TimeSpan& timeSpan) noexcept
{
    return
        Timestamp(
            timestamp.sinceEpoch() +
            timeSpan.ticks()
        );
}

ONIXS_ICEBOE_PURE
inline Timestamp operator -(const Timestamp& timestamp, const TimeSpan& timeSpan) noexcept
{
    return
        Timestamp(
            timestamp.sinceEpoch() -
            timeSpan.ticks()
        );
}

ONIXS_ICEBOE_PURE
inline TimeSpan operator -(const Timestamp& left, const Timestamp& right) noexcept
{
    return TimeSpan(left.sinceEpoch() - right.sinceEpoch());
}

ONIXS_ICEBOE_EXPORTED
void toStrAsYYYYMMDD(std::string&, Timestamp);

ONIXS_ICEBOE_EXPORTED
void toStrAsYYYYMMDDHHMMSS(std::string&, Timestamp
);

ONIXS_ICEBOE_EXPORTED
void toStrAsYYYYMMDDHHMMSSmsec(std::string&, Timestamp);

ONIXS_ICEBOE_EXPORTED
void toStrAsYYYYMMDDHHMMSSusec(std::string&, Timestamp);

ONIXS_ICEBOE_EXPORTED
void toStrAsYYYYMMDDHHMMSSnsec(std::string&, Timestamp);

ONIXS_ICEBOE_EXPORTED
void toStrAsYYYYMMDDHHMMSSpsec(std::string&, Timestamp);

ONIXS_ICEBOE_EXPORTED
void toStr(std::string&, Timestamp, TimestampFormat::Enum = TimestampFormat::YYYYMMDDHHMMSSnsec);

inline ONIXS_ICEBOE_NODISCARD
std::string toStr(Timestamp timestamp, TimestampFormat::Enum format = TimestampFormat::YYYYMMDDHHMMSSnsec)
{
    std::string str;
 
    toStr(str, timestamp, format);
 
    return str;
}

ONIXS_ICEBOE_EXPORTED
size_t toStr(Timestamp, Char*, size_t);
 
inline std::ostream & operator <<(std::ostream & os, const Timestamp& value)
{
    return os << toStr(value);
}
 
inline
std::ostream & operator <<(std::ostream & os, const TimeSpan& value)
{
    return os << toStr(value);
}

ONIXS_ICEBOE_EXPORTED
ONIXS_ICEBOE_NODISCARD
bool fromStr(TimeSpan&, const Char*, size_t);

inline ONIXS_ICEBOE_NODISCARD
bool fromStr(TimeSpan& ts, StrRef str)
{
    return fromStr(ts, str.data(), str.size());
}
 
inline ONIXS_ICEBOE_NODISCARD
bool fromStr(TimeSpan& ts, const std::string& str)
{
    return fromStr(ts, str.data(), str.size());
}

ONIXS_ICEBOE_EXPORTED
ONIXS_ICEBOE_NODISCARD
bool fromStr(Timestamp&, const Char*, size_t, TimestampFormat::Enum = TimestampFormat::YYYYMMDDHHMMSSnsec);

inline ONIXS_ICEBOE_NODISCARD
bool fromStr(Timestamp& ts, const std::string& str, TimestampFormat::Enum format = TimestampFormat::YYYYMMDDHHMMSSnsec)
{
    return fromStr(ts, str.data(), str.size(), format);
}

inline ONIXS_ICEBOE_NODISCARD
bool fromStr(Timestamp& ts, StrRef str, TimestampFormat::Enum format = TimestampFormat::YYYYMMDDHHMMSSnsec)
{
    return fromStr(ts, str.data(), str.size(), format);
}
 
inline
Timestamp Timestamp::fromStr(const std::string& str, TimestampFormat::Enum format)
{
    return fromStr(StrRef{str}, format);
}
 
inline Timestamp Timestamp::fromStr(StrRef str, TimestampFormat::Enum format)
{
    Timestamp ts;
 
    const bool result = Messaging::fromStr(ts, str, format);
 
    if(!result)
        throw std::runtime_error("Error parsing Timestamp, invalid value: '" + toStr(str) + "'.");
 
    return ts;
}
 
inline
TimeSpan TimeSpan::fromStr(const std::string& str)
{
    return fromStr(StrRef{str});;
}
 
inline
TimeSpan TimeSpan::fromStr(StrRef str)
{
    TimeSpan ts;
 
    const bool result = Messaging::fromStr(ts, str);
 
    if(!result)
        throw std::runtime_error("Error parsing TimeSpan, invalid value: '" + toStr(str) + "'.");
 
    return ts;
}
 
 
inline
std::string TimeSpan::toString(TimeSpanFormat::Enum format) const
{
    return toStr(*this, format);
}
 
inline
std::string Timestamp::toString(TimestampFormat::Enum format) const
{
    return toStr(*this, format);
}
 
ONIXS_ICEBOE_MESSAGING_NAMESPACE_END