SIT Get Simulation State VI

Owning Palette: User Interface VIs

Requires: Simulation Interface Toolkit

Returns the current status of the simulation.

Example

	SIT Reference in specifies information about the current simulation. TCP Connection specifies the TCP reference for the current connection to the SIT Server. Model Name specifies the name of the current model. Server Type specifies the type of execution host on which the SIT Server is running. 0 Simulation Environment (default)—Specifies that the SIT Server is running on an execution host that is running The MathWorks, Inc. MATLAB® application software. 1 MATRIXx—Specifies that the SIT Server is running on an execution host that is running Xmath. The LabVIEW Simulation Interface Toolkit does not currently support this option. 2 RT—Specifies that the SIT Server is running on a real-time (RT) target.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	SIT Reference out returns information about the current simulation. TCP Connection returns the TCP reference for the current connection to the SIT Server. Model Name returns the name of the current model. Server Type returns the type of execution host on which the SIT Server is running. 0 Simulation Environment (default)—Specifies that the SIT Server is running on an execution host that is running The MathWorks, Inc. MATLAB® application software. 1 MATRIXx—Specifies that the SIT Server is running on an execution host that is running Xmath. The LabVIEW Simulation Interface Toolkit does not currently support this option. 2 RT—Specifies that the SIT Server is running on a real-time (RT) target.
	State returns the current status of the simulation. 0 Default (default)—Specifies that this VI could not determine the state of the simulation. 1 Idle—Specifies that the simulation loaded but is not running. 2 Running—Specifies that the simulation is running. 3 Paused—Specifies that the simulation is paused. 4 Stopped—Specifies that the simulation is stopped. 5 Error—Specifies that an error occurred during the simulation.
	error out contains error information. This output provides standard error out functionality.

Example

Refer to the updatingindicators VI in the labview\examples\Simulation Interface\Updating Indicators directory for an example of using the SIT Get Simulation State VI.