SIM Query Subsystem VI

Simulation VI and Function

previous page next page
SIM Query Subsystem VI

Owning Palette: Trim & Linearize VIs

Installed With: Control Design and Simulation Module

Returns the names and values of the parameters of the states, inputs, outputs, and state derivatives of a simulation subsystem. Use these parameters with the SIM Set Parameter Value VI to specify conditions and values that the SIM Trim VI and the SIM Linearize VI use. The data type you wire to the Path input determines the polymorphic instance to use.

Use the pull-down menu to select an instance of this VI.

 Place on the block diagram  Find on the Functions palette

SIM Query Subsystem (Path)

Path specifies the path to the simulation subsystem on which you want to operate.
States returns the initial states of the simulation subsystem.
Name returns the name of the parameter.
Value returns the value of the parameter.
Static Input? returns TRUE if the parameter type is Static. Static Input? returns FALSE if the parameter type is either Variable or Fixed.
Vector? returns TRUE if the parameter value is a vector or an array. Vector? returns FALSE if the parameter value is a scalar.
Fixed Size? returns TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? returns FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? returns TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? returns FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
Inputs returns the current values of the inputs of the simulation subsystem.
Name returns the name of the parameter.
Value returns the value of the parameter.
Static Input? returns TRUE if the parameter type is Static. Static Input? returns FALSE if the parameter type is either Variable or Fixed.
Vector? returns TRUE if the parameter value is a vector or an array. Vector? returns FALSE if the parameter value is a scalar.
Fixed Size? returns TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? returns FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? returns TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? returns FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
Outputs returns the current values of the outputs of the simulation subsystem.
Name returns the name of the parameter.
Value returns the value of the parameter.
Static Input? returns TRUE if the parameter type is Static. Static Input? returns FALSE if the parameter type is either Variable or Fixed.
Vector? returns TRUE if the parameter value is a vector or an array. Vector? returns FALSE if the parameter value is a scalar.
Fixed Size? returns TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? returns FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? returns TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? returns FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
State Derivatives returns the derivatives of the states of the simulation subsystem. By default, State Derivatives contains all zeros of type Fixed, which indicates that the SIM Trim VI attempts to satisfy a steady-state condition.
Name returns the name of the parameter.
Value returns the value of the parameter.
Static Input? returns TRUE if the parameter type is Static. Static Input? returns FALSE if the parameter type is either Variable or Fixed.
Vector? returns TRUE if the parameter value is a vector or an array. Vector? returns FALSE if the parameter value is a scalar.
Fixed Size? returns TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? returns FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? returns TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? returns FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
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.

SIM Query Subsystem (Reference)

Reference specifies a reference to the subsystem on which you want to operate.
States returns the initial states of the simulation subsystem.
Name returns the name of the parameter.
Value returns the value of the parameter.
Static Input? returns TRUE if the parameter type is Static. Static Input? returns FALSE if the parameter type is either Variable or Fixed.
Vector? returns TRUE if the parameter value is a vector or an array. Vector? returns FALSE if the parameter value is a scalar.
Fixed Size? returns TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? returns FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? returns TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? returns FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
Inputs returns the current values of the inputs of the simulation subsystem.
Name returns the name of the parameter.
Value returns the value of the parameter.
Static Input? returns TRUE if the parameter type is Static. Static Input? returns FALSE if the parameter type is either Variable or Fixed.
Vector? returns TRUE if the parameter value is a vector or an array. Vector? returns FALSE if the parameter value is a scalar.
Fixed Size? returns TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? returns FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? returns TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? returns FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
Outputs returns the current values of the outputs of the simulation subsystem.
Name returns the name of the parameter.
Value returns the value of the parameter.
Static Input? returns TRUE if the parameter type is Static. Static Input? returns FALSE if the parameter type is either Variable or Fixed.
Vector? returns TRUE if the parameter value is a vector or an array. Vector? returns FALSE if the parameter value is a scalar.
Fixed Size? returns TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? returns FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? returns TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? returns FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
State Derivatives returns the derivatives of the states of the simulation subsystem. By default, State Derivatives contains all zeros of type Fixed, which indicates that the SIM Trim VI attempts to satisfy a steady-state condition.
Name returns the name of the parameter.
Value returns the value of the parameter.
Static Input? returns TRUE if the parameter type is Static. Static Input? returns FALSE if the parameter type is either Variable or Fixed.
Vector? returns TRUE if the parameter value is a vector or an array. Vector? returns FALSE if the parameter value is a scalar.
Fixed Size? returns TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? returns FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? returns TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? returns FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
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.
previous page start next page