AlarmStorageReader.FB_Init (METH) ¶ METHOD FB_Init : BOOL FB_Init method used for initializing the semaphore to access the usage of THIS instance InOut: Scope Name Type Return FB_Init BOOL Input bInitRetains BOOL bInCopyCode BOOL
AlarmStorageReader.GetFirstLastRowID (METH) ¶ METHOD GetFirstLastRowID : EAlarmStorageReaderErrors This method determines first and last row IDs in the alarm storage. InOut: Scope Name Type Comment Return GetFirstLastRowID EAlarmStorageReaderErrors An EAlarmStorageReaderErrors indicating, whether the processing was successful or not Output diRowIDFirst DINT First row ID diRowIDLast DINT Last row ID
AlarmStorageReader.GetMinMaxTimestamps (METH) ¶ METHOD GetMinMaxTimestamps : EAlarmStorageReaderErrors This method determines minimum and maximum timestamp stored in the alarm storage. InOut: Scope Name Type Comment Return GetMinMaxTimestamps EAlarmStorageReaderErrors An EAlarmStorageReaderErrors indicating, whether the processing was successful or not Output liMinTimestamp LINT Returns minimum timestamp liMaxTimestamp LINT Returns maximum timestamp xTableIsEmpty BOOL Indicates, whether the database table is empty. The output parameter liMinTimestamp and and liMaxTimestamp contain valid values only if this output parameter is FALSE. udiCountAlarms UDINT The number of alarms, that are stored in the alarm storage for the given timestamp
AlarmStorageReader.Read (METH) ¶ METHOD Read : EAlarmStorageReaderErrors Reads data from the alarm storage. InOut: Scope Name Type Comment Return Read EAlarmStorageReaderErrors A EAlarmStorageReaderErrors value indicating, whether the processing has been completed successfully or not: EAlarmStorageReaderErrors.NoError: Completed successfully EAlarmStorageReaderErrors.WrongParameter: If the IAlarmStorageReaderConsumer instance is invalid EAlarmStorageReaderErrors.AdditionalReadCallRequired: Reading has been completed successfully, but there is additional call of method ContinueReading necessary to read the rest of the data Input liTimstampFrom LINT The timestamp (when the alarm became active) of the 1st alarm liTimstampTo LINT The timestamp of the last alarm xReadAscending BOOL If this parameter is TRUE, then the rows will be returned by “timestamp active” ascending, otherwise descending itfAlarmStorageReaderConsumer IAlarmStorageReaderConsumer An instance of IAlarmStorageReaderConsumer, to which the data read from the alarm storage will be passed.
AlarmStorageReader.RemoveAlarmStorageListener (METH) ¶ METHOD RemoveAlarmStorageListener : EAlarmStorageReaderErrors Removes an IAlarmStorageListener instance. InOut: Scope Name Type Comment Return RemoveAlarmStorageListener EAlarmStorageReaderErrors A EAlarmStorageReaderErrors value indicating, whether the processing has been completed successfully or not: EAlarmStorageReaderErrors.NoError: Completed successfully EAlarmStorageReaderErrors.WrongParameter: If the IAlarmStorageListener instance is invalid EAlarmStorageReaderErrors.NoObject: If the IAlarmStorageListener instance cannot be removed, because was not found, i.e. has not been added with method AddAlarmStorageListener EAlarmStorageReaderErrors.InvalidCall: If there is no alarm storage is available, where the IAlarmStorageListener instance can be unregistered Input itfAlarmStorageListener IAlarmStorageListener An instance of IAlarmStorageListener to unregister
AlarmStorageConvertValueToREAL (FUN) ¶ FUNCTION AlarmStorageConvertValueToREAL : REAL Converts a value read from the alarm storage into a REAL value. InOut: Scope Name Type Comment Return AlarmStorageConvertValueToREAL REAL Input liValue LINT The value, that was read from TblAlarm iType TypeClass A TypeClass value representing the type of the value xValueNULL BOOL Indicates, whether NULL is stored in the alarm storage
AlarmStorageConvertValueToString (FUN) ¶ FUNCTION AlarmStorageConvertValueToString : STRING Converts a value read from the alarm storage into a suitable string representation. InOut: Scope Name Type Comment Return AlarmStorageConvertValueToString STRING Input liValue LINT The value, that was read from TblAlarm iType TypeClass A TypeClass value representing the type of the value xValueNULL BOOL Indicates, whether NULL is stored in the alarm storage
AlarmStorageGetDefaultText (FUN) ¶ FUNCTION AlarmStorageGetDefaultText : CharBufferPtr This function can be used to determine the default text of a message of an alarm, that was read from the alarm storage. InOut: Scope Name Type Comment Return AlarmStorageGetDefaultText CharBufferPtr A CharBufferPtr containing the default text. A NULL pointer if the corresponding information cannot be retrieved Input udiAlarmGroupId UDINT The internal id of the alarm group, that was read from the alarm storage udiAlarmId UDINT The internal id of the alarm, that was read from the alarm storage iWhichMessage INT The 1-based index of the text id. stringType __SYSTEM.TYPE_CLASS A __SYSTEM.TYPE_CLASS indicating, which type of string has to be retrieved. Pass either __SYSTEM.TYPE_CLASS.TYPE_STRING or __SYSTEM.TYPE_CLASS.TYPE_WSTRING
AlarmStorageGetMessageCount (FUN) ¶ FUNCTION AlarmStorageGetMessageCount : USINT This function can be used to determine the number of messages an alarm belonging to a given alarm group has. InOut: Scope Name Type Comment Return AlarmStorageGetMessageCount USINT The number of messages. 0 if the corresponding information cannot be retrieved Input udiAlarmGroupId UDINT The internal id of the alarm group, that was read from the alarm storage udiAlarmId UDINT The internal id of the alarm, that was read from the alarm storage
IBACnetARRAYN_of_Unsigned.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 CmpBACnet.IEC_BACNET_UNSIGNED Element value to write.