LabVIEW Simulation Interface Toolkit API Reference

SIT Specify Signals to Probe VI

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

SIT Specify Signals to Probe VI

Owning Palette: User Interface VIs

Requires: Simulation Interface Toolkit

Specifies the model signals you want to probe. This VI also specifies any decimation factor you want to apply to the probed signals.

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.

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.
Signals to Probe specifies the model signals you want to probe.
Note  You must format each element of Signals to Probe with the following syntax:

<modelname>/<subsystem1>/<subsystem2>/<subsystemN>/<Block>:<PortNumber>

For example, if you want to probe the Sine Wave block of a model named sinewave, format Signals to Probe as sinewave/Sine Wave:1.
Signal Decimation specifies the decimation factor of the probed signals. For example, if you enter a decimation of 10, the SIT Server only returns every 10th data point for each signal you are probing. Increasing the Signal Decimation value can resolve performance problems and timing errors during the simulation. The default is 1, which specifies no decimation factor.
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.
error out contains error information. This output provides standard error out functionality.

Example

Refer to the batch simulation VI in the labview\examples\Simulation Interface\Batch Simulation directory for an example of using the SIT Specify Signals to Probe VI.

Log in to get a better experience