OnixS CME Drop Copy Handler C++ library  5.7.1
API documentation
Timestamp Class Reference

#include <OnixS/CME/DropCopy/Time.h>

Public Member Functions

 Timestamp ()
 
 Timestamp (UInt32 year, Month month, UInt32 day)
 
 Timestamp (UInt32 year, Month month, UInt32 day, UInt32 hour, UInt32 minute, UInt32 second, UInt32 nanosecond)
 
 Timestamp (const Timestamp &other)
 
UInt32 year () const
 
Month month () const
 
UInt32 day () const
 
UInt32 hour () const
 
UInt32 minute () const
 
UInt32 second () const
 
UInt32 millisecond () const
 
UInt32 microsecond () const
 
UInt32 nanosecond () const
 
Timestamp date () const
 
TimeSpan time () const
 
DayOfWeek dayOfWeek () const
 
bool operator== (const Timestamp &other) const
 
bool operator!= (const Timestamp &other) const
 
bool operator< (const Timestamp &other) const
 
bool operator> (const Timestamp &other) const
 
Timestampoperator+= (const TimeSpan &span)
 
Timestampoperator-= (const TimeSpan &span)
 
Timestampoperator= (const Timestamp &other)
 
std::string toString (TimestampFormat format=TimestampFormats::YYYYMMDDHHMMSSnsec) const
 
void toString (std::string &str, TimestampFormat format=TimestampFormats::YYYYMMDDHHMMSSnsec) const
 
UInt64 toUnixTimestamp (SinceEpochUnit unit) const
 

Static Public Member Functions

static Timestamp now ()
 
static void now (Timestamp &)
 
static Timestamp utcNow ()
 
static void utcNow (Timestamp &)
 
static Timestamp deserialize (const StringRef &)
 
static Timestamp fromUnixTimestamp (UInt64 sinceEpoch, SinceEpochUnit unit)
 
static Timestamp maxTimestamp ()
 

Friends

TimeSpan operator- (const Timestamp &left, const Timestamp &right)
 

Detailed Description

Definition at line 437 of file Time.h.

Constructor & Destructor Documentation

Timestamp ( )

Initializes as Jan 1, 1970, 00:00:00.

Timestamp ( UInt32  year,
Month  month,
UInt32  day 
)

Initializes as date with zero time component.

Input parameters are validated, therefore constructor throws exception if input values do not fit into their valid ranges.

Timestamp ( UInt32  year,
Month  month,
UInt32  day,
UInt32  hour,
UInt32  minute,
UInt32  second,
UInt32  nanosecond 
)

Explicit timestamp initialization.

Input parameters are validated, therefore constructor throws exception if input values do not fit into their valid ranges.

Timestamp ( const Timestamp other)

Initializes as copy of other instance.

Member Function Documentation

Timestamp date ( ) const

Returns timestamp without time part.

UInt32 day ( ) const

Day component of timestamp.

DayOfWeek dayOfWeek ( ) const

Returns day of the week.

static Timestamp deserialize ( const StringRef )
static

De-serializes timestamp from text presentation.

static Timestamp fromUnixTimestamp ( UInt64  sinceEpoch,
SinceEpochUnit  unit 
)
static

Converts timestamp from its numeric presentation (Unix timestamp in nanoseconds or days since 01-01-1970 UTC) as it's used by the CME Globex.

UInt32 hour ( ) const

Hour component of timestamp.

static Timestamp maxTimestamp ( )
static

Returns the maximal possible timestamp (year 2554)

UInt32 microsecond ( ) const

Microsecond component of timestamp.

UInt32 millisecond ( ) const

Millisecond component of timestamp.

UInt32 minute ( ) const

Minute component of timestamp.

Month month ( ) const

Month component of timestamp.

UInt32 nanosecond ( ) const

Nanosecond component of timestamp.

static Timestamp now ( )
static

Return timestamp that is current date and time expressed as local time.

static void now ( Timestamp )
static

Return timestamp that is current date and time expressed as local time.

bool operator!= ( const Timestamp other) const

Compares with other instance for inequality.

Timestamp& operator+= ( const TimeSpan span)

Adds time interval to given timestamp.

Timestamp& operator-= ( const TimeSpan span)

Subtracts time interval from given timestamp.

bool operator< ( const Timestamp other) const

Checks whether timestamp is less than other one.

Timestamp& operator= ( const Timestamp other)

Re-initializes as copy of other timestamp.

bool operator== ( const Timestamp other) const

Compares with other instance for equality.

bool operator> ( const Timestamp other) const

Checks whether timestamp is greater than other one.

UInt32 second ( ) const

Second component of timestamp.

TimeSpan time ( ) const

Return time part of timestamp.

std::string toString ( TimestampFormat  format = TimestampFormats::YYYYMMDDHHMMSSnsec) const
inline

Returns text presentation of timestamp using specified presentation format.

Definition at line 579 of file Time.h.

void toString ( std::string &  str,
TimestampFormat  format = TimestampFormats::YYYYMMDDHHMMSSnsec 
) const

Returns text presentation of timestamp using specified presentation format.

UInt64 toUnixTimestamp ( SinceEpochUnit  unit) const

Converts timestamp into its numeric presentation (Unix timestamp in nanoseconds or days since 01-01-1970 UTC) as it's used by the CME Globex.

static Timestamp utcNow ( )
static

Return timestamp that is current date and time expressed as UTC time.

static void utcNow ( Timestamp )
static

Return timestamp that is current date and time expressed as UTC time.

UInt32 year ( ) const

Year component of timestamp.

Friends And Related Function Documentation

TimeSpan operator- ( const Timestamp left,
const Timestamp right 
)
friend

Calculates time interval between two timestamps.


The documentation for this class was generated from the following file: