RTC Toolkit  2.0.0
Public Member Functions | List of all members
rtctk::componentFramework::AlertSourceFactoryIf Class Referenceabstract

Interface to create AlertSource. More...

#include <alertServiceIf.hpp>

Inheritance diagram for rtctk::componentFramework::AlertSourceFactoryIf:
rtctk::componentFramework::AlertServiceIf rtctk::componentFramework::AlertService

Public Member Functions

virtual ~AlertSourceFactoryIf () noexcept=default
 
virtual AlertSource MakeAlertSource (AlertDescription const &description)=0
 Creates a new alert source for the specified alert condition. More...
 

Detailed Description

Interface to create AlertSource.

Thread Safety
thread-safe

Constructor & Destructor Documentation

◆ ~AlertSourceFactoryIf()

virtual rtctk::componentFramework::AlertSourceFactoryIf::~AlertSourceFactoryIf ( )
virtualdefaultnoexcept

Member Function Documentation

◆ MakeAlertSource()

virtual AlertSource rtctk::componentFramework::AlertSourceFactoryIf::MakeAlertSource ( AlertDescription const &  description)
pure virtual

Creates a new alert source for the specified alert condition.

Parameters
conditionfor which to create an AlertSource of.
Returns
AlertSource for condition.
Exceptions
AlertConflictExceptionif another alert source is alive with the same AlertDescription::GetId().
RtctkExceptionif other exceptions occurs (nested).

Implemented in rtctk::componentFramework::AlertService.


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