VeriStand .NET API Reference

Target Members

The Target type exposes the following members.

NameDescription
Target Initializes a new instance of Target with the specified name and target type.

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.)
GetAlarms Gets the Alarms section under the target, which contains any alarms you configure to notify the user that the value of a particular channel has gone outside a specified range of values. Alarms also can trigger the execution of a procedure.
GetCalculatedChannels Gets the CalculatedChannels section under the target, which contains any calculated channels you configure. These channels produce new values based on calculations performed on other channels in the system.
GetChildren Gets an array that contains the child BaseNode elements of the current node. (Inherited from BaseNode.)
GetCustomDevices Gets the CustomDevices section under the target, which contains any custom devices you configure. Custom devices enable you to customize and extend the functionality of NI VeriStand by packaging LabVIEW code, or any code you can call from LabVIEW, into a device that you can add to an NI VeriStand system definition file and deploy to a target.
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.)
GetHardware Gets the Hardware section under the target, which contains all the Chassis you configure.
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetParent Gets the parent node of this node. (Inherited from BaseNode.)
GetProcedures Gets the Procedures section under the target, which contains any procedures you add. Procedures specify sets of actions that the VeriStand Engine executes in response to an event, such as an alarm.
GetSimulationModels Gets the SimulationModels section under the target, which contains any models you import into the system definition.
GetStimulus Gets the Stimulus section, which contains the stimulus generators available in the Legacy Stimulus Profile Editor.
GetSystemChannels Gets the SystemChannels section under the target, which contains a variety of channels that monitor the state and condition of various aspects of the system.
GetTypeGets the Type of the current instance. (Inherited from Object.)
GetUserChannels Gets the UserChannels section under the target, which contains and user channels you configure. User channels store a single value, and can be variables in procedures, stimulus profiles, and so on.
GetXNETDatabases Gets the XNETDatabases section of the target, which contains any XNET Databases you add to the system definition to run XNET devices.
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.)
SetControlLoopTimingSourceToAutomatic Sets the Primary Control Loop timing source to automatic.
SetControlLoopTimingSourceToCustomDevice Sets the Primary Control Loop timing source to the specified custom device.
SetControlLoopTimingSourceToDAQ Sets the Primary Control Loop timing source to the DAQ device with the specified name and configuration.
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.)
ControlLoopTimingSource Gets the timing source for the Primary Control Loop.
CustomTimingDevice Gets or sets the custom device that serves as the timing source for the Primary Control Loop (PCL). This property is only valid if ControlLoopTimingSource is CustomDeviceTiming.
DAQDigitalLinesDecimation Obsolete. Gets or sets how frequently the Primary Control Loop (PCL) reads and writes DAQ digital line values. The DIO Loop, which receives and sends these values from and to the PCL, executes at a rate of 100Hz. If you set the PCL to execute at a rate faster than 100Hz, use this property to specify a higher decimation value and reduce the frequency with which the PCL reads and writes the digital line values.
DAQDigitalLinesRate Gets or sets how frequently the Primary Control Loop (PCL) reads and writes DAQ digital line values. The DIO Loop, which receives and sends these values from and to the PCL, executes at this rate and cannot be faster than the PCL loop.
DAQTimeout Gets the amount of time to wait for a DAQ device to transfer data before timing out. This property is only valid of the ControlLoopTimingSource is DAQTiming.
DAQTimingDevice Gets or sets the DAQ device that serves as the timing source for the Primary Control Loop (PCL). This property is only valid if ControlLoopTimingSource is DAQTiming.
DataProcessingLoopDecimation Gets or sets how frequently the Data Processing Loop (DPL) reads values from the Primary Control Loop (PCL). A value of 1 specifies that the DPL reads values on every iteration of the PCL. You can specify a higher value to read values less frequently and speed execution of the system.
DataProcessingLoopProcessor Gets or sets the processor on which to execute the Data Processing Loop. -2 is any available processor. If you specify an invalid processor, the loop executes on the first available processor.
DataRate Gets or sets the execution rate of the Data Processing Loop.
DeploymentGroup Gets or sets the deployment group to which a target belongs.
Description Gets or sets the description of this node. (Inherited from BaseNode.)
DisableTarget Gets or sets the Boolean flag indicating whether a target is disabled.
ExecutionMode Gets or sets the execution mode (parallel or low latency) of the loops of the VeriStand Engine.
FilterDAQErrors Gets or sets whether to filter errors from NI-DAQmx function calls. Set this property to true (True in Visual Basic) if you do not want the system to shut down when an NI-DAQ device reports an error.
FilterWatchdogErrors Gets or sets whether to filter errors reported by the timing watchdog. For example, if you set the Primary Control Loop to execute at a high rate and your system contains large or complex models, the watchdog reports an error if the models cannot execute quickly enough to keep up with the Primary Control Loop. Set this property to true (True in Visual Basic) if you want NI VeriStand to ignore these errors.
FPGAScanInterfaceMode Gets or sets the interface mode for the NI Scan Engine on RT targets. You can use this property to override the current settings of the NI Scan Engine, which can be useful for certain C Series modules, such as NI 986x series devices. This setting has no effect on Windows targets.
IPAddress Gets or sets the IP address of the target.
MaximumStreamedChannels Gets or sets the maximum number of channels that the VeriStand Engine can stream to the host.
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.)
OperatingSystem Gets or sets the operating system of the target.
PrimaryControlLoopProcessor Gets or sets the processor on which to execute the Primary Control Loop (PCL).
TargetRate Gets or sets the execution rate of the target in hertz.
TimedLoopSleepTime Gets the amount of time in microseconds the Primary Control Loop (PCL) sleeps after each tick. NI VeriStand ignores this value if the master timing device has an external timing source.
Timeout Gets or sets the amount of time to wait for a start trigger from the DAQ device before timing out. This property is only valid if the ControlLoopTimingSource is DAQTiming.
TimingSourceDAQSettings Gets or sets the timing source setting for the DAQ device that is timing the Primary Control Loop. This property is only valid if ControlLoopTimingSource is DAQTiming.
TypeGUID Gets the GUID associated with the node. Attempts to set the GUID of a BaseNode will generate an exception. (Inherited from BaseNode.)
WarmupTime_ms Gets or sets the amount of time the system waits before considering late flags. You can set a warm-up time to give the system time to allocate and manage resources.

See Also

Log in to get a better experience