Cpl::System::TimerComposer< CONTEXT > Class Template Reference

This template class implements a Software Timer that is context independent and allows for a single context to contain many Timers. More...

Detailed Description

template<class CONTEXT>
class Cpl::System::TimerComposer< CONTEXT >

This template class implements a Software Timer that is context independent and allows for a single context to contain many Timers.

Template args: CONTEXT Type of the Class that implements the context for the timer

#include <Timer.h>

Inheritance diagram for Cpl::System::TimerComposer< CONTEXT >:

Collaboration diagram for Cpl::System::TimerComposer< CONTEXT >:

Public Types
typedef void(CONTEXT::*	TimerExpiredFunction_T) ()
	Definition of the call-back method that notifies the context/client when the timer expires.

Public Member Functions
	TimerComposer (TimerManager &timingSource, CONTEXT &timerContextInstance, TimerExpiredFunction_T expiredCallbackFunc)
	Constructor.
	TimerComposer (CONTEXT &timerContextInstance, TimerExpiredFunction_T expiredCallbackFunc)
	Alternate Constructor that is used to defer the assignment of the time source.
Public Member Functions inherited from Cpl::System::Timer
	Timer (TimerManager &timingSource)
	Constructor
	Timer ()
	Constructor. Alternate constructor - that defers the assignment of the timing source
virtual void	start (unsigned long timerDurationInMilliseconds) noexcept
	Starts the timer with an initial count down count duration of 'timerDurationInMilliseconds'.
virtual void	stop () noexcept
	Stops the timer.
unsigned long	count () const noexcept
	Returns the current count (in milliseconds)
virtual void	setTimingSource (TimerManager &timingSource) noexcept
	Sets the timing source.
Public Member Functions inherited from Cpl::System::CounterCallback_
virtual	~CounterCallback_ ()
	Virtual Destructor.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Member Functions
void	expired () noexcept
	See Cpl::System::CounterCallback_.
Protected Member Functions inherited from Cpl::System::Timer
void	decrement (unsigned long milliseconds=1) noexcept
	See Cpl::System::CounterCallback_.
void	increment (unsigned long milliseconds) noexcept
	See Cpl::System::CounterCallback_.
Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.
	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Attributes inherited from Cpl::System::Timer
TimerManager *	m_timingSource
	The timer's tick source.
unsigned long	m_count
	Current count.

Member Typedef Documentation

TimerExpiredFunction_T

template<class CONTEXT >

typedef void(CONTEXT::* Cpl::System::TimerComposer< CONTEXT >::TimerExpiredFunction_T) ()

Definition of the call-back method that notifies the context/client when the timer expires.

Constructor & Destructor Documentation

TimerComposer() [1/2]

template<class CONTEXT >

Cpl::System::TimerComposer< CONTEXT >::TimerComposer	(	TimerManager &	timingSource,
		CONTEXT &	timerContextInstance,
		TimerExpiredFunction_T	expiredCallbackFunc )

Constructor.

TimerComposer() [2/2]

template<class CONTEXT >

Cpl::System::TimerComposer< CONTEXT >::TimerComposer	(	CONTEXT &	timerContextInstance,
		TimerExpiredFunction_T	expiredCallbackFunc )

Alternate Constructor that is used to defer the assignment of the time source.

When using this constructor - the Application logic is REQUIRED to use the setTimingSource() method to set the timing source BEFORE the timer is used.

Member Function Documentation

expired()

template<class CONTEXT >

void Cpl::System::TimerComposer< CONTEXT >::expired ( void )

protectedvirtualnoexcept

See Cpl::System::CounterCallback_.

Implements Cpl::System::CounterCallback_.

---

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

• Cpl/System/Timer.h