Cpl::System::ElapsedTime::Precision_T Struct Reference

Data type for time in seconds with a 'fractional' millisecond precision. More...

Detailed Description

Data type for time in seconds with a 'fractional' millisecond precision.

#include <ElapsedTime.h>

Public Member Functions
bool	operator== (Precision_T const other) const
	Comparison operator (explicitly provided to avoid potential issue with pad bytes in the structure)
bool	operator!= (Precision_T const other) const
	Not equals operator.
Precision_T &	operator+= (const Precision_T &x)
	Increment elapsed time by 'x'.
bool	operator> (Precision_T const other) const
	Greater than (i.e. is this instance newer/more-recent then 'other')
bool	operator>= (Precision_T const other) const
	Greater than or equal (i.e. is this instance the same as 'other' or is it newer/more-recent then 'other')
bool	operator< (Precision_T const other) const
	less than (i.e. is this instance older then 'other')
bool	operator<= (Precision_T const other) const
	less than or equal (i.e. is this instance the same as 'other' or is it older then 'other')
Precision_T &	setFromMilliseconds (uint32_t milliseconds)
	Sets the Precision value from a millisecond value.
Precision_T &	operator= (uint32_t milliseconds)
	Assign my value based on total milliseconds.
uint64_t	asFlatTime () const
	Converts the instance's time into as a single 'large' integer value in milliseconds.
void	setFlatTime (uint64_t flatTimeInMs)
	Sets the instance's time from a single 'large' integer value in milliseconds.
unsigned long	asMilliseconds () const
	Converts the instance's time to milliseconds.
	Precision_T ()
	Constructor (to ensure any pad bytes get zero'd)
	Precision_T (unsigned long seconds, uint16_t thousandths)
	Constructor (to ensure any pad bytes get zero'd)
	Precision_T (uint64_t flatTimeInMs)
	Constructor (to ensure any pad bytes get zero'd)
	Precision_T (const Precision_T &other)
	Copy Constructor (to ensure any pad bytes get zero'd)
Precision_T &	operator= (const Precision_T &other)
	Copy operator.

Public Attributes
unsigned long	m_seconds
	Total number of elapsed seconds.
uint16_t	m_thousandths
	fractional number of milliseconds (i.e.

Constructor & Destructor Documentation

Precision_T() [1/4]

Cpl::System::ElapsedTime::Precision_T::Precision_T ( )

inline

Constructor (to ensure any pad bytes get zero'd)

Precision_T() [2/4]

Cpl::System::ElapsedTime::Precision_T::Precision_T ( unsigned long  seconds, uint16_t  thousandths  )

inline

Constructor (to ensure any pad bytes get zero'd)

Precision_T() [3/4]

Cpl::System::ElapsedTime::Precision_T::Precision_T ( uint64_t  flatTimeInMs )

inline

Constructor (to ensure any pad bytes get zero'd)

Precision_T() [4/4]

Cpl::System::ElapsedTime::Precision_T::Precision_T ( const Precision_T &  other )

inline

Copy Constructor (to ensure any pad bytes get zero'd)

Member Function Documentation

asFlatTime()

uint64_t Cpl::System::ElapsedTime::Precision_T::asFlatTime ( ) const

inline

Converts the instance's time into as a single 'large' integer value in milliseconds.

asMilliseconds()

unsigned long Cpl::System::ElapsedTime::Precision_T::asMilliseconds ( ) const

inline

Converts the instance's time to milliseconds.

The result CAN be incorrect if the actual number of milliseconds is greater than what can be stored in an unsigned long (e.g. a 32 bit unsigned integer can only contain ~47 days 'of milliseconds'). USE WITH CAUTION.

operator!=()

bool Cpl::System::ElapsedTime::Precision_T::operator!= ( Precision_T const  other ) const

inline

Not equals operator.

operator+=()

Precision_T & Cpl::System::ElapsedTime::Precision_T::operator+=

(

const Precision_T &

x

)

Increment elapsed time by 'x'.

operator<()

bool Cpl::System::ElapsedTime::Precision_T::operator<

(

Precision_T const

other

)

const

less than (i.e. is this instance older then 'other')

operator<=()

bool Cpl::System::ElapsedTime::Precision_T::operator<=

(

Precision_T const

other

)

const

less than or equal (i.e. is this instance the same as 'other' or is it older then 'other')

operator=() [1/2]

Precision_T & Cpl::System::ElapsedTime::Precision_T::operator= ( const Precision_T &  other )

inline

Copy operator.

operator=() [2/2]

Precision_T & Cpl::System::ElapsedTime::Precision_T::operator=

(

uint32_t

milliseconds

)

Assign my value based on total milliseconds.

operator==()

bool Cpl::System::ElapsedTime::Precision_T::operator== ( Precision_T const  other ) const

inline

Comparison operator (explicitly provided to avoid potential issue with pad bytes in the structure)

operator>()

bool Cpl::System::ElapsedTime::Precision_T::operator>

(

Precision_T const

other

)

const

Greater than (i.e. is this instance newer/more-recent then 'other')

operator>=()

bool Cpl::System::ElapsedTime::Precision_T::operator>=

(

Precision_T const

other

)

const

Greater than or equal (i.e. is this instance the same as 'other' or is it newer/more-recent then 'other')

setFlatTime()

void Cpl::System::ElapsedTime::Precision_T::setFlatTime ( uint64_t  flatTimeInMs )

inline

Sets the instance's time from a single 'large' integer value in milliseconds.

setFromMilliseconds()

Precision_T & Cpl::System::ElapsedTime::Precision_T::setFromMilliseconds

(

uint32_t

milliseconds

)

Sets the Precision value from a millisecond value.

Member Data Documentation

m_seconds

unsigned long Cpl::System::ElapsedTime::Precision_T::m_seconds

Total number of elapsed seconds.

m_thousandths

uint16_t Cpl::System::ElapsedTime::Precision_T::m_thousandths

fractional number of milliseconds (i.e.

a value between 0 and 999)

---

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

• Cpl/System/ElapsedTime.h