Duration represents a time interval and can -. More...

Public Member Functions
	Duration ()
	Create a Duration elapsing the default amount of time (zero seconds).

	Duration (int32_t sec, uint32_t nanosec=0)
	Create a Duration elapsing a specific amount of time. More...

int64_t	sec () const
	Get seconds part of the Duration. More...

void	sec (int64_t s)
	Set number of seconds. More...

uint32_t	nanosec () const
	Get nanoseconds part of the Duration. More...

void	nanosec (uint32_t ns)
	Set number of nanoseconds. More...

int	compare (const Duration &that) const
	Returns an integer value for a comparison of two Durations: 1 if this Duration is greater than the comparator (that) -1 if the Duration is less than the comparator (that) 0 if the Duration matches the comparator (that) More...

bool	operator> (const Duration &that) const
	Returns true if the Duration is greater than the comparator. More...

bool	operator>= (const Duration &that) const
	Returns true if the Duration is greater than or equal to the comparator. More...

bool	operator!= (const Duration &that) const
	Returns true if the Duration is not equal to the comparator. More...

bool	operator== (const Duration &that) const
	Returns true if the Duration is equal to the comparator. More...

bool	operator<= (const Duration &that) const
	Returns true if the Duration is less than or equal to the comparator. More...

bool	operator< (const Duration &that) const
	Returns true if the Duration is less than the comparator. More...

Duration &	operator+= (const Duration &a_ti)
	Add a Duration to this Duration. More...

Duration &	operator-= (const Duration &a_ti)
	Subtract a Duration from this Duration. More...

Duration &	operator*= (uint64_t factor)
	Multiply this Duration by a factor. More...

const Duration	operator+ (const Duration &other) const
	Add a Duration to Duration. More...

const Duration	operator- (const Duration &other) const
	Subtract a Duration from Duration. More...

int64_t	to_millisecs () const
	Returns this Duration in milliseconds. More...

int64_t	to_microsecs () const
	Returns this Duration in micro-seconds. More...

double	to_secs () const
	Returns this Duration in seconds. More...

Static Public Member Functions
static const Duration	zero ()
	Create a Duration elapsing zero seconds.

static const Duration	infinite ()
	Create an infinite Duration.

static const Duration	from_microsecs (int64_t microseconds)
	Create a Duration from a number of microseconds. More...

static const Duration	from_millisecs (int64_t milliseconds)
	Create a Duration from a number of milliseconds. More...

static const Duration	from_secs (double seconds)
	Create a Duration from a number of seconds. More...

Detailed Description

Duration represents a time interval and can -.

Can be incremented by durations expressed as seconds, nanoseconds milliseconds, or Duration objects.
Can be converted to and from Durations expressed in milliseconds (or other units) as integer types.

Constructor & Destructor Documentation

◆ Duration()

dds::core::Duration::Duration	(	int32_t	sec,
		uint32_t	nanosec = `0`
	)

explicit

Create a Duration elapsing a specific amount of time.

Parameters

sec	Amount of seconds for the Duration.
nanosec	Amount of nanoseconds for the Duration.

Member Function Documentation

◆ compare()

int dds::core::Duration::compare ( const Duration & that ) const

Returns an integer value for a comparison of two Durations: 1 if this Duration is greater than the comparator (that) -1 if the Duration is less than the comparator (that) 0 if the Duration matches the comparator (that)

Parameters

that	Duration to compare

Returns: comparison result

◆ from_microsecs()

static const Duration dds::core::Duration::from_microsecs ( int64_t microseconds )

static

Create a Duration from a number of microseconds.

Parameters

microseconds number of microseconds

◆ from_millisecs()

static const Duration dds::core::Duration::from_millisecs ( int64_t milliseconds )

static

Create a Duration from a number of milliseconds.

Parameters

milliseconds number of milliseconds

◆ from_secs()

static const Duration dds::core::Duration::from_secs ( double seconds )

static

Create a Duration from a number of seconds.

Parameters

seconds number of seconds

◆ nanosec() [1/2]

uint32_t dds::core::Duration::nanosec ( ) const

Get nanoseconds part of the Duration.

Returns: number of nanoseconds

◆ nanosec() [2/2]

void dds::core::Duration::nanosec ( uint32_t ns )

Set number of nanoseconds.

Parameters

ns	number of nanoseconds

◆ operator!=()

bool dds::core::Duration::operator!= ( const Duration & that ) const

Returns true if the Duration is not equal to the comparator.

Parameters

that	Duration to compare

Returns: comparison result

◆ operator*=()

Duration& dds::core::Duration::operator*= ( uint64_t factor )

Multiply this Duration by a factor.

Parameters

factor the factor to multiply this Duration by

Returns: this Duration * factor

◆ operator+()

const Duration dds::core::Duration::operator+ ( const Duration & other ) const

Add a Duration to Duration.

Parameters

other a Duration

Returns: Duration + other

◆ operator+=()

Duration& dds::core::Duration::operator+= ( const Duration & a_ti )

Add a Duration to this Duration.

Parameters

a_ti	Duration to add

Returns: this Duration + a_ti

◆ operator-()

const Duration dds::core::Duration::operator- ( const Duration & other ) const

Subtract a Duration from Duration.

Parameters

other a Duration

Returns: the Duration - other

◆ operator-=()

Duration& dds::core::Duration::operator-= ( const Duration & a_ti )

Subtract a Duration from this Duration.

Parameters

a_ti	Duration to subtract

Returns: this Duration - a_ti

◆ operator<()

bool dds::core::Duration::operator< ( const Duration & that ) const

Returns true if the Duration is less than the comparator.

Parameters

that	Duration to compare

Returns: comparison result

◆ operator<=()

bool dds::core::Duration::operator<= ( const Duration & that ) const

Returns true if the Duration is less than or equal to the comparator.

Parameters

that	Duration to compare

Returns: comparison result

◆ operator==()

bool dds::core::Duration::operator== ( const Duration & that ) const

Returns true if the Duration is equal to the comparator.

Parameters

that	Duration to compare

Returns: comparison result

◆ operator>()

bool dds::core::Duration::operator> ( const Duration & that ) const

Returns true if the Duration is greater than the comparator.

Parameters

that	Duration to compare

Returns: comparison result

◆ operator>=()

bool dds::core::Duration::operator>= ( const Duration & that ) const

Returns true if the Duration is greater than or equal to the comparator.

Parameters

that	Duration &

◆ sec() [1/2]

int64_t dds::core::Duration::sec ( ) const

Get seconds part of the Duration.

Returns: number of seconds

◆ sec() [2/2]

void dds::core::Duration::sec ( int64_t s )

Set number of seconds.

Parameters

s	number of seconds

◆ to_microsecs()

int64_t dds::core::Duration::to_microsecs ( ) const

Returns this Duration in micro-seconds.

Returns: the duration in micro-seconds

◆ to_millisecs()

int64_t dds::core::Duration::to_millisecs ( ) const

Returns this Duration in milliseconds.

Returns: the duration in milliseconds

◆ to_secs()

double dds::core::Duration::to_secs ( ) const

Returns this Duration in seconds.

Returns: the duration in seconds

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Duration()

Member Function Documentation

◆ compare()

◆ from_microsecs()

◆ from_millisecs()

◆ from_secs()

◆ nanosec() [1/2]

◆ nanosec() [2/2]

◆ operator!=()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ sec() [1/2]

◆ sec() [2/2]

◆ to_microsecs()

◆ to_millisecs()

◆ to_secs()