Cpl::Dm::SubscriberApi Class Reference

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

Detailed Description

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

#include <SubscriberApi.h>

Inheritance diagram for Cpl::Dm::SubscriberApi:

Collaboration diagram for Cpl::Dm::SubscriberApi:

Public Member Functions
virtual void	genericModelPointChanged_ (ModelPoint &modelPointThatChanged, SubscriberApi &clientObserver) noexcept=0
	This method has PACKAGE Scope, i.e.
virtual NotificationApi_ *	getNotificationApi_ () const noexcept=0
	This method has PACKAGE Scope, i.e.
virtual void	setModelPoint_ (ModelPoint *modelPoint) noexcept=0
	This method has PACKAGE Scope, i.e.
virtual ModelPoint *	getModelPoint_ () noexcept=0
	This method has PACKAGE Scope, i.e.
virtual int	getState_ () const noexcept=0
	This method has PACKAGE Scope, i.e.
virtual void	setState_ (int newState) noexcept=0
	This method has PACKAGE Scope, i.e.
virtual uint16_t	getSequenceNumber_ () const noexcept=0
	This method has PACKAGE Scope, i.e.
virtual void	setSequenceNumber_ (uint16_t newSeqNumber) 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.

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

~SubscriberApi()

virtual Cpl::Dm::SubscriberApi::~SubscriberApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

genericModelPointChanged_()

virtual void Cpl::Dm::SubscriberApi::genericModelPointChanged_ ( ModelPoint &  modelPointThatChanged, SubscriberApi &  clientObserver  )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is the client's callback function for a MP change notification. This method is called in as part of the asynchronous notification mechanism of the subscriber's Mailbox Server, i.e. executes in the thread associated m_mailBoxHdl

Implemented in Cpl::Dm::Subscriber< MP >, Cpl::Dm::Subscriber< Ajax::Dm::MpAlert >, Cpl::Dm::Subscriber< Ajax::Dm::MpAlertSummary >, Cpl::Dm::Subscriber< Ajax::Dm::MpFanMode >, Cpl::Dm::Subscriber< Ajax::ScreenMgr::MpScreenApiPtr >, Cpl::Dm::Subscriber< Ajax::ScreenMgr::MpStaticScreenApiPtr >, Cpl::Dm::Subscriber< Cpl::Dm::ModelPoint >, Cpl::Dm::Subscriber< Cpl::Dm::Mp::ArrayInt32< 2 > >, Cpl::Dm::Subscriber< Cpl::Dm::Mp::Bool >, Cpl::Dm::Subscriber< Cpl::Dm::Mp::Int32 >, and Cpl::Dm::Subscriber< Cpl::Dm::Mp::Uint32 >.

getModelPoint_()

virtual ModelPoint * Cpl::Dm::SubscriberApi::getModelPoint_ ( )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is use to get the Subscriber's Model Point reference.

Note: If this method is called BEFORE the setModelPoint() method is called then a Fatal Error will be generated.

Implemented in Cpl::Dm::SubscriberBase.

getNotificationApi_()

virtual NotificationApi_ * Cpl::Dm::SubscriberApi::getNotificationApi_ ( ) const

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method returns a pointer to the Subscriber's mailbox

Implemented in Cpl::Dm::SubscriberBase.

getSequenceNumber_()

virtual uint16_t Cpl::Dm::SubscriberApi::getSequenceNumber_ ( ) const

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is use to get the Subscriber's sequence number

Implemented in Cpl::Dm::SubscriberBase.

getState_()

virtual int Cpl::Dm::SubscriberApi::getState_ ( ) const

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is use to get the Subscriber's internal state

Implemented in Cpl::Dm::SubscriberBase.

setModelPoint_()

virtual void Cpl::Dm::SubscriberApi::setModelPoint_ ( ModelPoint *  modelPoint )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is use to set the Subscriber's Model Point reference

Implemented in Cpl::Dm::SubscriberBase.

setSequenceNumber_()

virtual void Cpl::Dm::SubscriberApi::setSequenceNumber_ ( uint16_t  newSeqNumber )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is use to set the Subscriber's sequence number

Implemented in Cpl::Dm::SubscriberBase.

setState_()

virtual void Cpl::Dm::SubscriberApi::setState_ ( int  newState )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is use to set the Subscriber's internal state

Implemented in Cpl::Dm::SubscriberBase.

---

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

• Cpl/Dm/SubscriberApi.h