LabVIEW Simulation Interface Toolkit API Reference

SIT Get Parameter VI

  • Updated2023-02-21
  • 3 minute(s) read

SIT Get Parameter VI

Owning Palette: User Interface VIs

Requires: Simulation Interface Toolkit

Returns the value of a model parameter you specify.

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.

0Simulation Environment (default)—Specifies that the SIT Server is running on an execution host that is running The MathWorks, Inc. MATLAB® application software.
1MATRIXx—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.
2RT—Specifies that the SIT Server is running on a real-time (RT) target.
Parameter Name specifies the path to a model parameter. You must format Parameter Name with the following syntax:

modelname/subsystem1/subsystem2/subsystemN/Block/Parameter

For example, if you want to manipulate the Amplitude parameter of the Sine Wave block in a model named sinewave, format Parameter Name as sinewave/Sine Wave/Amplitude.
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.

0Simulation Environment (default)—Specifies that the SIT Server is running on an execution host that is running The MathWorks, Inc. MATLAB® application software.
1MATRIXx—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.
2RT—Specifies that the SIT Server is running on a real-time (RT) target.
Parameter Value returns the value of the parameter you specify in the Parameter Name control. Parameter Value always returns a two-dimensional array of double-precision floating-point numbers. If the value is a scalar or a vector, use the Index Array function to convert Parameter Value into the necessary form.
error out contains error information. This output provides standard error out functionality.

Log in to get a better experience