VeriStand .NET API Reference

Alarm Members

The Alarm type exposes the following members.

NameDescription
Alarm
Overloaded. Initializes a new instance of Alarm with the specified name, description, and configuration. This constructor uses channels to specify the UpperLimit and LowerLimit values within which AlarmSource must stay to avoid triggering the alarm.

Methods

NameDescription
EqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Class Destructor (Overrides Section.Finalize().)
FindChildrenByGUID Gets an array that contains the child BaseNode elements of the current node that match the specified TypeGUID. (Inherited from BaseNode.)
FindFirstChildWithName Gets the first child node with the specified name. (Inherited from BaseNode.)
FindNodeByPath Gets a node using the specified path. (Inherited from BaseNode.)
GetChildren Gets an array that contains the child BaseNode elements of the current node. (Inherited from BaseNode.)
GetDocumentPath Gets the path to the system definition file that owns this node. (Inherited from BaseNode.)
GetDocumentRoot Gets the Root node of the system definition file. (Inherited from BaseNode.)
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetParent Gets the parent node of this node. (Inherited from BaseNode.)
GetTypeGets the Type of the current instance. (Inherited from Object.)
MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
RemoveNode Removes this node from the hierarchy, if the node can be removed. (Inherited from BaseNode.)
RenameNode Renames this node to the name you specify, if the node can be renamed and if the name you specify is not already in use by a sibling of this node. (Inherited from BaseNode.)
SetLowerLimit
Overloaded. Sets the low limit to the specified channel value.
SetUpperLimit
Overloaded. Sets the high limit to the specified channel value.
ToStringReturns a String that represents the current Object. (Inherited from Object.)

Properties

NameDescription
AlarmAction Gets or sets the procedure to initiate when the alarm conditions are met.
AlarmSource Gets or sets the channel to monitor for alarm conditions.
BaseNodeType Gets a reference to the internal representation of this node. (Inherited from BaseNode.)
DefaultState Gets or sets the default state (Disabled or Enabled) of the alarm.
Delay Gets or sets the amount of time to wait before triggering the alarm.
Description Gets or sets the description of this node. (Inherited from BaseNode.)
GroupNumber Gets or sets the number of the group to which an alarm belongs.
LowerLimitChannel Gets the channel that determines the lower limit value of the alarm. If the value of AlarmSource falls below this limit, the alarm is triggered.
LowerLimitConstant Gets the constant value that determines the lower limit value of the alarm. If the value of AlarmSource falls below this limit, the alarm is triggered.
LowerLimitIsConstant Gets whether the lower limit value of the alarm is specified by a constant or a channel.
Mode Gets or sets the mode of the alarm (Normal or IndicateOnly).
Name Gets the name of this node. To rename a node, use the RenameNode method. (Inherited from BaseNode.)
NodeID Gets the ID of this node. (Inherited from BaseNode.)
NodePath Gets the path to the node within the system definition file. (Inherited from BaseNode.)
Priority Obsolete. This property is deprecated in NI VeriStand 2011 and later. Use the PriorityNumber property instead.

Setting this property to Low, Medium, or High automatically sets the PriorityNumber to 25, 15, or 5, respectively.

PriorityNumber Gets or sets the priority of an alarm running on the target. Lower numbers specify a higher alarm priority. For example, 4 is higher priority than 31.
TripMessage Gets or sets the message to display when the alarm is tripped.
TypeGUID Gets the GUID associated with the node. Attempts to set the GUID of a BaseNode will generate an exception. (Inherited from BaseNode.)
UpperLimitChannel Gets the channel that determines the upper limit value of the alarm. If the value of AlarmSource exceeds this limit, the alarm is triggered.
UpperLimitConstant Gets the constant that determines the upper limit value of the alarm. If the value of AlarmSource exceeds this limit, the alarm is triggered.
UpperLimitIsConstant Gets whether the upper limit value of the alarm is specified by a constant or a channel.

See Also

Log in to get a better experience