AlarmStorageRow.ResetAlarmComments (METH) ¶ METHOD ResetAlarmComments : BOOL InOut: Scope Name Type Return ResetAlarmComments BOOL
AlarmStorageRow.SetLatchVarValue (METH) ¶ METHOD SetLatchVarValue Sets the value of a latch variable. InOut: Scope Name Type Comment Input usiWhichLatchVar USINT The 1-based index of the latch variable. byType BYTE The type of the latch variable liValue LINT The value to store
AlarmStorageStaticData (STRUCT) ¶ TYPE AlarmStorageStaticData : STRUCT This structure bundles the data of one row of the alarm storage, that is static, i.e. all the data except the latch variables (because the number of latch variables can vary) InOut: Name Type Initial Comment liTimestapLast TIMESTAMP The timestamps of the last state change of the alarm liTimestapActive TIMESTAMP The timestamps when the alarm became active liTimestapInactive TIMESTAMP The timestamps when the alarm became inactive liTimestapAcknowledge TIMESTAMP The timestamps when the alarm was acknowledged iOffsetLast INT -1 The offset of the last state change of the alarm iOffsetActive INT -1 The offset when the alarm became active iOffsetInactive INT -1 The offset when the alarm became inactive iOffsetAcknowledge INT -1 The offset when the alarm was acknowledged liTriggerValueVal LINT The trigger value as “raw” value iTriggerValueType TypeClass A TypeClass value representing the type of the trigger value udiAlarmId UDINT The internal id of the alarm, i.e. IAlarm.GetInternalID udiAlarmGroupId UDINT The internal id of the alarm group the alarm belongs to, i.e. IAlarmGroup.GetInternalID udiAlarmClassId UDINT The internal id of the alarm class the alarm references, i.e. IAlarmClass.GetInternalID eState AlarmState The current state of the alarm usiPriority USINT The priority of the alarm according to the referenced alarm class liRemoteDeviceVal LINT The remote device value as “raw” value This parameter contains a pointer to the STRING containing the remote device name -1 in case of NO remote device pwsCmtActiveAck POINTER TO WSTRING Acknowledge comments pwsCmtNormal POINTER TO WSTRING pwsCmtActive POINTER TO WSTRING pwsCmtWaitingConf POINTER TO WSTRING pwsUserIdActiveAck POINTER TO WSTRING pwsUserIdNormal POINTER TO WSTRING pwsUserIdActive POINTER TO WSTRING pwsUserIdWaitingConf POINTER TO WSTRING
EAlarmComment (ENUM) ¶ TYPE EAlarmComment : Attributes: qualified_only InOut: Name NO_COMMENT COMMENT_NORMAL COMMENT_ACTIVE_ACK
EAlarmStorageReaderErrors (ENUM) ¶ TYPE EAlarmStorageReaderErrors : This enumeration defines the errors, that can occur during accessing the alarm storage using the public interface. Note: Error codes from 30400 to 30549 represent errors from the underlying CAA Storage component. See STO.ERROR Attributes: qualified_only InOut: Name Initial Comment NoError CmpErrors.Errors.ERR_OK No error WrongParameter CmpErrors.Errors.ERR_PARAMETER A required parameter is invalid, e.g. NULL is passed, where an instance is required NoMemory CmpErrors.Errors.ERR_NOMEMORY Unable to allocate an internally used buffer resp. unable to store a value NoObject CmpErrors.Errors.ERR_NO_OBJECT The specified object was not found AdditionalReadCallRequired CmpErrors.Errors.ERR_PENDING This is not really an error, but the information, that all the data cannot be read by a single call and additional method calls are necessary InvalidCall 20002 The call to a method is invalid, because this method cannot be called in this context.
IAlarmStorageListener (ITF) ¶ INTERFACE IAlarmStorageListener EXTENDS __SYSTEM.IQueryInterface This interface must be implemented by function blocks, that have to be informed if both new alarms have been written into the alarm storage and existing alarms have been updated. Methods: AlarmAdded AlarmModified Structure: AlarmAdded (Method) AlarmModified (Method)
IAlarmStorageListener.AlarmAdded (METH) ¶ METHOD AlarmAdded Notification, that a new alarm has been written to the alarm storage InOut: Scope Name Type Comment Input alarm AlarmStorageRow An instance of AlarmStorageRow describing the data of the alarm.
IAlarmStorageListener.AlarmModified (METH) ¶ METHOD AlarmModified Notification, that data of an already stored alarm has been modified in the alarm storage. InOut: Scope Name Type Comment Input alarm AlarmStorageRow An instance of AlarmStorageRow describing the data of the alarm.
IAlarmStorageReaderConsumer2 (ITF) ¶ INTERFACE IAlarmStorageReaderConsumer2 EXTENDS IAlarmStorageReaderConsumer Properties: ByteOrder Methods: AlarmRead , inherited from IAlarmStorageReaderConsumer BeforeReading , inherited from IAlarmStorageReaderConsumer LatchVariableRead , inherited from IAlarmStorageReaderConsumer ReadingDataCompleted , inherited from IAlarmStorageReaderConsumer Structure: ByteOrder (Property)
IAlarmStorageReaderConsumer2.ByteOrder (PROP) ¶ PROPERTY ByteOrder : EAlarmByteOrder Get/Set the byte order of the DB