rtctk::componentFramework::AlertServiceIf Class Reference

Alert Service interface. More...

#include <rtctk/componentFramework/alertServiceIf.hpp>

Inheritance diagram for rtctk::componentFramework::AlertServiceIf:

Public Member Functions
virtual	~AlertServiceIf ()=default
virtual AlertSource	MakeAlertSource (const std::string &id, const std::string &text)=0
	Creates a new alert source for a specified alert condition.
virtual bool	GetStatus ()=0
	Returns the overall alert status.
virtual void	ClearAll ()=0
	Clears all active alerts.

Detailed Description

Alert Service interface.

Main responsibility of the Alert Service is to allow software to dynamically create new AlertSources, each of which is uniquely associated to an alert condition can be active or inactive.

The AlertSource is then used to signal that the alert condition is active or inactive with AlertSource::Set() and AlertSource::Clear().

The AlertService implementation then reduces all conditions to one status which can be checked with AlertSer:w viceIf::GetStatus.

Thread Safety

thread-safe – All implementations are required to be thread safe in the public API defined in this interface.

Constructor & Destructor Documentation

~AlertServiceIf()

virtual rtctk::componentFramework::AlertServiceIf::~AlertServiceIf ( )

virtualdefault

Member Function Documentation

ClearAll()

virtual void rtctk::componentFramework::AlertServiceIf::ClearAll ( )

pure virtual

Clears all active alerts.

Implemented in rtctk::componentFramework::AlertService.

GetStatus()

virtual bool rtctk::componentFramework::AlertServiceIf::GetStatus ( )

pure virtual

Returns the overall alert status.

Returns

true if any alerts are active, false otherwise

Implemented in rtctk::componentFramework::AlertService.

MakeAlertSource()

virtual AlertSource rtctk::componentFramework::AlertServiceIf::MakeAlertSource ( const std::string & id, const std::string & text )

pure virtual

Creates a new alert source for a specified alert condition.

Parameters

id	containing the alert condition ID
text	containing the alert condition description.

Returns

AlertSource

Exceptions

AlertConflictException	if another alert source is alive with the same id
RtctkException	if other exceptions occurs (nested).

Implemented in rtctk::componentFramework::AlertService.

---

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

• componentFramework/services/alert/src/include/rtctk/componentFramework/alertServiceIf.hpp