Represents a duration. More...

#include <ArmarXCore/core/time/Duration.h>

Public Member Functions
	Duration ()
	Constructs a zero-duration.

bool	isPositive () const
	Tests whether the duration is positive (value in µs > 0).

bool	isZero () const

bool	operator!= (const Duration &rhs) const

Duration	operator* (double rhs) const

Duration	operator* (int rhs) const

Duration	operator* (std::int64_t rhs) const

Duration &	operator*= (double rhs)

Duration &	operator*= (int rhs)

Duration &	operator*= (std::int64_t rhs)

Duration	operator+ (const Duration &rhs) const

Duration &	operator+= (const Duration &rhs)

Duration	operator- () const

Duration	operator- (const Duration &rhs) const

Duration &	operator-= (const Duration &rhs)

double	operator/ (const Duration &rhs) const

Duration	operator/ (double rhs) const

Duration	operator/ (int rhs) const

Duration	operator/ (std::int64_t rhs) const

Duration &	operator/= (double rhs)

Duration &	operator/= (int rhs)

Duration &	operator/= (std::int64_t rhs)

bool	operator< (const Duration &rhs) const

bool	operator<= (const Duration &rhs) const

bool	operator== (const Duration &rhs) const

bool	operator> (const Duration &rhs) const

bool	operator>= (const Duration &rhs) const

std::int64_t	toDays () const
	Returns the amount of days.

double	toDaysDouble () const
	Returns the amount of days.

std::string	toDurationString () const
	String representation of the current duration in minimal/default format.

std::string	toDurationString (const std::string &format) const
	String representation of the current duration according to given format string.

std::int64_t	toHours () const
	Returns the amount of hours.

double	toHoursDouble () const
	Returns the amount of hours.

std::int64_t	toMicroSeconds () const
	Returns the amount of microseconds.

double	toMicroSecondsDouble () const
	Returns the amount of microseconds.

std::int64_t	toMilliSeconds () const
	Returns the amount of milliseconds.

double	toMilliSecondsDouble () const
	Returns the amount of milliseconds.

std::int64_t	toMinutes () const
	Returns the amount of minutes.

double	toMinutesDouble () const
	Returns the amount of minutes.

std::int64_t	toSeconds () const
	Returns the amount of seconds.

double	toSecondsDouble () const
	Returns the amount of seconds.

Static Public Member Functions
static Duration	Days (std::int64_t days)
	Constructs a duration in days.

static Duration	DaysDouble (double days)
	Constructs a duration in days.

static Duration	Hours (std::int64_t hours)
	Constructs a duration in hours.

static Duration	HoursDouble (double hours)
	Constructs a duration in hours.

static Duration	MicroSeconds (std::int64_t microSeconds)
	Constructs a duration in microseconds.

static Duration	MicroSecondsDouble (double microSeconds)
	Constructs a duration in microseconds.

static Duration	MilliSeconds (std::int64_t milliSeconds)
	Constructs a duration in milliseconds.

static Duration	MilliSecondsDouble (double milliSeconds)
	Constructs a duration in milliseconds.

static Duration	Minutes (std::int64_t minutes)
	Constructs a duration in minutes.

static Duration	MinutesDouble (double minutes)
	Constructs a duration in minutes.

static Duration	Seconds (std::int64_t seconds)
	Constructs a duration in seconds.

static Duration	SecondsDouble (double seconds)
	Constructs a duration in seconds.

Protected Member Functions
	Duration (std::int64_t microSeconds)

Protected Attributes
std::int64_t	_microSeconds
	Current duration in microseconds.

Detailed Description

Represents a duration.

API and implementation to match IceUtil::Time (where applicable).

Definition at line 16 of file Duration.h.

Constructor & Destructor Documentation

◆ Duration() [1/2]

Duration ( )

Constructs a zero-duration.

Definition at line 13 of file Duration.cpp.

Here is the caller graph for this function:

◆ Duration() [2/2]

Duration ( std::int64_t microSeconds )

protected

Definition at line 18 of file Duration.cpp.

Member Function Documentation

◆ Days()

Duration Days ( std::int64_t days )

static

Constructs a duration in days.

Parameters

days	Amount of days.

Returns: Duration instance.

Definition at line 144 of file Duration.cpp.

Here is the call graph for this function:

◆ DaysDouble()

Duration DaysDouble ( double days )

static

Constructs a duration in days.

Parameters

days	Amount of days.

Returns: Duration instance.

Definition at line 150 of file Duration.cpp.

Here is the call graph for this function:

◆ Hours()

Duration Hours ( std::int64_t hours )

static

Constructs a duration in hours.

Parameters

hours Amount of hours.

Returns: Duration instance.

Definition at line 120 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HoursDouble()

Duration HoursDouble ( double hours )

static

Constructs a duration in hours.

Parameters

hours Amount of hours.

Returns: Duration instance.

Definition at line 126 of file Duration.cpp.

Here is the call graph for this function:

◆ isPositive()

bool isPositive ( ) const

Tests whether the duration is positive (value in µs > 0).

Returns: True if duration is positive, else otherwise.

Definition at line 168 of file Duration.cpp.

Here is the caller graph for this function:

◆ isZero()

bool isZero ( ) const

Definition at line 174 of file Duration.cpp.

◆ MicroSeconds()

Duration MicroSeconds ( std::int64_t microSeconds )

static

Constructs a duration in microseconds.

Parameters

microSeconds Amount of microseconds.

Returns: Duration instance.

Definition at line 24 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MicroSecondsDouble()

Duration MicroSecondsDouble ( double microSeconds )

static

Constructs a duration in microseconds.

Parameters

microSeconds Amount of microseconds.

Returns: Duration instance.

Definition at line 30 of file Duration.cpp.

Here is the call graph for this function:

◆ MilliSeconds()

Duration MilliSeconds ( std::int64_t milliSeconds )

static

Constructs a duration in milliseconds.

Parameters

milliSeconds Amount of milliseconds.

Returns: Duration instance.

Definition at line 48 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MilliSecondsDouble()

Duration MilliSecondsDouble ( double milliSeconds )

static

Constructs a duration in milliseconds.

Parameters

milliSeconds Amount of milliseconds.

Returns: Duration instance.

Definition at line 54 of file Duration.cpp.

Here is the call graph for this function:

◆ Minutes()

Duration Minutes ( std::int64_t minutes )

static

Constructs a duration in minutes.

Parameters

minutes Amount of minutes.

Returns: Duration instance.

Definition at line 96 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MinutesDouble()

Duration MinutesDouble ( double minutes )

static

Constructs a duration in minutes.

Parameters

minutes Amount of minutes.

Returns: Duration instance.

Definition at line 102 of file Duration.cpp.

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const Duration & rhs ) const

Definition at line 378 of file Duration.cpp.

Here is the call graph for this function:

◆ operator*() [1/3]

Duration operator* ( double rhs ) const

Definition at line 276 of file Duration.cpp.

Here is the call graph for this function:

◆ operator*() [2/3]

Duration operator* ( int rhs ) const

Definition at line 284 of file Duration.cpp.

◆ operator*() [3/3]

Duration operator* ( std::int64_t rhs ) const

Definition at line 290 of file Duration.cpp.

◆ operator*=() [1/3]

Duration & operator*= ( double rhs )

Definition at line 296 of file Duration.cpp.

◆ operator*=() [2/3]

Duration & operator*= ( int rhs )

Definition at line 303 of file Duration.cpp.

◆ operator*=() [3/3]

Duration & operator*= ( std::int64_t rhs )

Definition at line 309 of file Duration.cpp.

◆ operator+()

Duration operator+ ( const Duration & rhs ) const

Definition at line 244 of file Duration.cpp.

Here is the call graph for this function:

◆ operator+=()

Duration & operator+= ( const Duration & rhs )

Definition at line 250 of file Duration.cpp.

Here is the call graph for this function:

◆ operator-() [1/2]

Duration operator- ( ) const

Definition at line 257 of file Duration.cpp.

Here is the call graph for this function:

◆ operator-() [2/2]

Duration operator- ( const Duration & rhs ) const

Definition at line 263 of file Duration.cpp.

Here is the call graph for this function:

◆ operator-=()

Duration & operator-= ( const Duration & rhs )

Definition at line 269 of file Duration.cpp.

Here is the call graph for this function:

◆ operator/() [1/4]

double operator/ ( const Duration & rhs ) const

Definition at line 315 of file Duration.cpp.

Here is the call graph for this function:

◆ operator/() [2/4]

Duration operator/ ( double rhs ) const

Definition at line 321 of file Duration.cpp.

Here is the call graph for this function:

◆ operator/() [3/4]

Duration operator/ ( int rhs ) const

Definition at line 329 of file Duration.cpp.

◆ operator/() [4/4]

Duration operator/ ( std::int64_t rhs ) const

Definition at line 335 of file Duration.cpp.

◆ operator/=() [1/3]

Duration & operator/= ( double rhs )

Definition at line 341 of file Duration.cpp.

◆ operator/=() [2/3]

Duration & operator/= ( int rhs )

Definition at line 348 of file Duration.cpp.

◆ operator/=() [3/3]

Duration & operator/= ( std::int64_t rhs )

Definition at line 354 of file Duration.cpp.

◆ operator<()

bool operator< ( const Duration & rhs ) const

Definition at line 359 of file Duration.cpp.

Here is the call graph for this function:

◆ operator<=()

bool operator<= ( const Duration & rhs ) const

Definition at line 365 of file Duration.cpp.

Here is the call graph for this function:

◆ operator==()

bool operator== ( const Duration & rhs ) const

Definition at line 372 of file Duration.cpp.

Here is the call graph for this function:

◆ operator>()

bool operator> ( const Duration & rhs ) const

Definition at line 390 of file Duration.cpp.

Here is the call graph for this function:

◆ operator>=()

bool operator>= ( const Duration & rhs ) const

Definition at line 384 of file Duration.cpp.

Here is the call graph for this function:

◆ Seconds()

Duration Seconds ( std::int64_t seconds )

static

Constructs a duration in seconds.

Parameters

seconds Amount of seconds.

Returns: Duration instance.

Definition at line 72 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SecondsDouble()

Duration SecondsDouble ( double seconds )

static

Constructs a duration in seconds.

Parameters

seconds Amount of seconds.

Returns: Duration instance.

Definition at line 78 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toDays()

std::int64_t toDays ( ) const

Returns the amount of days.

Returns: Amount of days.

Definition at line 156 of file Duration.cpp.

Here is the call graph for this function:

◆ toDaysDouble()

double toDaysDouble ( ) const

Returns the amount of days.

Returns: Amount of days.

Definition at line 162 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toDurationString() [1/2]

std::string toDurationString ( ) const

String representation of the current duration in minimal/default format.

The minimal representation is a float representation with max. 3 decimals. The unit will be determined by the highest unit whose value is non-zero. For example, 3 seconds and 500 milliseconds => "3.5s".

Returns: Formatted duration.

Definition at line 180 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toDurationString() [2/2]

std::string toDurationString ( const std::string & format ) const

String representation of the current duration according to given format string.

The format is according to https://en.cppreference.com/w/cpp/chrono/c/strftime. For milli seconds and micro seconds, special specifiers "%%msec" and "%%usec" were added respectively.

Example format string for "10m 10.987s": "%Mm %S.%%msecs".

Parameters

format Format string.

Returns: Formatted duration.

Definition at line 221 of file Duration.cpp.

◆ toHours()

std::int64_t toHours ( ) const

Returns the amount of hours.

Returns: Amount of hours.

Definition at line 132 of file Duration.cpp.

Here is the call graph for this function:

◆ toHoursDouble()

double toHoursDouble ( ) const

Returns the amount of hours.

Returns: Amount of hours.

Definition at line 138 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toMicroSeconds()

std::int64_t toMicroSeconds ( ) const

Returns the amount of microseconds.

Returns: Amount of microseconds.

Definition at line 36 of file Duration.cpp.

Here is the caller graph for this function:

◆ toMicroSecondsDouble()

double toMicroSecondsDouble ( ) const

Returns the amount of microseconds.

Returns: Amount of microseconds.

Definition at line 42 of file Duration.cpp.

Here is the caller graph for this function:

◆ toMilliSeconds()

std::int64_t toMilliSeconds ( ) const

Returns the amount of milliseconds.

Returns: Amount of milliseconds.

Definition at line 60 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toMilliSecondsDouble()

double toMilliSecondsDouble ( ) const

Returns the amount of milliseconds.

Returns: Amount of milliseconds.

Definition at line 66 of file Duration.cpp.

Here is the caller graph for this function:

◆ toMinutes()

std::int64_t toMinutes ( ) const

Returns the amount of minutes.

Returns: Amount of minutes.

Definition at line 108 of file Duration.cpp.

Here is the call graph for this function:

◆ toMinutesDouble()

double toMinutesDouble ( ) const

Returns the amount of minutes.

Returns: Amount of minutes.

Definition at line 114 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toSeconds()

std::int64_t toSeconds ( ) const

Returns the amount of seconds.

Returns: Amount of seconds.

Definition at line 84 of file Duration.cpp.

Here is the call graph for this function:

◆ toSecondsDouble()

double toSecondsDouble ( ) const

Returns the amount of seconds.

Returns: Amount of seconds.

Definition at line 90 of file Duration.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _microSeconds

std::int64_t _microSeconds

protected

Current duration in microseconds.

Definition at line 270 of file Duration.h.

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

ArmarXCore/core/time/Duration.h
ArmarXCore/core/time/Duration.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Duration() [1/2]

◆ Duration() [2/2]

Member Function Documentation

◆ Days()

◆ DaysDouble()

◆ Hours()

◆ HoursDouble()

◆ isPositive()

◆ isZero()

◆ MicroSeconds()

◆ MicroSecondsDouble()

◆ MilliSeconds()

◆ MilliSecondsDouble()

◆ Minutes()

◆ MinutesDouble()

◆ operator!=()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=() [1/3]

◆ operator*=() [2/3]

◆ operator*=() [3/3]

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/() [1/4]

◆ operator/() [2/4]

◆ operator/() [3/4]

◆ operator/() [4/4]

◆ operator/=() [1/3]

◆ operator/=() [2/3]

◆ operator/=() [3/3]

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ Seconds()

◆ SecondsDouble()

◆ toDays()

◆ toDaysDouble()

◆ toDurationString() [1/2]

◆ toDurationString() [2/2]

◆ toHours()

◆ toHoursDouble()

◆ toMicroSeconds()

◆ toMicroSecondsDouble()

◆ toMilliSeconds()

◆ toMilliSecondsDouble()

◆ toMinutes()

◆ toMinutesDouble()

◆ toSeconds()

◆ toSecondsDouble()

Member Data Documentation

◆ _microSeconds