OnixS C++ Tradeweb Approved Publication Arrangement (APA) Handler  1.2.2.18
API documentation
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
TimeSpan Class Reference

#include <TimeSpan.h>

Collaboration diagram for TimeSpan:
Collaboration graph
[legend]

Public Member Functions

 TimeSpan ()
 
 TimeSpan (int hours, int minutes, int seconds, int nanoseconds=0)
 
 TimeSpan (int days, int hours, int minutes, int seconds, int nanoseconds)
 
 TimeSpan (long long totalSeconds, int nanoseconds)
 
 TimeSpan (const TimeSpan &other)
 
long long totalSeconds () const
 
int days () const
 
int hours () const
 
int minutes () const
 
int seconds () const
 
int milliseconds () const
 
int microseconds () const
 
int nanoseconds () const
 
bool operator== (const TimeSpan &other) const
 
bool operator!= (const TimeSpan &other) const
 
bool operator< (const TimeSpan &other) const
 
bool operator> (const TimeSpan &other) const
 
TimeSpan & operator+= (const TimeSpan &other)
 
TimeSpan & operator-= (const TimeSpan &other)
 
TimeSpan & operator= (const TimeSpan &other)
 
void toString (std::string &str, TimeSpanFormat format=TimeSpanFormats::SDHHMMSSnsec) const
 
std::string toString (TimeSpanFormat format=TimeSpanFormats::SDHHMMSSnsec) const
 

Static Public Member Functions

static TimeSpan deserialize (const std::string &str)
 

Static Public Attributes

static const TimeSpan Zero
 

Detailed Description

Represents time interval. Used primarily to present time-only stamps and to measure time intervals between two timestamps.

Definition at line 57 of file TimeSpan.h.

Constructor & Destructor Documentation

TimeSpan ( )

Initializes zero span.

TimeSpan ( int  hours,
int  minutes,
int  seconds,
int  nanoseconds = 0 
)

Initializes with given set of values. Input parameters are treated as quantities, but not as a time stamp. Therefore, there's no requirement to fit in a certain range like hours must fit into [0, 24) range. After initialization time span will be normalized.

TimeSpan ( int  days,
int  hours,
int  minutes,
int  seconds,
int  nanoseconds 
)

Initializes with given set of values. Input parameters are treated as quantities, but not as a time stamp. Therefore, there's no requirement to fit in a certain range like hours must fit into [0, 24) range. After initialization time span will be normalized.

TimeSpan ( long long  totalSeconds,
int  nanoseconds 
)

Initializes time interval from total number seconds and its fractional (nanosecond) part.

TimeSpan ( const TimeSpan &  other)

Initializes as clone of other instance.

Member Function Documentation

int days ( ) const

Days component of time interval. Whole number of days in time interval.

static TimeSpan deserialize ( const std::string &  str)
static

De-serializes time interval from its text presentation.

int hours ( ) const

Hours component of time interval. Values are in range from -23 through 23.

int microseconds ( ) const

Microseconds component of time interval. Values are in range from -999999 through 999999.

int milliseconds ( ) const

Milliseconds component of time interval. Values are in range from -999 through 999.

int minutes ( ) const

Minutes component of time interval. Values are in range from -59 through 59.

int nanoseconds ( ) const
inline

Nanoseconds component of time interval. Values are in range from -999999999 through 999999999.

Definition at line 162 of file TimeSpan.h.

bool operator!= ( const TimeSpan &  other) const

Compares with other instance for in-equality.

TimeSpan& operator+= ( const TimeSpan &  other)

Adds time interval to current one.

TimeSpan& operator-= ( const TimeSpan &  other)

Subtracts time interval from current one.

bool operator< ( const TimeSpan &  other) const

Checks whether time interval less than other one.

TimeSpan& operator= ( const TimeSpan &  other)

Re-assigns time interval from other one.

bool operator== ( const TimeSpan &  other) const

Compares with other instance for equality.

bool operator> ( const TimeSpan &  other) const

Checks whether time interval greater than other one.

int seconds ( ) const

Seconds component of time interval. Values are in range from -59 through 59.

void toString ( std::string &  str,
TimeSpanFormat  format = TimeSpanFormats::SDHHMMSSnsec 
) const

Serializes time stamp into text presentation using specified time-span presentation format.

std::string toString ( TimeSpanFormat  format = TimeSpanFormats::SDHHMMSSnsec) const
inline

Serializes time stamp into text presentation using specified time-span presentation format.

Definition at line 167 of file TimeSpan.h.

long long totalSeconds ( ) const
inline

Whole number of seconds in time interval.

Definition at line 157 of file TimeSpan.h.

Member Data Documentation

const TimeSpan Zero
static

Time interval of zero length.

Definition at line 150 of file TimeSpan.h.

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