VeriStand .NET API Reference

DataLoggingFile Members

The DataLoggingFile type exposes the following members.

NameDescription
DataLoggingFile Initializes a new instance of the DataLoggingFile class.

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.)
GetDataFileError Gets the DataFileError channel associated with the data logging file. The error channel stores the most recent error that occurred during logging.
GetDataFileStatus Gets the DataFileStatus channel associated with the data logging file. The status channel stores the current status of the data logging process.
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.)
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.)
DataLoggingFileType Gets or sets the file type of an NI-XNET DataLoggingFile. Log files can be TDMS or NCL files.
Description Gets or sets the description of this node. (Inherited from BaseNode.)
Destination Gets or sets the destination for a DataLoggingFile on disk.
Filename Gets or sets the filename of a DataLoggingFile.
Filter Gets or sets whether and how to filter the logged frames.
FrameIDs Gets or sets the frame IDs in the XNET database cluster to either include in or exclude from data logging. Use this property when you configure a Filter for the data logging file.
LimitType Gets or sets the criteria to use to stop logging data to the current file. When the limit you specify occurs, NI VeriStand either stops logging completely or continues logging in a new file, depending on the specified Operation.
LimitValue Gets or sets the value used to determine when to stop logging data to the current log file. This property can represent a size in kilobytes or a time in seconds, depending on the file's LimitType.
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.)
NumberOfBytesToRead Gets or sets the maximum number of raw bytes to read. This number does not represent the number of frames to read. CAN and LIN frames are always 24 bytes long. FlexRay frames vary in length.
Operation Gets or sets the action to take when a trigger condition is met.
Retriggerable Gets or sets whether logging can be retriggered after a stop. If true (True in Visual Basic), logging begins again when the value of TriggerChannel reaches the specified TriggerType.
TDMSChannelName Gets or sets the name of the channel in the TDMS file to log data to.
TDMSGroupName Gets or sets the name of the group in the TDMS file to log data to.
TriggerChannel The channel to watch for the specified TriggerType.
TriggerType Gets or sets the type of trigger to use to start or stop data logging.
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

Log in to get a better experience