Dataflow Runtime API  2.7.4.0
Public Member Functions | List of all members
imt::base::lib::alarms::AlarmSenderIfc Class Referenceabstract

Interface to send an alarm message to activate or deactivate a given alarm. More...

#include <Imt.Base.Lib.Alarms/AlarmSenderIfc.h>

Public Member Functions

virtual ~AlarmSenderIfc (void)
 Destructor.
 
virtual void activateAlarm (const AlarmIdentifier alarmId)=0
 Activates the alarm with the given ID. More...
 
virtual void deactivateAlarm (const AlarmIdentifier alarmId)=0
 Deactivates the alarm with the given ID. More...
 

Detailed Description

Interface to send an alarm message to activate or deactivate a given alarm.

This must be implemented by the active part that shall send an alarm, i.e. by writing an alarm message containing the alarm id and an activated/deactivated flag to an alarm output port.

Member Function Documentation

◆ activateAlarm()

virtual void imt::base::lib::alarms::AlarmSenderIfc::activateAlarm ( const AlarmIdentifier  alarmId)
pure virtual

Activates the alarm with the given ID.

Parameters
alarmIdAlarm to activate.

◆ deactivateAlarm()

virtual void imt::base::lib::alarms::AlarmSenderIfc::deactivateAlarm ( const AlarmIdentifier  alarmId)
pure virtual

Deactivates the alarm with the given ID.

Parameters
alarmIdAlarm to activate.

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