rtctk::componentFramework::AlertService Class Reference

#include <alertService.hpp>

Inheritance diagram for rtctk::componentFramework::AlertService:

Public Member Functions
void	AddObserver (std::unique_ptr< AlertObserverIf > o)
AlertSource	MakeAlertSource (const std::string &id, const std::string &text) override
	Creates a new alert source for a specified alert condition.
bool	GetStatus () override
	Returns the overall alert status.
void	ClearAll () override
	Clears all active alerts.
Public Member Functions inherited from rtctk::componentFramework::AlertServiceIf
virtual	~AlertServiceIf ()=default

Member Function Documentation

AddObserver()

void rtctk::componentFramework::AlertService::AddObserver ( std::unique_ptr< AlertObserverIf > o )

inline

ClearAll()

void rtctk::componentFramework::AlertService::ClearAll ( )

inlineoverridevirtual

Clears all active alerts.

Implements rtctk::componentFramework::AlertServiceIf.

GetStatus()

bool rtctk::componentFramework::AlertService::GetStatus ( )

inlineoverridevirtual

Returns the overall alert status.

Returns

true if any alerts are active, false otherwise

Implements rtctk::componentFramework::AlertServiceIf.

MakeAlertSource()

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

inlineoverridevirtual

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).

Implements rtctk::componentFramework::AlertServiceIf.

---

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

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