Channel Members

NI VeriStand 2018 Help

Edition Date: May 2018

Part Number: 372846M-01

»View Product Info
Download Help (Windows Only)

Channel Class Constructors Methods Fields Properties See Also


The Channel type exposes the following members.

Constructors

NameDescription
Channel

Overloaded. Initializes a new instance of Channel with the object that you specify. Returns an exception if the object is not of type Channel.

Methods

NameDescription
EqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Class Destructor (Overrides BaseNode.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.)
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.)
GetValueTable Gets the value table for the channel.
MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
RemoveDataSource Removes the source channel that maps to the current channel and provides it data.
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.)

Fields

NameDescription
K_FAULTABLEA bit flag mask specifying that the channel can be faulted.
K_READABLEA bit flag mask specifying that the channel can be read from.
K_SCALABLEA bit flag mask specifying that the channel can be scaled.
K_WRITABLEA bit flag mask specifying that the channel can be written to.

Properties

NameDescription
BaseNodeType Gets a reference to the internal representation of this node. (Inherited from BaseNode.)
BitFields Gets a bitfield mask that is set on the channel.
ColumnDimensions Gets the number of columns in the channel value.
DataSource Gets or sets the source channel that maps to the current channel and provides it data.
DefaultValue Gets the default value of the channel.
Description Gets or sets the description of this node. (Inherited from BaseNode.)
IsReadable Gets a value indicating whether the channel is readable.
IsWritable Gets a value indicating whether the channel is writable.
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.)
RowDimensions Gets the number of rows in the channel value.
Scale Gets or sets the value of the scale property on the channel.
ScaleUnits Gets the units of the scale associated with the channel.
TypeGUID Gets the GUID associated with the node. Attempts to set the GUID of a BaseNode will generate an exception. (Inherited from BaseNode.)
Units Gets or sets the units associated with the channel. This can be any arbitrary string.

See Also

Reference

Channel Class

NationalInstruments.VeriStand.SystemDefinitionAPI Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful