Class that represents a timestamp type. More...

#include <SPL/Runtime/Type/Timestamp.h>

Public Member Functions

constexpr timestamp ()

timestamp (int64_t secs, uint32_t nanosecs, uint32_t machineId=0)

timestamp (double time)

timestamp (const timestamp &ot)=default

void set (int64_t secs, uint32_t nanosecs, uint32_t machineId=0)

void setSeconds (int64_t secs)

void setNanoSeconds (uint32_t nanosecs)

void setMachineId (int32_t machineId)

int64_t getSeconds () const

uint32_t getNanoseconds () const

int32_t getMachineId () const

timestamp operator- (const timestamp &rhs) const

timestamp & operator-= (const timestamp &rhs)

timestamp operator+ (const timestamp &rhs) const

timestamp & operator+= (const timestamp &rhs)

bool operator== (const timestamp &rhs) const

bool operator!= (const timestamp &rhs) const

bool operator< (const timestamp &rhs) const

bool operator>= (const timestamp &rhs) const

bool operator> (const timestamp &rhs) const

bool operator<= (const timestamp &rhs) const

void swap (timestamp &ot)

template<class BufferType >

void serialize (ByteBuffer< BufferType > &buf) const

template<class BufferType >

void deserialize (ByteBuffer< BufferType > &buf)

void serialize (std::ostream &ostr) const

void deserialize (std::istream &istr)

size_t hashCode () const

size_t getSerializedSize () const

Static Public Member Functions

static constexpr timestamp min ()

The minimum timestamp value. More...

static constexpr timestamp max ()

The maximum timestamp value. More...

Detailed Description

Class that represents a timestamp type.

Common usage is to store the seconds and nanoseconds since the Unix Epoch (Jan 1, 1970), but this is not enforced by the timestamp class. machineId may be used to detect if two timestamps were created on the same machine, as there may be variations in the clocks on different machines. machineId's are ignored for comparisons and arithmetic operations on timestamps.

Constructor & Destructor Documentation

◆ timestamp() [1/4]

constexpr SPL::timestamp::timestamp ( )

inline

Empty constructor

◆ timestamp() [2/4]

SPL::timestamp::timestamp ( int64_t secs,

uint32_t nanosecs,

uint32_t machineId = 0

)

inline

Constructor

Parameters

secs seconds since epoch

nanosecs nanoseconds

machineId machine id

◆ timestamp() [3/4]

SPL::timestamp::timestamp ( double time )

inline

Constructor

Parameters

time time in seconds, could be fractional

◆ timestamp() [4/4]

SPL::timestamp::timestamp ( const timestamp & ot )

default

Copy contructor

Parameters

ot other timestamp

Member Function Documentation

◆ set()

void SPL::timestamp::set ( int64_t secs,

uint32_t nanosecs,

uint32_t machineId = 0

)

inline

Set seconds since epoch and nanoseconds

Parameters

secs seconds since epoch

nanosecs nanoseconds

machineId machine id

◆ setSeconds()

void SPL::timestamp::setSeconds ( int64_t secs )

inline

Set seconds since epoch

Parameters

secs seconds since epoch

◆ setNanoSeconds()

void SPL::timestamp::setNanoSeconds ( uint32_t nanosecs )

inline

Set nanoseconds

Parameters

nanosecs nanoseconds

◆ setMachineId()

void SPL::timestamp::setMachineId ( int32_t machineId )

inline

Set machine id

Parameters

machineId the machine id

◆ getSeconds()

int64_t SPL::timestamp::getSeconds ( ) const

inline

Get seconds since epoch

Returns: the seconds since epoch component

◆ getNanoseconds()

uint32_t SPL::timestamp::getNanoseconds ( ) const

inline

Get nanoseconds

Returns: the nanosecond component

◆ getMachineId()

int32_t SPL::timestamp::getMachineId ( ) const

inline

Get machine id

Returns: the machine id

◆ operator-()

timestamp SPL::timestamp::operator- ( const timestamp & rhs ) const

inline

Difference. The machine id from the left-hand-size operand is used in result.

Parameters

rhs timestamp to subtract

Returns: difference between the timestamps

◆ operator-=()

timestamp& SPL::timestamp::operator-= ( const timestamp & rhs )

inline

Difference (assignment)

Parameters

rhs timestamp to subtract

Returns: *this

◆ operator+()

timestamp SPL::timestamp::operator+ ( const timestamp & rhs ) const

inline

Sum. The machine id from the left-hand-size operand is used in result.

Parameters

rhs timestamp to add

Returns: sum of the timestamps

◆ operator+=()

timestamp& SPL::timestamp::operator+= ( const timestamp & rhs )

inline

Sum (assignment)

Parameters

rhs timestamp to add

Returns: *this

◆ operator==()

bool SPL::timestamp::operator== ( const timestamp & rhs ) const

inline

Equality comparison

Parameters

rhs timestamp to compare with

Returns: true if the timestamps are the same, false otherwise

◆ operator!=()

bool SPL::timestamp::operator!= ( const timestamp & rhs ) const

inline

Non-equality comparison

Parameters

rhs timestamp to compare with

Returns: true if the timestamps are not the same, false otherwise

◆ operator<()

bool SPL::timestamp::operator< ( const timestamp & rhs ) const

inline

Less than comparison

Parameters

rhs timestamp to compare with

Returns: true if timestamp < rhs, false otherwise

◆ operator>=()

bool SPL::timestamp::operator>= ( const timestamp & rhs ) const

inline

Greater than or equal comparison

Parameters

rhs timestamp to compare with

Returns: true if timestamp >= rhs, false otherwise

◆ operator>()

bool SPL::timestamp::operator> ( const timestamp & rhs ) const

inline

Greater than comparison

Parameters

rhs timestamp to compare with

Returns: true if timestamp > rhs, false otherwise

◆ operator<=()

bool SPL::timestamp::operator<= ( const timestamp & rhs ) const

inline

Less than or equal comparison

Parameters

rhs timestamp to compare with

Returns: true if timestamp <= rhs, false otherwise

◆ swap()

void SPL::timestamp::swap ( timestamp & ot )

inline

Swap

Parameters

ot timestamp to swap with

◆ serialize() [1/2]

template<class BufferType >

void SPL::timestamp::serialize ( ByteBuffer< BufferType > & buf ) const

inline

Serialize (binary)

Parameters

buf byte buffer to use

◆ deserialize() [1/2]

template<class BufferType >

void SPL::timestamp::deserialize ( ByteBuffer< BufferType > & buf )

inline

Deserialize (binary)

Parameters

buf byte buffer to use

◆ serialize() [2/2]

void SPL::timestamp::serialize ( std::ostream & ostr ) const

inline

Serialize (character)

Parameters

ostr output stream

◆ deserialize() [2/2]

void SPL::timestamp::deserialize ( std::istream & istr )

Deserialize (character)

Parameters

istr input stream

◆ hashCode()

size_t SPL::timestamp::hashCode ( ) const

inline

Get hash code

Returns: hash code

◆ getSerializedSize()

size_t SPL::timestamp::getSerializedSize ( ) const

inline

Get the size in bytes when serialized

Returns: size in bytes when serialized

◆ min()

static constexpr timestamp SPL::timestamp::min ( )

inlinestatic

The minimum timestamp value.

◆ max()

static constexpr timestamp SPL::timestamp::max ( )

inlinestatic

The maximum timestamp value.

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

SPL/Runtime/Type/Timestamp.h