AlarmManager (LIB)

Version

3.5.17.0

Namespace

AlarmManager

Author

None

Placeholder

AlarmManager

Description 1

This library contains the IEC components for the alarm handling

Contents:

• ALARMGROUP_ID (ALIAS)
• ALARM_ID (ALIAS)
• Access to alarm storage (internal)
  • only internal
    • GetLatchVarColumnID (FUN)
• Alarm storage API
  • AlarmStorageConvertFromTimestamp (FUN)
  • AlarmStorageConvertToTimestamp (FUN)
  • AlarmStorageConvertValueToLREAL (FUN)
  • AlarmStorageConvertValueToREAL (FUN)
  • AlarmStorageConvertValueToString (FUN)
  • AlarmStorageGetDefaultText (FUN)
  • AlarmStorageGetMessageCount (FUN)
  • AlarmStorageGetTextId (FUN)
  • AlarmStorageGetTextListName (FUN)
  • AlarmStorageReader (FB)
    • AlarmStorageReader.AddAlarmStorageListener (METH)
    • AlarmStorageReader.ContinueReading (METH)
    • AlarmStorageReader.FB_Init (METH)
    • AlarmStorageReader.GetFirstLastRowID (METH)
    • AlarmStorageReader.GetMinMaxTimestamps (METH)
    • AlarmStorageReader.Read (METH)
    • AlarmStorageReader.RemoveAlarmStorageListener (METH)
    • AlarmStorageReader.SemaphoreAcquire (METH)
    • AlarmStorageReader.SemaphoreRelease (METH)
    • private
      • AlarmStorageReader.prvReadLatchVarString (METH)
      • AlarmStorageReader.prvReadLatchVarString2 (METH)
      • AlarmStorageReader.prvRetrieveLatchVarValue (METH)
      • AlarmStorageReader.prvTblAlarmFindTimestamp (METH)
  • AlarmStorageReaderGlobals (GVL)
  • AlarmStorageRow (FB)
    • AlarmStorageRow.GetLatchVarValue (METH)
    • AlarmStorageRow.SetLatchVarValue (METH)
  • AlarmStorageStaticData (STRUCT)
  • EAlarmStorageReaderErrors (ENUM)
  • IAlarmStorageListener (ITF)
    • IAlarmStorageListener.AlarmAdded (METH)
    • IAlarmStorageListener.AlarmModified (METH)
  • IAlarmStorageReaderConsumer (ITF)
    • IAlarmStorageReaderConsumer.AlarmRead (METH)
    • IAlarmStorageReaderConsumer.BeforeReading (METH)
    • IAlarmStorageReaderConsumer.LatchVariableRead (METH)
    • IAlarmStorageReaderConsumer.ReadingDataCompleted (METH)
  • IAlarmStorageReaderConsumer2 (ITF)
    • IAlarmStorageReaderConsumer2.ByteOrder (PROP)
• Enumerations
  • AlarmState (ENUM)
  • AlarmStateTransition (ENUM)
  • EAlarmType (ENUM)
  • EDBActiveIndex (ENUM)
  • EDBType (ENUM)
  • EFilterLatchContent (ENUM)
  • EFilterTimeRangeType (ENUM)
• Function blocks
  • DefaultAlarmFilterCriteria (FB)
  • Utilities
    • TextHelper (FB)
      • TextHelper.FB_Exit (METH)
      • TextHelper.FromString (METH)
      • TextHelper.FromWString (METH)
• Functions
  • ConvertTimestampToLDateAndTime (FUN)
  • DT_to_Timestamp (FUN)
  • DT_to_Timestamp2 (FUN)
  • Filters
    • ElaborateLatchFilterCriteria (FUN)
    • ElaborateTimeRangeFilterCriteria (FUN)
  • FormatTimestamp2 (FUN)
  • FormatTypedValue (FUN)
  • GetLINTValue (FUN)
  • GetLINTValue2 (FUN)
  • GetLINTValue3 (FUN)
  • HasAlarmStorageRecordLimit (FUN)
  • MonitorPopulateFilterCriteria (FUN)
  • SplitString (FUN)
  • Swap
    • SwapDword (FUN)
    • SwapLword (FUN)
    • SwapWord (FUN)
  • Timestamp_to_DT (FUN)
  • deprecated
    • FormatTimestamp (FUN)
• GetBooleanProperty (FUN)
• GetCompany (FUN)
• GetNumberProperty (FUN)
• GetTextProperty (FUN)
• GetTitle (FUN)
• GetVersion (FUN)
• GetVersionProperty (FUN)
• Globals
  • AlarmGlobals (GVL)
  • AlarmParams (PARAMS)
  • ReturnValues (GVL)
• Informazioni sul progetto
  • GetTextProperty2 (FUN)
• Interfaces
  • IAlarm (ITF)
    • Access to timestamps
      • IAlarm.GetTimestampAcknowledge (METH)
      • IAlarm.GetTimestampActive (METH)
      • IAlarm.GetTimestampInactive (METH)
      • IAlarm.GetTimestampLast (METH)
    • Access to values
      • IAlarm.GetCurrentValue (METH)
      • IAlarm.GetLatchVar1Value (METH)
      • IAlarm.GetLatchVar2Value (METH)
      • IAlarm.GetTriggerValue (METH)
    • IAlarm.GetAlarmClass (METH)
    • IAlarm.GetAlarmGroup (METH)
    • IAlarm.GetID (METH)
    • IAlarm.GetInternalID (METH)
    • IAlarm.GetMessage (METH)
    • IAlarm.GetState (METH)
    • IAlarm.IsDeactivated (METH)
  • IAlarm2 (ITF)
  • IAlarm3 (ITF)
    • IAlarm3.GetCountLatchVariables (METH)
    • IAlarm3.GetCountMessages (METH)
    • IAlarm3.GetLatchVarValue (METH)
    • IAlarm3.GetMessage2 (METH)
    • IAlarm3.SetLatchVarValue (METH)
  • IAlarm4 (ITF)
    • IAlarm4.KindOf (PROP)
  • IAlarm5 (ITF)
    • Access to offsets
      • IAlarm5.OffsetAcknowledge (PROP)
      • IAlarm5.OffsetActive (PROP)
      • IAlarm5.OffsetInactive (PROP)
      • IAlarm5.OffsetLast (PROP)
  • IAlarmClass (ITF)
    • IAlarmClass.GetInternalID (METH)
    • IAlarmClass.GetName (METH)
    • IAlarmClass.GetPriority (METH)
    • IAlarmClass.IsAcknowledgeSeparately (METH)
  • IAlarmConfiguration7 (ITF)
    • IAlarmConfiguration7.ClearHistory (METH)
  • IAlarmGroup (ITF)
    • IAlarmGroup.GetInternalID (METH)
    • IAlarmGroup.GetName (METH)
  • IAlarmGroup3 (ITF)
    • IAlarmGroup3.GetID (METH)
  • IAlarmHandler (ITF)
    • IAlarmHandler.AcknowledgeAll (METH)
    • IAlarmHandler.AcknowledgeAllOfGroup (METH)
    • IAlarmHandler.AcknowledgeOneOfGroup (METH)
    • IAlarmHandler.RaiseEvent (METH)
  • IAlarmHandler2 (ITF)
    • IAlarmHandler2.GetActiveAlarms (METH)
    • IAlarmHandler2.GetAlarmsFromStorage (METH)
    • IAlarmHandler2.GetCountAlarmsFromStorage (METH)
    • IAlarmHandler2.RegisterClient (METH)
    • IAlarmHandler2.UnregisterClient (METH)
  • IAlarmHandler3 (ITF)
  • IAlarmHandler4 (ITF)
    • IAlarmHandler4.RegisterAlarmStateChangedListener (METH)
  • IAlarmHandler5 (ITF)
    • IAlarmHandler5.AlarmConfigurationCount (PROP)
    • IAlarmHandler5.GetAlarmConfiguration (METH)
  • IAlarmHandlerRemoteMonitor (ITF)
    • IAlarmHandlerRemoteMonitor.GetProxyAlarmClassesDescription (METH)
    • IAlarmHandlerRemoteMonitor.GetProxyAlarmGroupsDescription (METH)
    • IAlarmHandlerRemoteMonitor.GetProxyAlarmsDescription (METH)
    • IAlarmHandlerRemoteMonitor.GetProxyStatistics (METH)
    • IAlarmHandlerRemoteMonitor.GetProxyStatisticsSingleActivity (METH)
  • IAlarmManagerClient (ITF)
    • IAlarmManagerClient.ActiveAlarmsChanged (METH)
    • IAlarmManagerClient.AlarmStorageModified (METH)
    • IAlarmManagerClient.GetFilterCriteria (METH)
  • IAlarmManagerClient2 (ITF)
    • IAlarmManagerClient2.EventOccurred (METH)
  • IAlarmNotifiable (ITF)
    • IAlarmNotifiable.Execute (METH)
  • IAlarmRemote (ITF)
    • IAlarmRemote.RemoteDeviceName (PROP)
  • IAlarmStateChangedEventListener (ITF)
    • IAlarmStateChangedEventListener.ActionStateChanged (METH)
    • IAlarmStateChangedEventListener.DeactivationStateChanged (METH)
    • IAlarmStateChangedEventListener.RegisterListener (METH)
  • IAlarmStateChangedListener (ITF)
    • IAlarmStateChangedListener.AlarmStateChanged (METH)
  • IAlarmStateChangedListener2 (ITF)
    • IAlarmStateChangedListener2.AlarmDeactivationStateChanged (METH)
• Optimized placeholder replacement
  • AlarmLatchAdapter (FB)
    • AlarmLatchAdapter.FB_Init (METH)
    • AlarmLatchAdapter.GetCountLatchVariables (METH)
    • AlarmLatchAdapter.GetLatchVarValue (METH)
    • AlarmLatchAdapter.Initialize (METH)
    • AlarmLatchAdapter.SetLatchVarValue (METH)
• Proxy
  • IProxyMonitor (ITF)
    • IProxyMonitor.GetAlarmClassesDescription (METH)
    • IProxyMonitor.GetAlarmGroupsDescription (METH)
    • IProxyMonitor.GetAlarmsDescription (METH)
    • IProxyMonitor.GetStatistics (METH)
    • IProxyMonitor.GetStatisticsSingleReq (METH)
  • ProxyEnumState (ENUM)
  • ProxyFbHistActiveAlarmsQueue (FB)
    • ProxyFbHistActiveAlarmsQueue.EffectiveRead (PROP)
    • ProxyFbHistActiveAlarmsQueue.FB_Exit (METH)
    • ProxyFbHistActiveAlarmsQueue.GetActiveCount (METH)
    • ProxyFbHistActiveAlarmsQueue.GetAvailableEntries (METH)
    • ProxyFbHistActiveAlarmsQueue.GetLastState (METH)
    • ProxyFbHistActiveAlarmsQueue.GetRowIDActive (METH)
    • ProxyFbHistActiveAlarmsQueue.GetRowIDLocal (METH)
    • ProxyFbHistActiveAlarmsQueue.Initialize (METH)
    • ProxyFbHistActiveAlarmsQueue.Insert (METH)
    • ProxyFbHistActiveAlarmsQueue.IsPresentRowIDRemote (METH)
    • ProxyFbHistActiveAlarmsQueue.QueueSize (PROP)
    • ProxyFbHistActiveAlarmsQueue.Remove (METH)
    • ProxyFbHistActiveAlarmsQueue.SetLastState (METH)
  • ProxyFbHistAlarmsRowQueue (FB)
    • ProxyFbHistAlarmsRowQueue.FB_Exit (METH)
    • ProxyFbHistAlarmsRowQueue.GetAvailableEntries (METH)
    • ProxyFbHistAlarmsRowQueue.GetCountToRegister (METH)
    • ProxyFbHistAlarmsRowQueue.GetItem (METH)
    • ProxyFbHistAlarmsRowQueue.Initialize (METH)
    • ProxyFbHistAlarmsRowQueue.MaxEntries (PROP)
  • ProxyGVL (GVL)
  • Statistics_LTIME (FB)
    • Statistics_LTIME.Average (PROP)
    • Statistics_LTIME.Count (PROP)
    • Statistics_LTIME.Maximum (PROP)
    • Statistics_LTIME.Minimum (PROP)
  • Structures
    • Monitor
      • ProxyStructMonitor (STRUCT)
      • ProxyStructMonitorAlarmClassDesc (STRUCT)
      • ProxyStructMonitorAlarmDesc (STRUCT)
      • ProxyStructMonitorAlarmGroupDesc (STRUCT)
      • ProxyStructMonitorRequest (STRUCT)
    • ProxyStructError (STRUCT)
• Service
  • AlarmFctWriteLatchVariable (FUN)
  • AlarmIndices (STRUCT)
  • AlarmStorageLatchVariable (STRUCT)
  • HistoricalActiveAlarmRowID (STRUCT)
• Structures
  • LatchVariable (STRUCT)
  • MonitorDBStatus (STRUCT)
  • MonitorFilterByDateTime (STRUCT)
  • MonitorFilterByLatch (STRUCT)
• TIMESTAMP (ALIAS)
• TL_AlarmStatus (Text List)

Indices and tables

1

Based on AlarmManager.library, last modified 20.04.2021, 14:28:55. LibDoc 4.3.0.0

The content file AlarmManager.library.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 14:28:55.