Ocean::Timestamp Class Reference

This class implements a timestamp. More...

#include <Timestamp.h>

Public Member Functions
	Timestamp ()=default
	Creates a new timestamp with invalid time.
	Timestamp (const bool toNow)
	Creates a new timestamp.
	Timestamp (const double timestamp)
	Creates a new timestamp with a given value.
Timestamp &	toNow ()
	Sets the timestamp to the current time.
Timestamp &	toInvalid ()
	Sets the timestamp to invalid.
int64_t	nanoseconds () const
	Returns this timestamp in nanoseconds.
bool	hasTimePassed (const double seconds, const Timestamp &currentTimestamp=Timestamp(true)) const
	Returns whether a specified amount of time has passed since this timestamp.
bool	isValid () const
	Returns whether the timestamp holds a valid time.
bool	isInvalid () const
	Returns whether the timestamp holds an invalid time.
Timestamp &	operator= (const double timestamp)
	Assign a new value.
Timestamp	operator+ (const Timestamp &right) const
	Adds two timestamps.
Timestamp &	operator+= (const Timestamp &right)
	Adds and assigns two timestamps.
Timestamp	operator+ (const double seconds) const
	Adds seconds to this timestamps.
Timestamp &	operator+= (const double seconds)
	Adds and assigns seconds to this timestamps.
Timestamp	operator- (const Timestamp &right) const
	Subtracts two timestamps.
Timestamp &	operator-= (const Timestamp &right)
	Subtracts and assigns two timestamps.
Timestamp	operator- (const double seconds) const
	Subtracts seconds from this timestamp.
Timestamp &	operator-= (const double seconds)
	Subtracts and assigns seconds from this timestamp.
bool	operator< (const Timestamp &right) const
	Returns whether the this timestamp is lesser than the right one.
bool	operator<= (const Timestamp &right) const
	Returns whether the this timestamp is lesser or equal to the right one.
bool	operator> (const Timestamp &right) const
	Returns whether the this timestamp is greater than the right one.
bool	operator>= (const Timestamp &right) const
	Returns whether the this timestamp is greater or equal to the right one.
bool	operator== (const Timestamp &right) const
	Returns whether two timestamps are identical.
bool	operator!= (const Timestamp &right) const
	Returns whether two timestamps are not identical.
	operator double () const
	Cast operator for the timestamp value.
size_t	operator() (const Timestamp &timestamp) const
	Hash function.

Static Public Member Functions
static constexpr int64_t	seconds2milliseconds (const double seconds)
	Converts seconds to milliseconds.
static constexpr int64_t	seconds2microseconds (const double seconds)
	Converts seconds to microseconds.
static constexpr int64_t	seconds2nanoseconds (const double seconds)
	Converts seconds to nanoseconds.
static constexpr double	milliseconds2seconds (const int64_t milliseconds)
	Converts milliseconds to seconds.
static constexpr double	microseconds2seconds (const int64_t microseconds)
	Converts microseconds to seconds.
static constexpr double	nanoseconds2seconds (const int64_t nanoseconds)
	Converts nanoseconds to seconds.

Static Public Attributes
static constexpr int64_t	millisecondsPerSecond_ = 1000
	Definition of the number of milliseconds in one second.
static constexpr int64_t	microsecondsPerSecond_ = millisecondsPerSecond_ * 1000
	Definition of the number of microseconds in one second.
static constexpr int64_t	nanosecondsPerSecond_ = microsecondsPerSecond_ * 1000
	Definition of the number of nanoseconds in one second.

Static Protected Member Functions
static constexpr double	invalidTimestampValue ()
	Returns the of an invalid timestamp.

Protected Attributes
double	value_ = invalidTimestampValue()
	Timestamp value.

Detailed Description

This class implements a timestamp.

The timestamp is specified by the number of seconds since 01.01.1970 00:00:00 in UTC time.
Depending on the underlying hardware the accuracy (update rate) of the timestamps can vary.
The timestamp class wraps a floating value with 64 bit precision.

Constructor & Destructor Documentation

Timestamp() [1/3]

Ocean::Timestamp::Timestamp ( )

default

Creates a new timestamp with invalid time.

Timestamp() [2/3]

Ocean::Timestamp::Timestamp ( const bool  toNow )

explicit

Creates a new timestamp.

Parameters

toNow

Determines whether the timestamp holds the seconds since 01.01.1970 00:00:00 in UTC time, otherwise the timestamp will be initialized as invalid

Timestamp() [3/3]

Ocean::Timestamp::Timestamp ( const double  timestamp )

inlineexplicit

Creates a new timestamp with a given value.

Parameters

timestamp

Timestamp value

Member Function Documentation

hasTimePassed()

bool Ocean::Timestamp::hasTimePassed ( const double  seconds, const Timestamp &  currentTimestamp = Timestamp(true)  ) const

inline

Returns whether a specified amount of time has passed since this timestamp.

This function returns 'thisTimestamp + seconds <= currentTimestamp'.

Parameters

seconds	The number of seconds defining the time to check, with range [0, infinity)
currentTimestamp	The current timestamp to use for comparison

Returns

True, if the time has passed or if this timestamp is invalid

invalidTimestampValue()

constexpr double Ocean::Timestamp::invalidTimestampValue ( )

staticconstexprprotected

Returns the of an invalid timestamp.

Returns

Invalid timestamp value

isInvalid()

bool Ocean::Timestamp::isInvalid ( ) const

inline

Returns whether the timestamp holds an invalid time.

Returns

True, if so

isValid()

bool Ocean::Timestamp::isValid ( ) const

inline

Returns whether the timestamp holds a valid time.

Returns

True, if so

microseconds2seconds()

constexpr double Ocean::Timestamp::microseconds2seconds ( const int64_t  microseconds )

staticconstexpr

Converts microseconds to seconds.

Parameters

microseconds

The microseconds to convert, with range (-infinity, infinity)

Returns

The resulting seconds

milliseconds2seconds()

constexpr double Ocean::Timestamp::milliseconds2seconds ( const int64_t  milliseconds )

staticconstexpr

Converts milliseconds to seconds.

Parameters

milliseconds

The milliseconds to convert, with range (-infinity, infinity)

Returns

The resulting seconds

nanoseconds()

int64_t Ocean::Timestamp::nanoseconds ( ) const

inline

Returns this timestamp in nanoseconds.

Returns

The timestamp in nanoseconds, with range (-infinity, infinity)

nanoseconds2seconds()

constexpr double Ocean::Timestamp::nanoseconds2seconds ( const int64_t  nanoseconds )

staticconstexpr

Converts nanoseconds to seconds.

Parameters

nanoseconds

The nanoseconds to convert, with range (-infinity, infinity)

Returns

The resulting seconds

operator double()

Ocean::Timestamp::operator double ( ) const

inlineexplicit

Cast operator for the timestamp value.

Returns

Timestamp

operator!=()

bool Ocean::Timestamp::operator!= ( const Timestamp &  right ) const

inline

Returns whether two timestamps are not identical.

Parameters

right

The right timestamp

Returns

True, if so

operator()()

size_t Ocean::Timestamp::operator() ( const Timestamp &  timestamp ) const

inline

Hash function.

Parameters

timestamp

The timestamp for which the hash value will be determined

Returns

The resulting hash value

operator+() [1/2]

Timestamp Ocean::Timestamp::operator+ ( const double  seconds ) const

inline

Adds seconds to this timestamps.

Parameters

seconds

The number of seconds to add, with range (-infinity, infinity)

Returns

New timestamp

operator+() [2/2]

Timestamp Ocean::Timestamp::operator+ ( const Timestamp &  right ) const

inline

Adds two timestamps.

Parameters

right

The right timestamp

Returns

New timestamp

operator+=() [1/2]

Timestamp & Ocean::Timestamp::operator+= ( const double  seconds )

inline

Adds and assigns seconds to this timestamps.

Parameters

seconds

The number of seconds to add, with range (-infinity, infinity)

Returns

Reference to this timestamp

operator+=() [2/2]

Timestamp & Ocean::Timestamp::operator+= ( const Timestamp &  right )

inline

Adds and assigns two timestamps.

Parameters

right

The right timestamp

Returns

Reference to this timestamp

operator-() [1/2]

Timestamp Ocean::Timestamp::operator- ( const double  seconds ) const

inline

Subtracts seconds from this timestamp.

Parameters

seconds

The number of seconds to subtract, with range (-infinity, infinity)

Returns

New timestamp

operator-() [2/2]

Timestamp Ocean::Timestamp::operator- ( const Timestamp &  right ) const

inline

Subtracts two timestamps.

Parameters

right

The right timestamp

Returns

New timestamp

operator-=() [1/2]

Timestamp & Ocean::Timestamp::operator-= ( const double  seconds )

inline

Subtracts and assigns seconds from this timestamp.

Parameters

seconds

The number of seconds to subtract, with range (-infinity, infinity)

Returns

Reference to this timestamp

operator-=() [2/2]

Timestamp & Ocean::Timestamp::operator-= ( const Timestamp &  right )

inline

Subtracts and assigns two timestamps.

Parameters

right

The right timestamp

Returns

Reference to this timestamp

operator<()

bool Ocean::Timestamp::operator< ( const Timestamp &  right ) const

inline

Returns whether the this timestamp is lesser than the right one.

Parameters

right

The right timestamp

Returns

True, if so

operator<=()

bool Ocean::Timestamp::operator<= ( const Timestamp &  right ) const

inline

Returns whether the this timestamp is lesser or equal to the right one.

Parameters

right

The right timestamp

Returns

True, if so

operator=()

Timestamp & Ocean::Timestamp::operator= ( const double  timestamp )

inline

Assign a new value.

Parameters

timestamp

Value to assign

Returns

Reference to this timestamp

operator==()

bool Ocean::Timestamp::operator== ( const Timestamp &  right ) const

inline

Returns whether two timestamps are identical.

Parameters

right

The right timestamp

Returns

True, if so

operator>()

bool Ocean::Timestamp::operator> ( const Timestamp &  right ) const

inline

Returns whether the this timestamp is greater than the right one.

Parameters

right

The right timestamp

Returns

True, if so

operator>=()

bool Ocean::Timestamp::operator>= ( const Timestamp &  right ) const

inline

Returns whether the this timestamp is greater or equal to the right one.

Parameters

right

The right timestamp

Returns

True, if so

seconds2microseconds()

constexpr int64_t Ocean::Timestamp::seconds2microseconds ( const double  seconds )

staticconstexpr

Converts seconds to microseconds.

Parameters

seconds

The seconds to convert, with range (-infinity, infinity)

Returns

The resulting microseconds

seconds2milliseconds()

constexpr int64_t Ocean::Timestamp::seconds2milliseconds ( const double  seconds )

staticconstexpr

Converts seconds to milliseconds.

Parameters

seconds

The seconds to convert, with range (-infinity, infinity)

Returns

The resulting milliseconds

seconds2nanoseconds()

constexpr int64_t Ocean::Timestamp::seconds2nanoseconds ( const double  seconds )

staticconstexpr

Converts seconds to nanoseconds.

Parameters

seconds

The seconds to convert, with range (-infinity, infinity)

Returns

The resulting nanoseconds

toInvalid()

Timestamp & Ocean::Timestamp::toInvalid ( )

inline

Sets the timestamp to invalid.

Returns

Reference to this object

toNow()

Timestamp & Ocean::Timestamp::toNow

(

)

Sets the timestamp to the current time.

The timestamp holds the seconds since 01.01.1970 00:00:00 in UTC time.

Returns

Reference to this object

Field Documentation

microsecondsPerSecond_

constexpr int64_t Ocean::Timestamp::microsecondsPerSecond_ = millisecondsPerSecond_ * 1000

staticconstexpr

Definition of the number of microseconds in one second.

millisecondsPerSecond_

constexpr int64_t Ocean::Timestamp::millisecondsPerSecond_ = 1000

staticconstexpr

Definition of the number of milliseconds in one second.

nanosecondsPerSecond_

constexpr int64_t Ocean::Timestamp::nanosecondsPerSecond_ = microsecondsPerSecond_ * 1000

staticconstexpr

Definition of the number of nanoseconds in one second.

value_

double Ocean::Timestamp::value_ = invalidTimestampValue()

protected

Timestamp value.

---

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

• Timestamp.h