M_Alert::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	ReportAlertSettings (M_Alert::AlertSettingsType const &Settings)
virtual void	ReportAlertStatus (M_Alert::AlertStatusType const &Status, bool IsRemoved)
virtual void	ReportAlarmLog (M_Alert::AlertIdType const &KeyAlarmId, M_Alert::AlarmLogType const &Alarm, bool IsRemoved)
virtual void	ReportAlarmAnnunciation (std::string const &KeyCrewRole, M_Alert::AlarmAnnunciationType const &Annunciation, bool IsRemoved)
virtual void	ReportThreatLog (M_Alert::AlertIdType const &KeyThreatId, M_Alert::ThreatLogType const &Threat, bool IsRemoved)
virtual void	ReportThreatAnnunciation (M_Alert::ThreatAnnunciationType const &Annunciation, bool IsRemoved)

Detailed Description

Client interface. Contains callback operations from the Alert Service to the Client.

Constructor & Destructor Documentation

~IClient()

M_Alert::IClient::~IClient ( )

virtual

Member Function Documentation

ReportAlarmAnnunciation()

void M_Alert::IClient::ReportAlarmAnnunciation ( std::string const &  KeyCrewRole, M_Alert::AlarmAnnunciationType const &  Annunciation, bool  IsRemoved  )

virtual

Report an Annunciation for an Alarm. Current annunciation text and tone for a specific crew role. Note: Only one alarm will be announced per Crew Role at one time.

Parameters

KeyCrewRole	Specific Crew role for which this Annunciation applies.
Annunciation	Annunciation data for an Alarm.
IsRemoved	Indicates if there is no longer any Annunciation for the specified Crew role.

ReportAlarmLog()

void M_Alert::IClient::ReportAlarmLog ( M_Alert::AlertIdType const &  KeyAlarmId, M_Alert::AlarmLogType const &  Alarm, bool  IsRemoved  )

virtual

Report an Alarm raised as a result of an Alarm condition. This is the Log entry.

Parameters

KeyAlarmId	Identifies the Alarm log entry.
Alarm	The Alarm log entry data.
IsRemoved	Indicates if the Alarm has been removed from the log.

ReportAlertSettings()

void M_Alert::IClient::ReportAlertSettings ( M_Alert::AlertSettingsType const &  Settings )

virtual

Report static settings of the Alert Service.

Parameters

Settings

Alert Service settings data.

ReportAlertStatus()

void M_Alert::IClient::ReportAlertStatus ( M_Alert::AlertStatusType const &  Status, bool  IsRemoved  )

virtual

Report the status with current count of active alarms and threats.

Parameters

Status	Alert Service status data.
IsRemoved	Indicates if the status is no longer available. Note: This will always be set to True when a Service has been shutdown. After this has been set to True the status will no longer be available to late joiners.

ReportThreatAnnunciation()

void M_Alert::IClient::ReportThreatAnnunciation ( M_Alert::ThreatAnnunciationType const &  Annunciation, bool  IsRemoved  )

virtual

Report an Annunciation for a Threat Alert. Current annunciation text and tone. Note: Only one threat will be announced at one time.

Parameters

Annunciation	Annunciation data for a Threat Alert.
IsRemoved	Indicates if there is no longer any Annunciation.

ReportThreatLog()

void M_Alert::IClient::ReportThreatLog ( M_Alert::AlertIdType const &  KeyThreatId, M_Alert::ThreatLogType const &  Threat, bool  IsRemoved  )

virtual

Report an Alert for a detected Threat.

Parameters

KeyThreatId	Identifies the Threat Alert log entry.
Threat	The Threat Alert log entry data.
IsRemoved	Indicates if the Threat Alert has been removed from the log.