IModuleAlarming.ConsumeModuleAlarm
(METH)
METHOD ConsumeModuleAlarm : BOOL
This method is called is an alarm was issued for a module which defined a module call.
If true is returned the alarm was consumed by this function and will be no further treated. This means returning true will stop the transmission of this alarm to other modules. If false is returned other modules will still be alarmed
- InOut:
Scope
Name
Type
Comment
Return
ConsumeModuleAlarm
BOOL
True is returned if the alarm does not need to be issued further (i.e. by the module parents), or false if it needs to be issued further.
Input
inst
AC.IModule
The module instance for which the alarm was issued
alarm
AlarmManager.IAlarm
The alarm for which a transition occured (see the AlarmManager library for details)
transition
AlarmManager.AlarmStateTransition
The transition type, which occured for the alarm (see the AlarmManager library for details)