VeriStand .NET API Reference

IWorkspace2 Members

The IWorkspace2 type exposes the following members.

NameDescription
AsyncDisconnectFromSystem Asynchronously disconnects the VeriStand Gateway from all connected targets.
ConnectToSystem
Overloaded. Connects the VeriStand Gateway to one or more targets running the system definition file you specify.
DisconnectFromSystem Disconnects the VeriStand Gateway from all connected targets.
GetAliasList Gets all the aliases defined for channels in the system, and the channels to which each alias corresponds. (Inherited from IWorkspace.)
GetChannelVectorValues Gets the vector values of a channel on the target. (Inherited from IWorkspace.)
GetEngineState This method is deprecated in NI VeriStand 2010 and later. Use the GetSystemState method instead.

Returns the current state of the VeriStand Engine.

(Inherited from IWorkspace.)
GetIUDPChannelStreamSession Accesses the IUDPChannelStreamSession interface, which you can use to view buffered waveform data published by the VeriStand Gateway.
GetMultipleChannelValues Gets the values of multiple scalar channels running on the target. To get the values of vector channels, use the GetChannelVectorValues method. (Inherited from IWorkspace.)
GetMultipleSystemNodesData Gets information about multiple nodes in the system definition file. (Inherited from IWorkspace.)
GetSingleChannelValue Gets the value of a single channel on the target. (Inherited from IWorkspace.)
GetSystemNodeChannelList Gets a list of all the channels under the nodeName you specify. This method performs a recursive search. (Inherited from IWorkspace.)
GetSystemNodeChildren Gets all child nodes, including channels, of the nodeName you specify. This method does not perform a recursive search. You can use the GetSystemNodeChannelList to perform a recursive search of all the channels under a specified node. (Inherited from IWorkspace.)
GetSystemNodeWaveformList Gets a list of all the waveforms under the nodeName you specify. This method performs a recursive search.
GetSystemState Gets the current state of the system to which the VeriStand Gateway is connected. Use the ConnectToSystem method to connect to a system.
GetTargetState Gets the current state of a target
LockConnection Locks the current VeriStand Gateway connection. If the connection already is locked, you must provide the current password in order to set a new one.
LockWorkspaceFile This method is deprecated in NI VeriStand 2010 and later. Use the LockConnection method instead.

Locks a running workspace configuration so that a user must provide a password to stop running the configuration. The configuration must be running when you call this method. If the configuration has an existing password, you must provide the password to the old_password parameter in order to set the new password.

(Inherited from IWorkspace.)
RunWorkspaceFile This method is deprecated in NI VeriStand 2010 and later. Use the ConnectToSystem method instead.

Runs the workspace configuration you specify. If a configuration is already running when you call this method, the method returns an error.

(Inherited from IWorkspace.)
SetChannelValues Sets values for the channels you specify.
SetChannelVectorValues Sets the vector values of a channel on the target. (Inherited from IWorkspace.)
SetMultipleChannelValues Sets the values of multiple channels on the target. (Inherited from IWorkspace.)
SetSingleChannelValue Sets the value of a single channel on the target. (Inherited from IWorkspace.)
StartDataLogging Starts logging data for the specified configuration_name.
StopDataLogging Stops logging data for the specified configuration_name.
StopWorkspaceFile This method is deprecated in NI VeriStand 2010 and later. Use the DisconnectFromSystem method instead.

Stops running the current configuration.

(Inherited from IWorkspace.)
UnlockConnection Unlocks the current VeriStand Gateway connection.
UnlockWorkspaceFile This method is deprecated in NI VeriStand 2010 and later. Use the UnlockConnection method of the IWorkspace2 interface instead.

Unlocks the currently running workspace configuration.

(Inherited from IWorkspace.)

Events

NameDescription
OnGatewayErrorNotification Event for an unhandled error on the VeriStand Gateway.
OnGatewayStatusNotification Event for status notifications from the VeriStand Gateway.
OnSystemStateChange Callback invoked when a system state changes. (Inherited from IWorkspace.)

See Also

Log in to get a better experience