ModuleAlarmInfo (STRUCT) ¶ TYPE ModuleAlarmInfo : STRUCT InOut: Name Type inst AC.IModule pAlarms POINTER TO AlarmInfo uiNumAlarms UINT
ModuleCall (STRUCT) ¶ TYPE ModuleCall : STRUCT A structure internally used by the alarm generator to generate the module calls after an alarm was issued. InOut: Name Type Comment inst AC.IModule The module instance defining a module call calltype UINT The module call type defined by the module instance
ModuleEvent (STRUCT) ¶ TYPE ModuleEvent : STRUCT InOut: Name Type Comment inst AC.IModule uliEventID ULINT built by the hashcode from Target of SetAlarm section alarmGroupID AlarmManager.ALARMGROUP_ID alarmID AlarmManager.ALARM_ID
Functions ¶ Helper function to handle module calls. RaiseModuleEvent (Function) ReplaceAlarmPlaceholderString (Function)
RaiseModuleEvent (FUN) ¶ FUNCTION RaiseModuleEvent : BOOL This function raises an event that has been configured as Event-Alarm of an Module-Instance InOut: Scope Name Type Comment Return RaiseModuleEvent BOOL Input itfAlarmHandler AlarmManager.IAlarmHandler The alarm handler that shall raise an alarm. If this parameter is 0 g_AlarmHandler from AlarmManager library is used inst AC.IModule The module instance that defines the Event-Alarm pEventID POINTER TO STRING The Target of the Event-Alarm in the module description
ReplaceAlarmPlaceholderString (FUN) ¶ FUNCTION ReplaceAlarmPlaceholderString : STRING This function can be used to replace placeholders in a message (i.e. latch variables as “LATCHVAR1” or “LATCHVAR2”) by some strings. This function can be used to get the resulting alarm message for display when getting a module call after an alarm was issued. InOut: Scope Name Type Comment Return ReplaceAlarmPlaceholderString STRING The replaced string. Input strMessage STRING Message which has a placeholder to be replaced strPlaceholder STRING The placeholder strReplacement STRING The string the placeholder shall be replaced with
GlobalTextList (Text List) ¶ ID Default en de 1 ACK all visible ACK all visible Alle sichtbaren Alarme bestätigen 0 ACK selected ACK selected Selektierte Alarme bestätigen 3 Freeze Scrl Pos Freeze Scrl Pos Scrl Position einfrieren 2 History History Historie
ModuleInterface ¶ Interfaces used by the alarm generator in order to define and get module calls. IModuleAlarming (Interface) ConsumeModuleAlarm (Method)
IModuleAlarming (ITF) ¶ INTERFACE IModuleAlarming EXTENDS __System.IQueryInterface Interface used to make a module function block to be callable after an alarm was issued. Implement this interface in your module function block in order to get a callable module function block, which can get module calls after an alarm was issued. Methods: ConsumeModuleAlarm Structure: ConsumeModuleAlarm (Method)
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)