Timestamp.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/Integral.h>
#include <OnixS/eSpeed/MarketData/Itch/TimeSpan.h>
 
namespace OnixS { namespace HandlerCore { namespace Common { struct TimeHelper; }}}
 
ONIXS_ESPEED_ITCH_NAMESPACE_BEGIN

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

struct ONIXS_ESPEED_ITCH_API YearMonthDay
{
    unsigned year;

    Month::Enum month;

    unsigned day;
};

struct ONIXS_ESPEED_ITCH_API TimestampFormat
{
    enum Enum
    {
        YYYYMMDD,

        YYYYMMDDHHMMSS,

        YYYYMMDDHHMMSSMsec,

        YYYYMMDDHHMMSSNsec
    };
};

typedef UInt64 RawTimestamp;

class ONIXS_ESPEED_ITCH_API Timestamp
{
    public:
        Timestamp();

        Timestamp (
            unsigned int year, Month::Enum month, unsigned int day,
            unsigned int hour = 0, unsigned int minute = 0, unsigned int second = 0,
            unsigned int nanosecond = 0);

        explicit
        Timestamp(RawTimestamp ts);

        unsigned year() const;

        Month::Enum month() const;

        unsigned int day() const;

        void date (YearMonthDay&) const;

        unsigned int hour() const;

        unsigned int minute() const;

        unsigned int second() const;

        unsigned int millisecond() const;

        unsigned int microsecond() const;

        unsigned int nanosecond() const;

        const TimeSpan& sinceEpoch() const;

        static Timestamp epoch();

        bool operator == (const Timestamp&) const;

        bool operator != (const Timestamp&) const;

        bool operator < (const Timestamp&) const;

        std::string
        toString (
            TimestampFormat::Enum =
                TimestampFormat::YYYYMMDDHHMMSSNsec) const;

        void
        toString (
            std::string& str,
            TimestampFormat::Enum =
                TimestampFormat::YYYYMMDDHHMMSSNsec) const;

        static Timestamp utcNow();

        static Timestamp now();

        static
        Timestamp
        parse (
            const std::string&,
            TimestampFormat::Enum =
                TimestampFormat::YYYYMMDDHHMMSSNsec);

        static
        Timestamp
        parse (
            unsigned long long presentation,
            TimestampFormat::Enum format);
 
    private:
        Timestamp (long long totalSeconds, int subseconds);
 
        friend struct HandlerCore::Common::TimeHelper;
        TimeSpan sinceEpoch_;
};
 
inline
Timestamp::Timestamp (
    long long totalSeconds, int subseconds)
    : sinceEpoch_ (totalSeconds, subseconds)
 
{
}
 
inline
unsigned int
Timestamp::millisecond() const
{
    return sinceEpoch_.milliseconds();
}
 
inline
unsigned int
Timestamp::microsecond() const
{
    return sinceEpoch_.microseconds();
}
 
inline
unsigned int
Timestamp::nanosecond() const
{
    return sinceEpoch_.nanoseconds();
}
 
inline
const TimeSpan&
Timestamp::sinceEpoch() const
{
    return sinceEpoch_;
}
 
inline
std::string
Timestamp::toString (
    TimestampFormat::Enum format) const
{
    std::string str;
 
    toString (str, format);
 
    return str;
}
 
inline
TimeSpan
operator - (
    const Timestamp& left,
    const Timestamp& right)
{
    TimeSpan res (left.sinceEpoch() );
    return res -= right.sinceEpoch();
}
 
ONIXS_ESPEED_ITCH_NAMESPACE_END