OnixS C++ B3 Binary UMDF Market Data Handler  1.3.3
API documentation
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Timestamp Class Reference

#include <OnixS/B3/MarketData/UMDF/Time.h>

Public Types

typedef UInt64 Ticks
 
typedef UInt32 Year
 
typedef OnixS::B3::MarketData::UMDF::Month::Enum Month
 
typedef UInt32 Day
 
typedef UInt32 Hour
 
typedef UInt32 Minute
 
typedef UInt32 Second
 
typedef UInt32 Millisecond
 
typedef UInt32 Microsecond
 
typedef UInt32 Nanosecond
 

Public Member Functions

 Timestamp (Ticks ticks=0) throw ()
 
 Timestamp (Year year, Month month, Day day, Hour hour=0, Minute minute=0, Second second=0, Nanosecond nanosecond=0)
 
 Timestamp (const Timestamp &other)
 
Year year () const
 
Month month () const
 
Day day () const
 
Hour hour () const
 
Minute minute () const
 
Second second () const
 
Millisecond millisecond () const
 
Microsecond microsecond () const
 
Nanosecond nanosecond () const
 
Timestamp date () const
 
TimeSpan time () const
 
Ticks sinceEpoch () const throw ()
 
Timestamp & operator= (const Timestamp &other)
 
void swap (Timestamp &other)
 

Static Public Member Functions

static ONIXS_B3_UMDF_MD_API Timestamp utcNow ()
 
static ONIXS_B3_UMDF_MD_API Timestamp now ()
 
static Timestamp parse (unsigned long long presentation, TimestampFormat::Enum format=TimestampFormat::YYYYMMDD)
 

Detailed Description

Definition at line 482 of file Time.h.

Member Typedef Documentation

typedef UInt32 Day

Integral type presenting day component.

Definition at line 497 of file Time.h.

typedef UInt32 Hour

Integral type presenting hour component.

Definition at line 500 of file Time.h.

typedef UInt32 Microsecond

Integral type presenting microsecond component.

Definition at line 512 of file Time.h.

typedef UInt32 Millisecond

Integral type presenting millisecond component.

Definition at line 509 of file Time.h.

typedef UInt32 Minute

Integral type presenting minute component.

Definition at line 503 of file Time.h.

typedef OnixS::B3::MarketData::UMDF::Month::Enum Month

Type presenting month component.

Definition at line 494 of file Time.h.

typedef UInt32 Nanosecond

Integral type presenting nanosecond component.

Definition at line 515 of file Time.h.

typedef UInt32 Second

Integral type presenting second component.

Definition at line 506 of file Time.h.

typedef UInt64 Ticks

Integral type storing internal ticks.

Definition at line 486 of file Time.h.

typedef UInt32 Year

Integral type presenting year component.

Definition at line 489 of file Time.h.

Constructor & Destructor Documentation

Timestamp ( Ticks  ticks = 0)
throw (
)
inlineexplicit

Initializes from number of ticks since epoch.

Definition at line 529 of file Time.h.

Timestamp ( Year  year,
Month  month,
Day  day,
Hour  hour = 0,
Minute  minute = 0,
Second  second = 0,
Nanosecond  nanosecond = 0 
)
inline

Explicit time-stamp initialization.

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

Definition at line 540 of file Time.h.

Timestamp ( const Timestamp &  other)
inline

Initializes as copy of other instance.

Definition at line 557 of file Time.h.

Member Function Documentation

Timestamp date ( ) const
inline

Timestamp without a time part.

Definition at line 630 of file Time.h.

Day day ( ) const
inline

Day component of given time point.

Definition at line 584 of file Time.h.

Hour hour ( ) const
inline

Hour component of given time point.

Definition at line 594 of file Time.h.

Microsecond microsecond ( ) const
inline

Microsecond component of given time point.

Definition at line 618 of file Time.h.

Millisecond millisecond ( ) const
inline

Millisecond component of given time point.

Definition at line 612 of file Time.h.

Minute minute ( ) const
inline

Minute component of given time point.

Definition at line 600 of file Time.h.

Month month ( ) const
inline

Month component of given time point.

Definition at line 574 of file Time.h.

Nanosecond nanosecond ( ) const
inline

Nanosecond component of given time point.

Definition at line 624 of file Time.h.

static ONIXS_B3_UMDF_MD_API Timestamp now ( )
static

Returns current local time.

Timestamp& operator= ( const Timestamp &  other)
inline

Reinitializes as copy of given instance.

Definition at line 657 of file Time.h.

static Timestamp parse ( unsigned long long  presentation,
TimestampFormat::Enum  format = TimestampFormat::YYYYMMDD 
)
static

Parses timestamp from its numeric presentation (like 20201115) only YYYYMMDD is supported.

Second second ( ) const
inline

Second component of given time point.

Definition at line 606 of file Time.h.

Ticks sinceEpoch ( ) const
throw (
)
inline

Number of nanoseconds since the Epoch (01-01-1970).

Definition at line 649 of file Time.h.

void swap ( Timestamp &  other)
inline

Exchanges value with other instance.

Definition at line 667 of file Time.h.

TimeSpan time ( ) const
inline

Time part of timestamp.

Definition at line 640 of file Time.h.

static ONIXS_B3_UMDF_MD_API Timestamp utcNow ( )
static

Returns current UTC time.

Year year ( ) const
inline

Year component of given time point.

Definition at line 564 of file Time.h.

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