Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

SIT Initialize Model (Simulation Interface Toolkit)

LabVIEW Simulation Interface Toolkit 4.0 Help
August 2007

NI Part Number:
371504C-01

»View Product Info

Loads the model DLL, initializes the model, registers the model with the SIT Server, and sets the final time. This VI returns the model time step and the number of input ports and output ports needed. You must call this VI before taking any model steps.

Use the SIT Finalize Model VI to unload the model DLL when you finish executing the model.

Buffer Sizes specifies the sizes of the buffers that the SIT Server uses to communicate with real-time (RT) targets.
number of signals specifies the maximum number of model signals that you can probe. The default value is 50.
circular buffer size specifies the depth of the buffer. The default value is 1000.
num data points specifies the width of the buffer. The default value is 100. The total width of all the signals you probe in one time step must be less than or equal to num data points. The width of a signal is equal to the number of elements in that signal. For example, the width of a 2×2 array is 4.
Note  num data points has a large impact on the performance of the SIT Server. To ensure that the LabVIEW Simulation Interface Toolkit does not allocate more buffer space than necessary, set num data points to the lowest possible value.
path to model DLL specifies the path to the model DLL on the RT target.
stop time specifies the simulated time in seconds after which the model DLL terminates. If you wire –1 to the stop time, the model DLL does not terminate until you stop the VI. The default value is –1.
time step returns the simulated time increment, in seconds, for each step of the model DLL during execution.
Server On? is TRUE if you can start the SIT Server. Server On? is FALSE if you cannot start the SIT Server. The default value is TRUE.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
base period returns the base time step of the simulation, in microseconds.
Simulation Data out returns unique information about the model DLL.
number of model inputs returns the number of inputs to the model DLL.
number of model outputs returns the number of outputs from the model DLL.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
Signal Info returns information about the signals in the model DLL that you can probe. You must create a mapping for a signal in order to probe that signal.
Index returns the index number of the signal.
ID returns a unique string that identifies the signal.
Block Name returns the path of the signal, for example, sinewave/Sine Wave.
Port Number returns the port number of the signal.
Signal Name returns the user-defined name of the signal.
Data Type returns the data type of the signal.
Dimensions returns the dimensions of the signal.
Param Info returns information about the parameters in the model DLL that you can manipulate. You must create a mapping for a parameter in order to manipulate that parameter.
paramidx returns the index of the parameter.
ID returns a unique string that identifies the parameter.
paramname returns the path of the parameter, for example, sinewave/Sine Wave/Amplitude.
datatype returns the data type of the parameter.
Dimensions returns the dimensions of the parameter.
value returns the current value of the parameter.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit