imt::base::lib::alarms::FlagAlarm Class Reference

Activates the given alarms if the flag is set and deactivates it when the flag is cleared. More...

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

Public Member Functions
	FlagAlarm (AlarmSenderIfc &alarmSender, AlarmIdentifier const alarmId)
	Constructor. More...
void	setFlag ()
	Sets the flag and activates the alarm. More...
void	clearFlag ()
	Clears the flag and disables the alarm. More...
bool	isAlarmActive () const
	Returns if any alarm is currently activated. More...
void	reset ()
	Resets the flag without sending a disable alarm message. More...
void	updateValue (bool const flag)
	Updates the flag. More...
	FlagAlarm ()=delete
	FlagAlarm (FlagAlarm const &other)=delete
	FlagAlarm (FlagAlarm &&other)=default
FlagAlarm &	operator= (FlagAlarm const &other)=delete
	~FlagAlarm ()=default

Detailed Description

Activates the given alarms if the flag is set and deactivates it when the flag is cleared.

Does send the activation/deactivation message only when the condition changes. Initially the alarm is deactivated.

Constructor & Destructor Documentation

FlagAlarm() [1/4]

imt::base::lib::alarms::FlagAlarm::FlagAlarm ( AlarmSenderIfc &  alarmSender, AlarmIdentifier const  alarmId  )

explicit

Constructor.

Parameters

alarmSender	The interface to the actual alarm sender.
alarmId	The ID of the alarm that shall be sent.

FlagAlarm() [2/4]

imt::base::lib::alarms::FlagAlarm::FlagAlarm ( )

delete

FlagAlarm() [3/4]

imt::base::lib::alarms::FlagAlarm::FlagAlarm ( FlagAlarm const &  other )

delete

FlagAlarm() [4/4]

imt::base::lib::alarms::FlagAlarm::FlagAlarm ( FlagAlarm &&  other )

default

~FlagAlarm()

imt::base::lib::alarms::FlagAlarm::~FlagAlarm ( )

default

Member Function Documentation

clearFlag()

void imt::base::lib::alarms::FlagAlarm::clearFlag

(

)

Clears the flag and disables the alarm.

isAlarmActive()

bool imt::base::lib::alarms::FlagAlarm::isAlarmActive

(

)

const

Returns if any alarm is currently activated.

Returns

true if the alarm is active, false otherwise.

operator=()

FlagAlarm& imt::base::lib::alarms::FlagAlarm::operator= ( FlagAlarm const &  other )

delete

reset()

void imt::base::lib::alarms::FlagAlarm::reset

(

)

Resets the flag without sending a disable alarm message.

setFlag()

void imt::base::lib::alarms::FlagAlarm::setFlag

(

)

Sets the flag and activates the alarm.

updateValue()

void imt::base::lib::alarms::FlagAlarm::updateValue

(

bool const

flag

)

Updates the flag.

Parameters

flag	The new value for the flag.

---

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

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