M_Alert::IService Class Reference

Public Member Functions
virtual	~IService ()
virtual void	CmdRaiseAlarm (M_Alert::AlarmConditionInfoType const &Condition)
virtual void	CmdResolveAlarm (M_Alert::AlarmConditionInfoType const &Condition)
virtual void	CmdAcknowledgeAlarm (M_Alert::AlertIdListType const &AlarmIdList)
virtual void	CmdOverrideAlarmCondition (M_Alert::AlarmConditionInfoType const &Condition)
virtual void	CmdUnoverrideAlarmCondition (M_Alert::AlarmConditionInfoType const &Condition)
virtual void	CmdClearAlarm (M_Alert::AlertIdListType const &AlarmIdList)
virtual void	CmdRaiseThreatAlert (M_Alert::AlertIdType const &ThreatId, M_Alert::ThreatLogType const &Threat)
virtual void	CmdCancelThreatAlert (M_Alert::AlertIdListType const &ThreatIdList)

Detailed Description

Service interface. Contains operations that a client can command the Alert Service to perform.

Constructor & Destructor Documentation

~IService()

M_Alert::IService::~IService ( )

virtual

Member Function Documentation

CmdAcknowledgeAlarm()

void M_Alert::IService::CmdAcknowledgeAlarm ( M_Alert::AlertIdListType const &  AlarmIdList )

virtual

Acknowledges one or more existing Alarms. The Acknowledge function moderates the audio and / or the visual features of the alarm (annunciation) and leaves the alarm in the active alarm (log) list.

Parameters

AlarmIdList

Identifies the Alarms to be acknowledged.

CmdCancelThreatAlert()

void M_Alert::IService::CmdCancelThreatAlert ( M_Alert::AlertIdListType const &  ThreatIdList )

virtual

Used to Cancel one or more existing Threat Alerts which are no longer relevant.

Parameters

ThreatIdList

Identifies the Threat Alerts to be cancelled.

CmdClearAlarm()

void M_Alert::IService::CmdClearAlarm ( M_Alert::AlertIdListType const &  AlarmIdList )

virtual

Clears one or more existing Alarms.

Parameters

AlarmIdList

Identifies the Alarms to be cleared.

CmdOverrideAlarmCondition()

void M_Alert::IService::CmdOverrideAlarmCondition ( M_Alert::AlarmConditionInfoType const &  Condition )

virtual

Causes the Alarm condition to be overridden. The Override function is used to suppress the source of the alarm to prevent it from triggering again. The alarm remains on the active alarm list. On Mission System power up, all previously overridden alarms will be removed.

Parameters

Condition

Alarm condition to override. Note: All future Alarms raised for this condition will be suppressed.

CmdRaiseAlarm()

void M_Alert::IService::CmdRaiseAlarm ( M_Alert::AlarmConditionInfoType const &  Condition )

virtual

Causes an Alarm condition to be raised. Note: Creates a new Alarm in the Service.

Parameters

Condition

Condition which raised the Alarm.

CmdRaiseThreatAlert()

void M_Alert::IService::CmdRaiseThreatAlert ( M_Alert::AlertIdType const &  ThreatId, M_Alert::ThreatLogType const &  Threat  )

virtual

Causes a Threat Alert to be raised. Note: Creates a new Threat Alert in the Service.

Parameters

ThreatId	Identifies the Threat Alert.
Threat	Threat Alert to be raised.

CmdResolveAlarm()

void M_Alert::IService::CmdResolveAlarm ( M_Alert::AlarmConditionInfoType const &  Condition )

virtual

Resolve a previously raised Alarm when the condition has been resolved. Note: Used to Resolve an existing alarm condition by the one who raised the Alarm.

Parameters

Condition

Condition which raised the Alarm.

CmdUnoverrideAlarmCondition()

void M_Alert::IService::CmdUnoverrideAlarmCondition ( M_Alert::AlarmConditionInfoType const &  Condition )

virtual

Causes the Alarm condition to be changed from being overridden to not overridden.

Parameters

Condition

Previously overridden Alarm condition.