This class defines the interface for accessing the elapsed time since power up and/or reset of the platform. More...

Detailed Description

This class defines the interface for accessing the elapsed time since power up and/or reset of the platform.

Elapsed time in provided in three different formats:milliseconds, seconds, and seconds with milliseconds precision. All time formats are guaranteed to be synchronized with each other.

#include <ElapsedTime.h>

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

Static Public Member Functions
static unsigned long	seconds () noexcept
	This method returns the elapsed time, in seconds, since the system was powered on and/or reset.

static unsigned long	milliseconds () noexcept
	This method returns the elapsed time, in milliseconds, since the system was powered on and/or reset.

static Precision_T	precision () noexcept
	This method returns the elapsed time, in seconds with milliseconds precision, since the system was powered on and/or reset.

static unsigned long	deltaMilliseconds (unsigned long startTime, unsigned long endTime=milliseconds()) noexcept
	This method returns the delta time, in milliseconds, between the specified 'startTime' and 'endTime'.

static unsigned long	deltaSeconds (unsigned long startTime, unsigned long endTime=seconds()) noexcept
	This method returns the delta time, in seconds, between the specified 'startTime' and 'endTime'.

static Precision_T	deltaPrecision (Precision_T startTime, Precision_T endTime=precision()) noexcept
	This method returns the delta time, in Precision time, between the specified 'startTime' and 'endTime'.

static bool	expiredMilliseconds (unsigned long timeMarker, unsigned long duration, unsigned long currentTime=milliseconds()) noexcept
	This method returns true if the specified amount of time has elapsed since the 'timeMarker'.

static bool	expiredSeconds (unsigned long timeMarker, unsigned long duration, unsigned long currentTime=seconds()) noexcept
	This method returns true if the specified amount of time has elapsed since the 'timeMarker'.

static bool	expiredPrecision (Precision_T timeMarker, Precision_T duration, Precision_T currentTime=precision()) noexcept
	This method returns true if the specified amount of time has elapsed since the 'timeMarker'.

static void	initializeWithSeconds (Precision_T &dst, unsigned long seconds)
	This method will initialize the contents 'dst' to the number of seconds specified by 'seconds' and set the m_thousandths field to zero.

static void	initializeWithMilliseconds (Precision_T &dst, unsigned long msec)
	This method will initialize the contents of 'dst' to the number of milliseconds specified by 'msec'.

static unsigned long	secondsInRealTime () noexcept
	This method is the same as seconds(), EXCEPT that is ALWAYS guaranteed to return elapsed time in 'real time'.

static unsigned long	millisecondsInRealTime () noexcept
	This method is the same as milliseconds(), EXCEPT that is ALWAYS guaranteed to return elapsed time in 'real time'.

static Precision_T	precisionInRealTime () noexcept
	This method is the same as precision(), EXCEPT that is ALWAYS guaranteed to return elapsed time in 'real time'.

Member Function Documentation

◆ deltaMilliseconds()

static unsigned long Cpl::System::ElapsedTime::deltaMilliseconds	(	unsigned long	startTime,
		unsigned long	endTime = `milliseconds()`
	)

inlinestaticnoexcept

This method returns the delta time, in milliseconds, between the specified 'startTime' and 'endTime'.

'endTime' is defaulted to NOW (i.e. a call to milliseconds(). The calculation properly handles the scenario of when the has been 'roll over' between the two times.

◆ deltaPrecision()

static Precision_T Cpl::System::ElapsedTime::deltaPrecision	(	Precision_T	startTime,
		Precision_T	endTime = `precision()`
	)

staticnoexcept

This method returns the delta time, in Precision time, between the specified 'startTime' and 'endTime'.

'endTime' is defaulted to NOW (i.e. a call to precision(). The calculation properly handles the scenario of when the has been 'roll over' between the two times.

◆ deltaSeconds()

static unsigned long Cpl::System::ElapsedTime::deltaSeconds	(	unsigned long	startTime,
		unsigned long	endTime = `seconds()`
	)

inlinestaticnoexcept

This method returns the delta time, in seconds, between the specified 'startTime' and 'endTime'.

'endTime' is defaulted to NOW (i.e. a call to seconds(). The calculation properly handles the scenario of when the has been 'roll over' between the two times.

◆ expiredMilliseconds()

static bool Cpl::System::ElapsedTime::expiredMilliseconds	(	unsigned long	timeMarker,
		unsigned long	duration,
		unsigned long	currentTime = `milliseconds()`
	)

inlinestaticnoexcept

This method returns true if the specified amount of time has elapsed since the 'timeMarker'.

The calculation properly handles the scenario of when the has been 'roll over' between the 'timeMarker' and NOW.

◆ expiredPrecision()

static bool Cpl::System::ElapsedTime::expiredPrecision	(	Precision_T	timeMarker,
		Precision_T	duration,
		Precision_T	currentTime = `precision()`
	)

staticnoexcept

This method returns true if the specified amount of time has elapsed since the 'timeMarker'.

The calculation properly handles the scenario of when the has been 'roll over' between the 'timeMarker' and NOW.

◆ expiredSeconds()

static bool Cpl::System::ElapsedTime::expiredSeconds	(	unsigned long	timeMarker,
		unsigned long	duration,
		unsigned long	currentTime = `seconds()`
	)

inlinestaticnoexcept

This method returns true if the specified amount of time has elapsed since the 'timeMarker'.

The calculation properly handles the scenario of when the has been 'roll over' between the 'timeMarker' and NOW.

◆ initializeWithMilliseconds()

static void Cpl::System::ElapsedTime::initializeWithMilliseconds	(	Precision_T &	dst,
		unsigned long	msec
	)

inlinestatic

This method will initialize the contents of 'dst' to the number of milliseconds specified by 'msec'.

If 'msec' is greater than 1000, the m_seconds field will be populate with the "overflow".

◆ initializeWithSeconds()

static void Cpl::System::ElapsedTime::initializeWithSeconds	(	Precision_T &	dst,
		unsigned long	seconds
	)

inlinestatic

This method will initialize the contents 'dst' to the number of seconds specified by 'seconds' and set the m_thousandths field to zero.

◆ milliseconds()

static unsigned long Cpl::System::ElapsedTime::milliseconds ( )

staticnoexcept

This method returns the elapsed time, in milliseconds, since the system was powered on and/or reset.

The elapsed time is free running counter that will roll over once the range of the data type is exceeded.

◆ millisecondsInRealTime()

static unsigned long Cpl::System::ElapsedTime::millisecondsInRealTime ( )

staticnoexcept

This method is the same as milliseconds(), EXCEPT that is ALWAYS guaranteed to return elapsed time in 'real time'.

See the Cpl::System::SimTick for more details about real time vs. simulated time. It is recommended the application NOT CALL this method because then that code can NOT be simulated using the SimTick interface.

◆ precision()

static Precision_T Cpl::System::ElapsedTime::precision ( )

staticnoexcept

This method returns the elapsed time, in seconds with milliseconds precision, since the system was powered on and/or reset.

The elapsed second time is free running counter that will roll over once the range of the data type is exceeded.

◆ precisionInRealTime()

static Precision_T Cpl::System::ElapsedTime::precisionInRealTime ( )

staticnoexcept

This method is the same as precision(), EXCEPT that is ALWAYS guaranteed to return elapsed time in 'real time'.

See the Cpl::System::SimTick for more details about real time vs. simulated time. It is recommended the application NOT CALL this method because then that code can NOT be simulated using the SimTick interface.

◆ seconds()

static unsigned long Cpl::System::ElapsedTime::seconds ( )

staticnoexcept

This method returns the elapsed time, in seconds, since the system was powered on and/or reset.

The elapsed time is free running counter that will roll over once the range of the data type is exceeded.

◆ secondsInRealTime()

static unsigned long Cpl::System::ElapsedTime::secondsInRealTime ( )

staticnoexcept

This method is the same as seconds(), EXCEPT that is ALWAYS guaranteed to return elapsed time in 'real time'.

See the Cpl::System::SimTick for more details about real time vs. simulated time. It is recommended the application NOT CALL this method because then that code can NOT be simulated using the SimTick interface.

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

Cpl/System/ElapsedTime.h

Detailed Description

Classes

Static Public Member Functions

Member Function Documentation

◆ deltaMilliseconds()

◆ deltaPrecision()

◆ deltaSeconds()

◆ expiredMilliseconds()

◆ expiredPrecision()

◆ expiredSeconds()

◆ initializeWithMilliseconds()

◆ initializeWithSeconds()

◆ milliseconds()

◆ millisecondsInRealTime()

◆ precision()

◆ precisionInRealTime()

◆ seconds()

◆ secondsInRealTime()