AlarmFolder Members

NI VeriStand 2018 Help

Edition Date: May 2018

Part Number: 372846M-01

»View Product Info
Download Help (Windows Only)

AlarmFolder Class Constructors Methods Properties See Also


The AlarmFolder type exposes the following members.

Constructors

NameDescription
AlarmFolder Initializes a new instance of AlarmFolder with the specified name and description.

Methods

NameDescription
AddAlarm

Overloaded. Adds the specified Alarm to the AlarmFolder.

AddAlarmFolder

Overloaded. Adds the specified AlarmFolder to the AlarmFolder.

AddNewAlarm

Overloaded. Adds a new Alarm with the specified name, description, and configuration to the AlarmFolder.

AddNewAlarmFolder

Overloaded. Adds a new AlarmFolder with the specified name and description to the AlarmFolder.

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.)
GetAlarmFolderList

Overloaded. Gets an array that contains the current AlarmFolder elements from AlarmFolder.

GetAlarmList

Overloaded. Gets an array that contains the current Alarm elements from AlarmFolder.

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.)
GetNodeErrors Gets all the reported errors for this node. (Inherited from BaseNode.)
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.)
ToStringReturns a String that represents the current Object. (Inherited from Object.)

Properties

NameDescription
BaseNodeType Gets a reference to the internal representation of this node. (Inherited from BaseNode.)
Description Gets or sets the description of this node. (Inherited from BaseNode.)
LogFileProducer Gets a value indicating whether the node is a log file producer (Inherited from BaseNode.)
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.)
TypeGUID Gets the GUID associated with the node. Attempts to set the GUID of a BaseNode will generate an exception. (Inherited from BaseNode.)

See Also

Reference

AlarmFolder Class

NationalInstruments.VeriStand.SystemDefinitionAPI Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful