Cpl::Dm::Subscriber< MP > Class Template Reference

This template class defines a type safe Subscriber. More...

Detailed Description

template<class MP>
class Cpl::Dm::Subscriber< MP >

This template class defines a type safe Subscriber.

Template Arguments: MP - The concrete Model Point Type

#include <Subscriber.h>

Inheritance diagram for Cpl::Dm::Subscriber< MP >:

Collaboration diagram for Cpl::Dm::Subscriber< MP >:

Public Member Functions
virtual void	modelPointChanged (MP &modelPointThatChanged, SubscriberApi &clientObserver) noexcept=0
	Type safe change notification. See Cpl::Dm::SubscriberApi.
	Subscriber (Cpl::Dm::EventLoop &myEventLoop)
	Constructor.
Public Member Functions inherited from Cpl::Dm::SubscriberBase
	SubscriberBase (Cpl::Dm::EventLoop &myEventLoop)
	Constructor.
NotificationApi_ *	getNotificationApi_ () const noexcept
	See Cpl::Dm::SubscriberApi.
void	setModelPoint_ (ModelPoint *modelPoint) noexcept
	See Cpl::Dm::SubscriberApi.
ModelPoint *	getModelPoint_ () noexcept
	See Cpl::Dm::SubscriberApi.
int	getState_ () const noexcept
	See Cpl::Dm::SubscriberApi.
void	setState_ (int newState) noexcept
	See Cpl::Dm::SubscriberApi.
uint16_t	getSequenceNumber_ () const noexcept
	See Cpl::Dm::SubscriberApi.
void	setSequenceNumber_ (uint16_t newSeqNumber) noexcept
	See Cpl::Dm::SubscriberApi.
Public Member Functions inherited from Cpl::Dm::SubscriberApi
virtual	~SubscriberApi ()
	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	genericModelPointChanged_ (ModelPoint &modelPointThatChanged, SubscriberApi &clientObserver) noexcept
	See Cpl::Dm::SubscriberApi.
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::Dm::SubscriberBase
int	m_state
	Internal state of the subscriber. Note: The state is actual managed by the Model Point.
ModelPoint *	m_point
	Pointer to the Model Point the instance is subscribed to.
Cpl::Dm::EventLoop &	m_eventLoopHdl
	Reference to subscriber's EventFlag/Mailbox server.
uint16_t	m_seqNumber
	Sequence number of the subscriber.

Constructor & Destructor Documentation

Subscriber()

template<class MP >

Cpl::Dm::Subscriber< MP >::Subscriber ( Cpl::Dm::EventLoop & myEventLoop )

inline

Constructor.

Member Function Documentation

genericModelPointChanged_()

template<class MP >

void Cpl::Dm::Subscriber< MP >::genericModelPointChanged_ ( ModelPoint & modelPointThatChanged, SubscriberApi & clientObserver )

inlineprotectedvirtualnoexcept

See Cpl::Dm::SubscriberApi.

Implements Cpl::Dm::SubscriberApi.

modelPointChanged()

template<class MP >

virtual void Cpl::Dm::Subscriber< MP >::modelPointChanged ( MP & modelPointThatChanged, SubscriberApi & clientObserver )

pure virtualnoexcept

Type safe change notification. See Cpl::Dm::SubscriberApi.

Implemented in Cpl::Dm::SubscriberComposer< Ajax::Metrics::Api, Ajax::Dm::MpAlert >, Cpl::Dm::SubscriberComposer< Ajax::Ui::Home::Screen, Ajax::Dm::MpAlertSummary >, Cpl::Dm::SubscriberComposer< Ajax::Ui::Home::Screen, Ajax::Dm::MpFanMode >, Cpl::Dm::SubscriberComposer< Ajax::ScreenMgr::Api, Ajax::ScreenMgr::MpScreenApiPtr >, Cpl::Dm::SubscriberComposer< Ajax::ScreenMgr::Api, Ajax::ScreenMgr::MpStaticScreenApiPtr >, Cpl::Dm::SubscriberComposer< Cpl::Dm::Persistent::Record, Cpl::Dm::ModelPoint >, Cpl::Dm::SubscriberComposer< Eros::Test::Thermistor::Api, Cpl::Dm::Mp::ArrayInt32< 2 > >, Cpl::Dm::SubscriberComposer< Ajax::Heating::Supervisor::Api, Cpl::Dm::Mp::Bool >, Cpl::Dm::SubscriberComposer< Ajax::ScreenMgr::Api, Cpl::Dm::Mp::Bool >, Cpl::Dm::SubscriberComposer< Ajax::Ui::Home::Screen, Cpl::Dm::Mp::Bool >, Cpl::Dm::SubscriberComposer< Ajax::Ui::Home::Screen, Cpl::Dm::Mp::Int32 >, Cpl::Dm::SubscriberComposer< Ajax::Heating::Io::Api, Cpl::Dm::Mp::Uint32 >, Cpl::Dm::SubscriberComposer< Ajax::Metrics::Api, Cpl::Dm::Mp::Uint32 >, Cpl::Dm::SubscriberComposer< Ajax::ScreenMgr::Api, Cpl::Dm::Mp::Uint32 >, Cpl::Dm::SubscriberComposer< Cpl::Logging::LogSink, Cpl::Dm::Mp::Uint32 >, Cpl::Dm::SubscriberComposer< Cpl::Persistent::IndexedEntryServer, Cpl::Dm::Mp::Uint32 >, and Cpl::Dm::SubscriberComposer< CONTEXT, MP >.

---

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

• Cpl/Dm/Subscriber.h