Ajax::Alerts::Summary Class Reference

This class manages the content of the Alert Summary model point. More...

Detailed Description

This class manages the content of the Alert Summary model point.

#include <Summary.h>

Inheritance diagram for Ajax::Alerts::Summary:

Collaboration diagram for Ajax::Alerts::Summary:

Public Types
typedef Cpl::Dm::SubscriberComposer< Summary, Ajax::Dm::MpAlert >	AlertObserver
	Convenience type.
typedef Cpl::Memory::AlignedClass< AlertObserver >	AlertComposerMemory
	Type for allocating memory for Alert Observer composer instances.
Public Types inherited from Cpl::Itc::OpenRequest
typedef Cpl::Itc::SAP< OpenRequest >	SAP
	SAP for this API.
typedef RequestMessage< OpenRequest, OpenPayload >	OpenMsg
	Message Type: Open.
Public Types inherited from Cpl::Itc::CloseRequest
typedef Cpl::Itc::SAP< CloseRequest >	SAP
	SAP for this API.
typedef RequestMessage< CloseRequest, ClosePayload >	CloseMsg
	Message Type: Close.

Public Member Functions
	Summary (Cpl::Dm::MailboxServer &myMbox, Ajax::Dm::MpAlert *alertList[])
	Constructor.
void	request (OpenMsg &msg)
	Starts the component.
void	request (CloseMsg &msg)
	Shutdowns the component.
Public Member Functions inherited from Cpl::Itc::CloseSync
	CloseSync (PostApi &myMbox) noexcept
	Constructor.
bool	close (void *args=nullptr)
	See CloseSync.
Public Member Functions inherited from Cpl::Itc::OpenSync
	OpenSync (PostApi &myMbox) noexcept
	Constructor.
bool	open (void *args=nullptr)
	See OpenApi.
Public Member Functions inherited from Cpl::Itc::OpenApi
virtual	~OpenApi ()
	Virtual destructor.
Public Member Functions inherited from Cpl::Itc::CloseApi
virtual	~CloseApi ()
	Virtual destructor.

Protected Member Functions
void	alertChanged (Ajax::Dm::MpAlert &mpThatChanged, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Change notification: Alerts.

Protected Attributes
AlertComposerMemory	m_observers [Ajax::Type::Alert::NUM_ALERTS]
	Observer for change notifications.
Ajax::Dm::MpAlert **	m_alertList
	Array of Alert Model Point pointers.
Cpl::Dm::EventLoop &	m_eventLoop
	Reference to the Event loop (needed when constructing Observers)
bool	m_opened
	open/close state
Protected Attributes inherited from Cpl::Itc::OpenSync
PostApi &	m_mbox
	Mailbox (of the server implementing the ITC request() method.

Member Typedef Documentation

AlertComposerMemory

typedef Cpl::Memory::AlignedClass<AlertObserver> Ajax::Alerts::Summary::AlertComposerMemory

Type for allocating memory for Alert Observer composer instances.

AlertObserver

typedef Cpl::Dm::SubscriberComposer<Summary, Ajax::Dm::MpAlert> Ajax::Alerts::Summary::AlertObserver

Convenience type.

Constructor & Destructor Documentation

Summary()

Ajax::Alerts::Summary::Summary	(	Cpl::Dm::MailboxServer &	myMbox,
		Ajax::Dm::MpAlert *	alertList[] )

Constructor.

Note: The number of elements in the two array argument MUST equal Ajax::Type::Alert::NUM_ALERTS

Member Function Documentation

alertChanged()

void Ajax::Alerts::Summary::alertChanged ( Ajax::Dm::MpAlert & mpThatChanged, Cpl::Dm::SubscriberApi & clientObserver )

protectednoexcept

Change notification: Alerts.

request() [1/2]

void Ajax::Alerts::Summary::request ( CloseMsg & msg )

virtual

Shutdowns the component.

Implements Cpl::Itc::CloseRequest.

request() [2/2]

void Ajax::Alerts::Summary::request ( OpenMsg & msg )

virtual

Starts the component.

Implements Cpl::Itc::OpenRequest.

Member Data Documentation

m_alertList

Ajax::Dm::MpAlert** Ajax::Alerts::Summary::m_alertList

protected

Array of Alert Model Point pointers.

m_eventLoop

Cpl::Dm::EventLoop& Ajax::Alerts::Summary::m_eventLoop

protected

Reference to the Event loop (needed when constructing Observers)

m_observers

AlertComposerMemory Ajax::Alerts::Summary::m_observers[Ajax::Type::Alert::NUM_ALERTS]

protected

Observer for change notifications.

m_opened

bool Ajax::Alerts::Summary::m_opened

protected

open/close state

---

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

• Ajax/Alerts/Summary.h