AlarmItem Class

Class for AlarmItem operation.
Public Class AlarmItem
This language is not supported or no code example is available.
public class AlarmItem
This language is not supported or no code example is available.
Name Description
Public constructor AlarmItem(RunObj, int) Construct the instance
Top
Name Description
Public property AckTime Time that an alarm Item is set at "Acknowledge".
Public property ActiveLocalTime Time that an Alarm Item started in local time.
Public property ActiveTime Time that an Alarm Item started.
Public property Alarm Indicates whether alarm item is active (1) or normalized (0)
Public property Area Area name to which an Alarm Item belongs.
Public property AuxValue Auxiliary value.
Public property AuxValue2 Auxiliary2 value.
Public property AuxValue3 Auxiliary3 value.
Public property BlinkBG Configured Background Blink Type of an Alarm Item.
Public property BlinkFG Configured Foreground Blink Type of an Alarm Item.
Public property Category Categrory
Public property ColorBG Configured Background Color of an Alarm Item.
Public property ColorFG Configured Foreground Color of an Alarm Item.
Public property Comment Alarm comment
Public property Condition Configured evaluation condition to generate an AlarmItem.
Public property Deadband Defined Deadband of an AlarmItem. Configured AlarmItem downtime.
Public property Disable Property to Disable/Enable an AlarmItem.
Public property Duration How long alarm remained active
Public property Group Group name to which an Alarm Item belongs.
Public property Id Gets the ID of an Alarm Item.
Public property ItemName Item name
Public property LastValue Last value when alarm item was checked
Public property Level Asset level
Public property Limit Get defined value to evaluate AlarmItem conditions
Public property Limit0 Reserved.
Public property Limit1 Used as alarm limit when Alarm.EnableLimitsByShift is true and Alarm.CurrentShift is 1.
Public property Limit2 Used as alarm limit when Alarm.EnableLimitsByShift is true and Alarm.CurrentShift is 2.
Public property Message Get the configured Message to display when Alarm occurs.
Public property MessageExtended Get the configured Message to display when Alarm occurs including initial char "*" to indicate that an acknowledge is required.
Public property MessageValue Get the configured Message to display when Alarm occurs.
Public property NormTime Time that an Alarm takes to "Normalization".
Public property PreviousValue Previous value when alarm item was checked
Public property Priority Get an AlarmItem Priority.
Public property Setpoint Defined Setpoint of an AlarmItem.
Public property SetpointDeadband Represents the dead band for the SetPoint property.
Public property State Get an Alarm Item State. Alarm Item state can be: Active, Acknowledge or Normalized
Public property Suspend Property to suspend an AlarmItem.
Public property TagName Get the defined TagName that will be evaluated to generate an Alarm Item.
Public property UnAck Property set/get an Unacknowledge Alarm Item.
Public property UserName User name acknowledges alarm
Top
T.Modules.Alarm.AlarmItem

.NET Framework

Supported in: 4.6.2, 4.7

In this article

Definition