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/FIXEngine/ABI.h>
#include <OnixS/FIXEngine/FIX/Numeric.h>
 
#define ONIXS_MINMAX_ABUSER
 
namespace OnixS {
namespace FIX {
typedef UInt32 Amount;
typedef UInt64 HugeAmount;
 
typedef Int32 Interval;
typedef Int64 HugeInterval;
 
typedef Interval Days;
typedef Interval Hours;
typedef Interval Minutes;
typedef Interval Seconds;
 
typedef Interval Milliseconds;
typedef Interval Microseconds;
typedef Interval Nanoseconds;
typedef HugeInterval Picoseconds;
 
typedef HugeInterval TotalSeconds;
typedef HugeInterval TotalMilliseconds;
typedef HugeInterval TotalMicroseconds;
typedef HugeInterval TotalNanoseconds;
typedef HugeInterval TotalPicoseconds;

struct ONIXS_FIXENGINE_API TimeDetails {
    static const Hours HoursPerDay;
    static const Minutes MinutesPerHour;
 
    static const Seconds SecondsPerMinute;
    static const Seconds SecondsPerHour;
    static const Seconds SecondsPerDay;
 
    static const Milliseconds MillisecondsPerSecond;
    static const Microseconds MicrosecondsPerSecond;
    static const Nanoseconds NanosecondsPerSecond;
 
    static const Picoseconds PicosecondsPerNanosecond;
    static const Picoseconds PicosecondsPerMicrosecond;
    static const Picoseconds PicosecondsPerMillisecond;
    static const Picoseconds PicosecondsPerSecond;
};

struct ONIXS_FIXENGINE_API TimeSpanFormat {
    enum Enum {
        HHMMSS,

        HHMMSSMsec,

        HHMMSSUsec,

        HHMMSSNsec,

        HHMMSSPsec
    };
};

class ONIXS_FIXENGINE_API TimeSpan
{
public:
    TimeSpan();

    TimeSpan(
        TotalSeconds seconds,
        Nanoseconds nanoseconds);

    TimeSpan(
        TotalSeconds seconds,
        Picoseconds picoseconds);

    TimeSpan(
        Hours hours,
        Minutes minutes,
        Seconds seconds);

    TimeSpan(
        Days days,
        Hours hours,
        Minutes minutes,
        Seconds seconds,
        Nanoseconds nanoseconds);

    TimeSpan(
        Days days,
        Hours hours,
        Minutes minutes,
        Seconds seconds,
        Picoseconds picooseconds);

    TotalSeconds totalSeconds() const;

    Days days() const;

    Hours hours() const;

    Minutes minutes() const;

    Seconds seconds() const;

    Milliseconds milliseconds() const;

    Microseconds microseconds() const;

    Nanoseconds nanoseconds() const;

    Picoseconds picoseconds() const;

    TimeSpan absolute() const;

    bool operator == (const TimeSpan &) const;

    bool operator != (const TimeSpan &) const;

    bool operator < (const TimeSpan &) const;

    TimeSpan & operator += (const TimeSpan &);

    TimeSpan & operator -= (const TimeSpan &);

    static TimeSpan min ONIXS_MINMAX_ABUSER();

    static TimeSpan max ONIXS_MINMAX_ABUSER();

    static TimeSpan zero();

    std::string toString(TimeSpanFormat::Enum = TimeSpanFormat::HHMMSSNsec) const;
    void toString(std::string &, TimeSpanFormat::Enum = TimeSpanFormat::HHMMSSNsec) const;

    static
    TimeSpan
    parse(const std::string &);
 
protected:
    friend class TimeManager;
 
    TotalSeconds seconds_;
    Picoseconds picoseconds_;
 
    void normalize();
};
 
inline
TotalSeconds
TimeSpan::totalSeconds() const
{
    return seconds_;
}
 
inline
Picoseconds
TimeSpan::picoseconds() const
{
    return picoseconds_;
}
 
class ONIXS_FIXENGINE_API DaySpan : public TimeSpan
{
public:
    DaySpan(Days days);
};

class ONIXS_FIXENGINE_API HourSpan : public TimeSpan
{
public:
    HourSpan(Hours hours);
};

class ONIXS_FIXENGINE_API MinuteSpan : public TimeSpan
{
public:
    MinuteSpan(Minutes minutes);
};

class ONIXS_FIXENGINE_API SecondSpan : public TimeSpan
{
public:
    SecondSpan(TotalSeconds seconds);
};

class ONIXS_FIXENGINE_API MillisecondSpan : public TimeSpan
{
public:
    MillisecondSpan(
        TotalMilliseconds milliseconds);
};

class ONIXS_FIXENGINE_API MicrosecondSpan : public TimeSpan
{
public:
    MicrosecondSpan(
        TotalMicroseconds microseconds);
};

class ONIXS_FIXENGINE_API NanosecondSpan : public TimeSpan
{
public:
    NanosecondSpan(
        TotalNanoseconds nanoseconds);
};

class ONIXS_FIXENGINE_API PicosecondSpan : public TimeSpan
{
public:
    PicosecondSpan(
        TotalPicoseconds picoseconds);
};
}
}