IAlarmHandler6.AcknowledgeOneOfGroupWithComment (METH) ¶ METHOD AcknowledgeOneOfGroupWithComment Acknowledges an alarm of an alarm group. Optionally a comment and the user id can be provided. InOut: Scope Name Type Comment Input usiAlarmGroupID ALARMGROUP_ID The ID of the alarm group uiAlarmID ALARM_ID The ID of the alarm Inout Const wsComment WSTRING The comment for the state transition wsUserId WSTRING The user who provides the comment
IAlarmHandler6.SetComment (METH) ¶ METHOD SetComment : UDINT Sets the comment and related user id on the current state of an alarm. InOut: Scope Name Type Comment Return SetComment UDINT Input usiAlarmGroupID ALARMGROUP_ID The ID of the alarm group uiAlarmID ALARM_ID The ID of the alarm Inout Const wsComment WSTRING The comment on the current alarm state wsUserId WSTRING The user who provides the comment
IAlarmHandlerRemoteMonitor (ITF) ¶ INTERFACE IAlarmHandlerRemoteMonitor EXTENDS __SYSTEM.IQueryInterface This intreface is used to get remote device monitor data Methods: GetProxyAlarmClassesDescription GetProxyAlarmGroupsDescription GetProxyAlarmsDescription GetProxyStatistics GetProxyStatisticsSingleActivity Structure: GetProxyAlarmClassesDescription (Method) GetProxyAlarmGroupsDescription (Method) GetProxyAlarmsDescription (Method) GetProxyStatistics (Method) GetProxyStatisticsSingleActivity (Method)
IAlarmHandler.AcknowledgeAll (METH) ¶ METHOD AcknowledgeAll Acknowledges all active alarms, whose alarm class hasn’t the flag “acknowledge separately” set
IAlarmHandler.AcknowledgeAllOfGroup (METH) ¶ METHOD AcknowledgeAllOfGroup Acknowledges all active alarms of an alarm group, whose alarm class hasn’t the flag “acknowledge separately” set InOut: Scope Name Type Comment Input usiAlarmGroupID ALARMGROUP_ID The ID of the alarm group
IAlarmHandler.AcknowledgeOneOfGroup (METH) ¶ METHOD AcknowledgeOneOfGroup Acknowledges an alarm of an alarm group. InOut: Scope Name Type Comment Input usiAlarmGroupID ALARMGROUP_ID The ID of the alarm group uiAlarmID ALARM_ID The ID of the alarm
IBACnetARRAYN_of_Unsigned8.UpdateElement (METH) ¶ METHOD UpdateElement : CmpBACnet.IEC_BACNET_STATUS Update the element of this property at the given index. InOut: Scope Name Type Comment Return UpdateElement CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ARRAY_INDEX Index (0 .. number of elements-1). Inout Const value USINT Element value to write.
IAlarmHandler.RaiseEvent (METH) ¶ METHOD RaiseEvent : BOOL Raises an Event (i.e. an IAlarm instance with observation type Event). This method posts the Event to the global event queue InOut: Scope Name Type Comment Return RaiseEvent BOOL Input usiAlarmGroupID ALARMGROUP_ID The ID of the alarm group, where the event is declared. Here the corresponding enum value has to be passed, where the name of the generated enum is: Alm_AlarmConfiguration_Alarmgroup_IDs uiAlarmID ALARM_ID The ID of the alarm, that have to be raised. Here the corresponding enum value has to be passed, where the name of the generated enum is: Alm_<Name of the alarm group>_Alarm_IDs The enumeration member has the same name like the ID of the alarm
IAlarmHandler2.RegisterClient (METH) ¶ METHOD RegisterClient : UDINT Registers an instance IAlarmManagerClient at the alarm mannager. The return value indicates, whether registering was successful InOut: Scope Name Type Comment Return RegisterClient UDINT Input itfAlarmManagerClient IAlarmManagerClient The IAlarmManagerClient instance to register parritfAlarmsFromHistory POINTER TO ARRAY [0..0] OF IAlarm2 This parameter specifies, whether the client will also be used to access the alarm history (will be able if both the parameters parritfAlarmsFromHistory and iCountAlarmsFromHistory are <> 0). This parameter also indicates the maximum numbers of rows of the alarm history, that will be returned to the client by a call to method GetAlarmsFromStorage. iCountAlarmsFromHistory INT The effective size of the array above
IAlarmHandler2.UnregisterClient (METH) ¶ METHOD UnregisterClient : UDINT Unregisters an instance IAlarmManagerClient at the alarm mannager. The return value indicates, whether unregistering was successful InOut: Scope Name Type Comment Return UnregisterClient UDINT Input itfAlarmManagerClient IAlarmManagerClient The IAlarmManagerClient instance to unregister