Cpl::System::PeriodicScheduler::Interval_T Struct Reference

Defines an interval. More...

Detailed Description

Defines an interval.

The application should treat this data struct as an opaque structure.

#include <PeriodicScheduler.h>

Collaboration diagram for Cpl::System::PeriodicScheduler::Interval_T:

Public Member Functions
	Interval_T (IntervalCallbackFunc_T callbackFunc, ElapsedTime::Precision_T periodTime, void *context=nullptr)
	Constructor.
IntervalCallbackFunc_T	getCallbackFunction ()
	Data accessor.
ElapsedTime::Precision_T	getDuration ()
	Data accessor.
void *	getContext ()
	Data accessor.

Public Attributes
IntervalCallbackFunc_T	callbackFunc
	Callback function pointer.
void *	context
	Optional Context for the callback.
ElapsedTime::Precision_T	duration
	The amount time in the Interval's period.
ElapsedTime::Precision_T	timeMarker
	Internal Use ONLY: Marks the last time the interval executed

Constructor & Destructor Documentation

Interval_T()

Cpl::System::PeriodicScheduler::Interval_T::Interval_T ( IntervalCallbackFunc_T  callbackFunc, ElapsedTime::Precision_T  periodTime, void *  context = nullptr  )

inline

Constructor.

Member Function Documentation

getCallbackFunction()

IntervalCallbackFunc_T Cpl::System::PeriodicScheduler::Interval_T::getCallbackFunction ( )

inline

Data accessor.

getContext()

void * Cpl::System::PeriodicScheduler::Interval_T::getContext ( )

inline

Data accessor.

getDuration()

ElapsedTime::Precision_T Cpl::System::PeriodicScheduler::Interval_T::getDuration ( )

inline

Data accessor.

Member Data Documentation

callbackFunc

IntervalCallbackFunc_T Cpl::System::PeriodicScheduler::Interval_T::callbackFunc

Callback function pointer.

context

void* Cpl::System::PeriodicScheduler::Interval_T::context

Optional Context for the callback.

The callback function is required to 'understand' the actual type of the context pointer being passed to it.

duration

ElapsedTime::Precision_T Cpl::System::PeriodicScheduler::Interval_T::duration

The amount time in the Interval's period.

timeMarker

ElapsedTime::Precision_T Cpl::System::PeriodicScheduler::Interval_T::timeMarker

Internal Use ONLY: Marks the last time the interval executed

---

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

• Cpl/System/PeriodicScheduler.h