OnixS CME Drop Copy Handler for C++  5.3.0.0
Public Member Functions | Static Public Member Functions | Friends | List of all members
Timestamp Class Reference

Represents timestamp without time-zone information. More...

Public Member Functions

 Timestamp ()
 Initializes as Jan 1, 1970, 00:00:00.
 
 Timestamp (UInt32 year, Month month, UInt32 day)
 Initializes as date with zero time component. More...
 
 Timestamp (UInt32 year, Month month, UInt32 day, UInt32 hour, UInt32 minute, UInt32 second, UInt32 nanosecond)
 Explicit timestamp initialization. More...
 
 Timestamp (const Timestamp &other)
 Initializes as copy of other instance.
 
UInt32 year () const
 Year component of timestamp.
 
Month month () const
 Month component of timestamp.
 
UInt32 day () const
 Day component of timestamp.
 
UInt32 hour () const
 Hour component of timestamp.
 
UInt32 minute () const
 Minute component of timestamp.
 
UInt32 second () const
 Second component of timestamp.
 
UInt32 millisecond () const
 Millisecond component of timestamp.
 
UInt32 microsecond () const
 Microsecond component of timestamp.
 
UInt32 nanosecond () const
 Nanosecond component of timestamp.
 
Timestamp date () const
 Returns timestamp without time part.
 
TimeSpan time () const
 Return time part of timestamp.
 
DayOfWeek dayOfWeek () const
 Returns day of the week.
 
bool operator== (const Timestamp &other) const
 Compares with other instance for equality.
 
bool operator!= (const Timestamp &other) const
 Compares with other instance for inequality.
 
bool operator< (const Timestamp &other) const
 Checks whether timestamp is less than other one.
 
bool operator> (const Timestamp &other) const
 Checks whether timestamp is greater than other one.
 
Timestampoperator+= (const TimeSpan &span)
 Adds time interval to given timestamp.
 
Timestampoperator-= (const TimeSpan &span)
 Subtracts time interval from given timestamp.
 
Timestampoperator= (const Timestamp &other)
 Re-initializes as copy of other timestamp.
 
std::string toString (TimestampFormat format=TimestampFormats::YYYYMMDDHHMMSSnsec) const
 Returns text presentation of timestamp using specified presentation format. More...
 
void toString (std::string &str, TimestampFormat format=TimestampFormats::YYYYMMDDHHMMSSnsec) const
 Returns text presentation of timestamp using specified presentation format. More...
 
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. More...
 

Static Public Member Functions

static Timestamp now ()
 Return timestamp that is current date and time expressed as local time. More...
 
static void now (Timestamp &)
 Return timestamp that is current date and time expressed as local time. More...
 
static Timestamp utcNow ()
 Return timestamp that is current date and time expressed as UTC time. More...
 
static void utcNow (Timestamp &)
 Return timestamp that is current date and time expressed as UTC time. More...
 
static Timestamp deserialize (const StringRef &)
 De-serializes timestamp from text presentation.
 
static Timestamp fromUnixTimestamp (UInt64 sinceEpoch, SinceEpochUnit unit)
 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. More...
 
static Timestamp maxTimestamp ()
 Returns the maximal possible timestamp (year 2554)
 

Friends

ONIXS_CME_DROP_COPY_API TimeSpan operator- (const Timestamp &left, const Timestamp &right)
 Calculates time interval between two timestamps.
 

Detailed Description

Represents timestamp without time-zone information.

Constructor & Destructor Documentation

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.

Member Function Documentation

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.

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.

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

Returns text presentation of timestamp using specified presentation format.

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.