IACAlarmExtender2 (ITF) ¶ INTERFACE IACAlarmExtender2 EXTENDS IACAlarmExtender Extension of IACAlarmExtender for the usage of Event-Alarms Methods: GetEventAlarmID Init2 Init , inherited from IACAlarmExtender Structure: GetEventAlarmID (Method) Init2 (Method)

IACAlarmExtender2.GetEventAlarmID (METH) ¶ METHOD GetEventAlarmID : BOOL This method gets information about an Event-Alarm of a certain module. InOut: Scope Name Type Comment Return GetEventAlarmID BOOL The return value indicates whether an Event-Alarm could be found. Input inst AC.IModule The module instance the Event-Alarm belongs to. pEventTargetID POINTER TO STRING The target of the Event-Alarm Output alarmGroupID AlarmManager.ALARMGROUP_ID The alarm-groupId of the found Event-Alarm alarmID AlarmManager.ALARM_ID The alarmId of the found Event-Alarm

IACAlarmExtender2.Init2 (METH) ¶ METHOD Init2 Initialization function to initialize the environment extender of the alarm generator. This function is called by code generated by the alarm generator. InOut: Scope Name Type Comment Input pModCall POINTER TO ModuleCall A pointer to a list of all module calls available under an application. The latter list is created by the alarm generator during an application composer generation. uiModCall UINT The number of module call defined in the list pointed to by pModCall. pModEvents POINTER TO ModuleEvent A pointer to a list of all module events available under an application. The latter list is created by the alarm generator during an application composer generation. uiModEvents UINT The number of module events defined in the list pointed to by pModEvents .

IACAlarmExtender3 (ITF) ¶ INTERFACE IACAlarmExtender3 EXTENDS IACAlarmExtender2 Methods: AcknowledgeAllAlarmsOfModule GetActiveAlarmsOfModule InitSortedModuleAlarms GetEventAlarmID , inherited from IACAlarmExtender2 Init , inherited from IACAlarmExtender Init2 , inherited from IACAlarmExtender2 Structure: AcknowledgeAllAlarmsOfModule (Method) GetActiveAlarmsOfModule (Method) InitSortedModuleAlarms (Method)

IACAlarmExtender3.AcknowledgeAllAlarmsOfModule (METH) ¶ METHOD AcknowledgeAllAlarmsOfModule : BOOL This method acknowledges all active alarms that belong to module instance identified by itfModule . Note For using this method one must activate the option to sort alarms per module in the options of the Alarm-Generator. InOut: Scope Name Type Comment Return AcknowledgeAllAlarmsOfModule BOOL The return value indicates if it was possible to acknowledge the alarms that belong to itfModule . Input itfModule AC.IModule The module whose alarms shall be acknowledged.

IACAlarmExtender3.GetActiveAlarmsOfModule (METH) ¶ METHOD GetActiveAlarmsOfModule : BOOL This method gets all currently active alarms that belong to the module instance defined by itfModule . Note For using this method one must activate the option to sort alarms per module in the options of the Alarm-Generator. InOut: Scope Name Type Comment Return GetActiveAlarmsOfModule BOOL The return value indicates if it was possible to get all active alarms that belong to itfModule . The return value does also take into account if the size of the array pointed to pActiveAlarms was adequate. Input itfModule AC.IModule The module the active alarms shall be searched. pActiveAlarms POINTER TO AlarmManager.IAlarm Pointer to an array of AlarmManager.IAlarm . Here the found alarms are stored. uiSizeOfActiveAlarms UINT The size of the array pActiveAlarms is pointing to. Output uiNumFoundAlarms UINT The number of found alarms.

IACAlarmExtender3.InitSortedModuleAlarms (METH) ¶ METHOD InitSortedModuleAlarms : BOOL This function is called by Init-code generated by ApplicationComposer. InOut: Scope Name Type Return InitSortedModuleAlarms BOOL Input pModuleAlarmInfos POINTER TO ModuleAlarmInfo uiModuleAlarmInfos UINT

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