Cpl::System::CounterCallback_ Class Reference

This abstract class defines the call-back interface for a Counter object. More...

Detailed Description

This abstract class defines the call-back interface for a Counter object.

A Counter object is used to maintain a counter down mechanism for tracking the time remaining for an individual timer.

The Counter interface is NOT inherently thread safe.

#include <Counter_.h>

Inheritance diagram for Cpl::System::CounterCallback_:

Collaboration diagram for Cpl::System::CounterCallback_:

Public Member Functions
virtual void	expired (void) noexcept=0
	Notification of the count reaching zero.
virtual void	decrement (unsigned long milliseconds=1) noexcept=0
	Decrements the counter.
virtual void	increment (unsigned long milliseconds) noexcept=0
	Increments the counter.
virtual unsigned long	count () const noexcept=0
	Returns the current count (in milliseconds)
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.

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 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.

Constructor & Destructor Documentation

~CounterCallback_()

virtual Cpl::System::CounterCallback_::~CounterCallback_ ( )

inlinevirtual

Virtual Destructor.

Member Function Documentation

count()

virtual unsigned long Cpl::System::CounterCallback_::count ( ) const

pure virtualnoexcept

Returns the current count (in milliseconds)

Implemented in Cpl::System::Timer.

decrement()

virtual void Cpl::System::CounterCallback_::decrement ( unsigned long  milliseconds = 1 )

pure virtualnoexcept

Decrements the counter.

Implemented in Cpl::System::Timer.

expired()

virtual void Cpl::System::CounterCallback_::expired ( void  )

pure virtualnoexcept

Notification of the count reaching zero.

Implemented in Ajax::Heating::Io::Api, Ajax::Heating::Supervisor::Api, Ajax::Metrics::Api, Ajax::Ui::StatusIndicator::Api, Cpl::System::TimerComposer< CONTEXT >, Cpl::System::TimerComposer< Ajax::ScreenMgr::Api >, Ajax::Ui::LogicalButtons, Cpl::Dm::Persistent::Record, Cpl::MApp::Temperature::Api, Driver::AIO::Ajax::Thermistor, and Eros::Test::Cycle::Api.

increment()

virtual void Cpl::System::CounterCallback_::increment ( unsigned long  milliseconds )

pure virtualnoexcept

Increments the counter.

Implemented in Cpl::System::Timer.

---

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

• Cpl/System/Counter_.h