TimeSpan.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 <string>

#include <OnixS/eSpeed/MarketData/Itch/ABI.h>
#include <OnixS/eSpeed/MarketData/Itch/Bootstrap.h>


ONIXS_ESPEED_ITCH_NAMESPACE_BEGIN

/// Time span formats supported.
struct ONIXS_ESPEED_ITCH_API TimeSpanFormats
{
    enum Enum
    {
        /// HH:MM:SS.
        HHMMSS,

        /// HH:MM:SS.sss.
        HHMMSSmsec,

        /// HH:MM:SS.sssssssss.
        SDHHMMSSnsec
    };
};

/// Time span format.
typedef TimeSpanFormats::Enum TimeSpanFormat;

/// Represents time interval. Used primarily to
/// present time-only stamps and to measure time
/// intervals between two timestamps.
class ONIXS_ESPEED_ITCH_API TimeSpan
{
    public:
        /// Initializes zero span.
        TimeSpan();

        /// Initializes with given set of values.
        /// Input parameters are treated as quantities,
        /// but not as a time stamp. Therefore, there's
        /// no requirement to fit in a certain range like
        /// hours must fit into [0, 24) range. After
        /// initialization time span will be normalized.
        TimeSpan (int hours, int minutes, int seconds, int nanoseconds = 0);

        /// Initializes with given set of values.
        /// Input parameters are treated as quantities,
        /// but not as a time stamp. Therefore, there's
        /// no requirement to fit in a certain range like
        /// hours must fit into [0, 24) range. After
        /// initialization time span will be normalized.
        TimeSpan (int days, int hours, int minutes, int seconds, int nanoseconds);

        /// Initializes time interval from total number
        /// seconds and its fractional (nanosecond) part.
        TimeSpan (long long totalSeconds, int nanoseconds);

        /// Initializes as clone of other instance.
        TimeSpan (const TimeSpan& other);

        /// Whole number of seconds in time interval.
        long long totalSeconds() const;

        /// Days component of time interval.
        /// Whole number of days in time interval.
        int days() const;

        /// Hours component of time interval.
        /// Values are in range from -23 through 23.
        int hours() const;

        /// Minutes component of time interval.
        /// Values are in range from -59 through 59.
        int minutes() const;

        /// Seconds component of time interval.
        /// Values are in range from -59 through 59.
        int seconds() const;

        /// Milliseconds component of time interval.
        /// Values are in range from -999 through 999.
        int milliseconds() const;

        /// Microseconds component of time interval.
        /// Values are in range from -999999 through 999999.
        int microseconds() const;

        /// Nanoseconds component of time interval.
        /// Values are in range from -999999999 through 999999999.
        int nanoseconds() const;

        /// Compares with other instance for equality.
        bool operator == (const TimeSpan& other) const;

        /// Compares with other instance for in-equality.
        bool operator != (const TimeSpan& other) const;

        /// Checks whether time interval less than other one.
        bool operator < (const TimeSpan& other) const;

        /// Checks whether time interval greater than other one.
        bool operator > (const TimeSpan& other) const;

        /// Adds time interval to current one.
        TimeSpan& operator += (const TimeSpan& other);

        /// Subtracts time interval from current one.
        TimeSpan& operator -= (const TimeSpan& other);

        /// Re-assigns time interval from other one.
        TimeSpan& operator = (const TimeSpan& other);

        /// Serializes time stamp into text presentation
        /// using specified time-span presentation format.
        void toString (std::string& str, TimeSpanFormat format = TimeSpanFormats::SDHHMMSSnsec) const;

        /// Serializes time stamp into text presentation
        /// using specified time-span presentation format.
        std::string toString (TimeSpanFormat format = TimeSpanFormats::SDHHMMSSnsec) const;

        /// De-serializes time interval from its text presentation.
        static TimeSpan deserialize (const std::string& str);

        /// Time interval of zero length.
        static const TimeSpan Zero;

    private:
        long long seconds_;
        int nanoseconds_;
};

inline long long TimeSpan::totalSeconds() const
{
    return seconds_;
}

inline int TimeSpan::nanoseconds() const
{
    return nanoseconds_;
}

inline std::string TimeSpan::toString (TimeSpanFormat format) const
{
    std::string str;

    toString (str, format);

    return str;
}

ONIXS_ESPEED_ITCH_NAMESPACE_END