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

Inheritance diagram for imt::base::lib::alarms::FlagAlarm:

Public Member Functions
	FlagAlarm (AlarmSenderIfc &alarmSender, AlarmIdentifier const alarmId)
	Constructor.

void	setFlag ()
	Sets the flag and activates the alarm.

void	clearFlag ()
	Clears the flag and disables the alarm.

bool	isAlarmActive () const
	Returns if any alarm is currently activated.

void	reset ()
	Resets the flag without sending a disable alarm message.

void	updateValue (bool const flag)
	Updates the flag.

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.

Definition at line 21 of file FlagAlarm.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters

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

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

Clears the flag and disables the alarm.

bool imt::base::lib::alarms::FlagAlarm::isAlarmActive ( ) const

Returns if any alarm is currently activated.

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

Resets the flag without sending a disable alarm message.

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

Sets the flag and activates the alarm.

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/inc/Imt.Base.Lib.Alarms/FlagAlarm.h