AC_Alarming Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title AC_Alarming Version 4.1.0.0 Categories Application|Composer Namespace AC_Alarming Author 3S - Smart Software Solutions GmbH Placeholder AC_Alarming Description 1 ¶ Base library for the usage of the alarming generator of the application composer. Contents: ¶ ExtenderFB ACAlarmExtender (FunctionBlock) AlarmInfo (Struct) AlarmingCall (Enum) IACAlarmExtender (Interface) IACAlarmExtender2 (Interface) IACAlarmExtender3 (Interface) ModuleAlarmInfo (Struct) ModuleCall (Struct) ModuleEvent (Struct) Functions RaiseModuleEvent (Function) ReplaceAlarmPlaceholderString (Function) GlobalTextList (GlobalTextList) ModuleInterface IModuleAlarming (Interface) Visualization Indices and tables ¶ 1 Based on AC_Alarming.library, last modified 24.05.2022, 17:08:38. LibDoc 4.4.0.0-b.27 The content file AC_Alarming.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 24.05.2022, 17:08:39.

ACAlarmExtender (FB) ¶ FUNCTION_BLOCK ACAlarmExtender IMPLEMENTS IACAlarmExtender3 , AlarmManager.IAlarmNotifiable The environment extender function block itself of the alarm generator. It both implements IACAlarmExtender3 and the AlarmManager.IAlarmNotifiable interface. The latter is used so that this function block can get the calls of the CODESYS own alarm configuration. Properties: GetID Methods: AcknowledgeAllAlarmsOfModule Execute GetActiveAlarmsOfModule GetEventAlarmID Init Init2 InitSortedModuleAlarms Structure: AcknowledgeAllAlarmsOfModule (Method) Execute (Method) GetActiveAlarmsOfModule (Method) GetEventAlarmID (Method) GetID (Property) Init (Method) Init2 (Method) InitSortedModuleAlarms (Method)

ExtenderFB ¶ Extender function block used by the alarming generator to specify an function block extending the composer environment during composer generation. The latter environment is part of any composer application. ACAlarmExtender (FunctionBlock) AcknowledgeAllAlarmsOfModule (Method) Execute (Method) GetActiveAlarmsOfModule (Method) GetEventAlarmID (Method) GetID (Property) Init (Method) Init2 (Method) InitSortedModuleAlarms (Method) AlarmInfo (Struct) AlarmingCall (Enum) IACAlarmExtender (Interface) Init (Method) IACAlarmExtender2 (Interface) GetEventAlarmID (Method) Init2 (Method) IACAlarmExtender3 (Interface) AcknowledgeAllAlarmsOfModule (Method) GetActiveAlarmsOfModule (Method) InitSortedModuleAlarms (Method) ModuleAlarmInfo (Struct) ModuleCall (Struct) ModuleEvent (Struct)

ACAlarmExtender.AcknowledgeAllAlarmsOfModule (METH) ¶ METHOD AcknowledgeAllAlarmsOfModule : BOOL InOut: Scope Name Type Return AcknowledgeAllAlarmsOfModule BOOL Input itfModule AC.IModule

ACAlarmExtender.Execute (METH) ¶ METHOD Execute Executes the action. This function is part of the AlarmManager.IAlarmNotifiable interface. InOut: Scope Name Type Comment Input eCurrTransition AlarmStateTransition The currently processed alarm state transition. This will be evaluated in order to determine, whether the action has to be executed or not. itfAlarm IAlarm The alarm, for which the action has to be performed pbyAdditionalData POINTER TO BYTE An optional pointer to a structure variable containing additional parameter

ACAlarmExtender.GetActiveAlarmsOfModule (METH) ¶ METHOD GetActiveAlarmsOfModule : BOOL InOut: Scope Name Type Return GetActiveAlarmsOfModule BOOL Input itfModule AC.IModule pActiveAlarms POINTER TO AlarmManager.IAlarm uiSizeOfActiveAlarms UINT Output uiNumFoundAlarms UINT

ACAlarmExtender.GetEventAlarmID (METH) ¶ METHOD GetEventAlarmID : BOOL InOut: Scope Name Type Return GetEventAlarmID BOOL Input inst AC.IModule pEventTargetID POINTER TO STRING Output alarmGroupID AlarmManager.ALARMGROUP_ID alarmID AlarmManager.ALARM_ID

ACAlarmExtender.GetID (PROP) ¶ PROPERTY GetID : STRING Implementation of the property defined by AC.IEnvironmentExtender.

ACAlarmExtender.Init (METH) ¶ METHOD Init Implementation of the method defined in ACAlarmExtender InOut: Scope Name Type Comment Input pModCall POINTER TO ModuleCall See ACAlarmExtender for details. uiModCall UINT See ACAlarmExtender for details.

ACAlarmExtender.Init2 (METH) ¶ METHOD Init2 Implementation of the method defined in IACAlarmExtender2 InOut: Scope Name Type Input pModCall POINTER TO ModuleCall uiModCall UINT pModEvents POINTER TO ModuleEvent uiModEvents UINT