rtctk::componentFramework::AlertDescription Class Reference

Uniquely describes an alert. More...

#include <alertServiceIf.hpp>

Public Member Functions
	AlertDescription (std::string id, std::string description) noexcept
	Construct instance. More...
std::string const &	GetId () const noexcept
std::string const &	GetDescription () const noexcept

Detailed Description

Uniquely describes an alert.

Properties:

• Id: String in the character class [0-9a-z] associates uniquely a logical alert condition.
• Description: String describing the alert condition.

Thread Safety

thread-compatible

Constructor & Destructor Documentation

AlertDescription()

rtctk::componentFramework::AlertDescription::AlertDescription ( std::string  id, std::string  description  )

explicitnoexcept

Construct instance.

Parameters

id	alert condition identifier.
description	description.

Member Function Documentation

GetDescription()

std::string const& rtctk::componentFramework::AlertDescription::GetDescription ( ) const

inlinenoexcept

Returns

alert condition description.

GetId()

std::string const& rtctk::componentFramework::AlertDescription::GetId ( ) const

inlinenoexcept

Returns

alert condition identifier.

---

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

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