This mostly concrete class defines the Subscriber interface - for change notifications - to a Model Points data/state. More...

Detailed Description

This mostly concrete class defines the Subscriber interface - for change notifications - to a Model Points data/state.

#include <Subscriber.h>

Inheritance diagram for Cpl::Dm::SubscriberBase:

Collaboration diagram for Cpl::Dm::SubscriberBase:

Public Member Functions
	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 void	genericModelPointChanged_ (ModelPoint &modelPointThatChanged, SubscriberApi &clientObserver) noexcept=0
	This method has PACKAGE Scope, i.e.

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

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.