imt::base::lib::alarms::AlarmSenderIfc Class Reference

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

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

Public Member Functions
	AlarmSenderIfc (AlarmSenderIfc const &)=delete
	AlarmSenderIfc (AlarmSenderIfc &&)=delete
AlarmSenderIfc &	operator= (AlarmSenderIfc const &) &=delete
AlarmSenderIfc &	operator= (AlarmSenderIfc &&) &=delete
virtual	~AlarmSenderIfc ()=default
	Destructor.
virtual void	activateAlarm (AlarmIdentifier const alarmId)=0
	Activates the alarm with the given ID.
virtual void	deactivateAlarm (AlarmIdentifier const alarmId)=0
	Deactivates the alarm with the given ID.

Protected Member Functions
	AlarmSenderIfc ()=default
	Default constructor.

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.

This interface does not provide ownership on the sender object.

Definition at line 23 of file AlarmSenderIfc.h.

Constructor & Destructor Documentation

AlarmSenderIfc() [1/3]

imt::base::lib::alarms::AlarmSenderIfc::AlarmSenderIfc ( AlarmSenderIfc const &  )

delete

AlarmSenderIfc() [2/3]

imt::base::lib::alarms::AlarmSenderIfc::AlarmSenderIfc ( AlarmSenderIfc &&  )

delete

~AlarmSenderIfc()

virtual imt::base::lib::alarms::AlarmSenderIfc::~AlarmSenderIfc ( )

virtualdefault

Destructor.

AlarmSenderIfc() [3/3]

imt::base::lib::alarms::AlarmSenderIfc::AlarmSenderIfc ( )

protecteddefault

Default constructor.

Member Function Documentation

activateAlarm()

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

pure virtual

Activates the alarm with the given ID.

Parameters

alarmId

Alarm to activate.

deactivateAlarm()

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

pure virtual

Deactivates the alarm with the given ID.

Parameters

alarmId

Alarm to activate.

operator=() [1/2]

AlarmSenderIfc & imt::base::lib::alarms::AlarmSenderIfc::operator= ( AlarmSenderIfc &&  ) &

delete

operator=() [2/2]

AlarmSenderIfc & imt::base::lib::alarms::AlarmSenderIfc::operator= ( AlarmSenderIfc const &  ) &

delete

---

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

• C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Lib.Alarms/inc/Imt.Base.Lib.Alarms/AlarmSenderIfc.h