LabVIEW Simulation Interface Toolkit API Reference

SIT Initialize Simulation VI

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

SIT Initialize Simulation VI

Owning Palette: User Interface VIs

Requires: Simulation Interface Toolkit

Initializes the host VI by creating a connection to the execution host on which the SIT Server is running. This VI also opens all the necessary models that the host VI specifies.

Example

Project Directory specifies the path to the directory that contains the data logging and file playback configuration files.
Model Path specifies the path to the model.
hostname specifies the name of the computer on which the SIT Server is running. The default value is localhost.
port specifies the TCP/IP port on hostname on which the SIT Server is running. The default is 6011.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Path to Driver VI specifies the local path to the driver VI you want to download to the real-time (RT) target.
Note  Wire a value to this input only when you download the simulation model to an RT target.
Path to Model DLL specifies the local path to the model DLL you want to download to an RT target.
Note  Wire a value to this input only when you download the simulation model to an RT target.
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 Initialize Simulation VI.