SIM Get Parameter Value VI

Simulation VI and Function

previous page next page
SIM Get Parameter Value VI

Owning Palette: Trim & Linearize VIs

Installed With: Control Design and Simulation Module

Returns the value and type of a parameter you specify. The data types you wire to the Item Name input and the Default Value input determine 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 Get Parameter Value (by Name, Scalar)

Parameters In specifies either the States, Inputs, Outputs, or State Derivatives array that the SIM Query Subsystem VI returns.
Name specifies the name of the parameter.
Value specifies the value of the parameter.
Static Input? is TRUE if the parameter type Static. Static Input? is FALSE if the parameter type is either Variable or Fixed.
Vector? is TRUE if the parameter value is a vector or an array. Vector? is FALSE if the parameter value is a scalar.
Fixed Size? is TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? is FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? is TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? is FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
Item Name specifies the name of the parameter in the Parameters In array for which this VI returns a Value.
Default Value specifies the Value this VI returns if the parameter you specify is not in the Parameters In array. The default value is NaN. The data type you wire to this parameter determines the polymorphic instance to use. If you leave this parameter unwired, you must manually select the polymorphic instance to use.
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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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.
Parameters Out returns the elements of Parameters In.
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.
Parameter Type returns the type of the parameter you specified.

0Variable (default)—Indicates that the SIM Trim VI can change the value of this parameter to satisfy any conditions you specify. The SIM Linearize VI includes Variable inputs and outputs in the linear time-invariant (LTI) model.
1Static—Indicates that the SIM Trim VI excludes this parameter from the search. The SIM Linearize VI excludes Static inputs and outputs from the LTI model. This VI does not distinguish between Static and Variable states and state derivatives.
2Fixed—Indicates that the SIM Trim VI uses the value of this parameter as a condition for trimming a subsystem. The SIM Linearize VI does not distinguish between Fixed and Variable parameters.
Value returns the value of the parameter you specified.
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 Get Parameter Value (by Name, Vector)

Parameters In specifies either the States, Inputs, Outputs, or State Derivatives array that the SIM Query Subsystem VI returns.
Name specifies the name of the parameter.
Value specifies the value of the parameter.
Static Input? is TRUE if the parameter type Static. Static Input? is FALSE if the parameter type is either Variable or Fixed.
Vector? is TRUE if the parameter value is a vector or an array. Vector? is FALSE if the parameter value is a scalar.
Fixed Size? is TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? is FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? is TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? is FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
Item Name specifies the name of the parameter in the Parameters In array for which this VI returns a Value.
Default Value specifies the Value this VI returns if the parameter you specify is not in the Parameters In array.
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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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.
Parameters Out returns the elements of Parameters In.
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.
Parameter Type returns the type of the parameter you specified.

0Variable (default)—Indicates that the SIM Trim VI can change the value of this parameter to satisfy any conditions you specify. The SIM Linearize VI includes Variable inputs and outputs in the linear time-invariant (LTI) model.
1Static—Indicates that the SIM Trim VI excludes this parameter from the search. The SIM Linearize VI excludes Static inputs and outputs from the LTI model. This VI does not distinguish between Static and Variable states and state derivatives.
2Fixed—Indicates that the SIM Trim VI uses the value of this parameter as a condition for trimming a subsystem. The SIM Linearize VI does not distinguish between Fixed and Variable parameters.
Value returns the values of the parameter you specified.
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 Get Parameter Value (by Index, Scalar)

Parameters In specifies either the States, Inputs, Outputs, or State Derivatives array that the SIM Query Subsystem VI returns.
Name specifies the name of the parameter.
Value specifies the value of the parameter.
Static Input? is TRUE if the parameter type Static. Static Input? is FALSE if the parameter type is either Variable or Fixed.
Vector? is TRUE if the parameter value is a vector or an array. Vector? is FALSE if the parameter value is a scalar.
Fixed Size? is TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? is FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? is TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? is FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
Item Index specifies the index number of the parameter in the Parameters In array for which this VI returns a Value.
Default Value specifies the Value this VI returns if the parameter you specify is not in the Parameters In array. The default value is NaN. The data type you wire to this parameter determines the polymorphic instance to use. If you leave this parameter unwired, you must manually select the polymorphic instance to use.
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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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.
Parameters Out returns the elements of Parameters In.
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.
Parameter Type returns the type of the parameter you specified.

0Variable (default)—Indicates that the SIM Trim VI can change the value of this parameter to satisfy any conditions you specify. The SIM Linearize VI includes Variable inputs and outputs in the linear time-invariant (LTI) model.
1Static—Indicates that the SIM Trim VI excludes this parameter from the search. The SIM Linearize VI excludes Static inputs and outputs from the LTI model. This VI does not distinguish between Static and Variable states and state derivatives.
2Fixed—Indicates that the SIM Trim VI uses the value of this parameter as a condition for trimming a subsystem. The SIM Linearize VI does not distinguish between Fixed and Variable parameters.
Value returns the value of the parameter you specified.
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 Get Parameter Value (by Index, Vector)

Parameters In specifies either the States, Inputs, Outputs, or State Derivatives array that the SIM Query Subsystem VI returns.
Name specifies the name of the parameter.
Value specifies the value of the parameter.
Static Input? is TRUE if the parameter type Static. Static Input? is FALSE if the parameter type is either Variable or Fixed.
Vector? is TRUE if the parameter value is a vector or an array. Vector? is FALSE if the parameter value is a scalar.
Fixed Size? is TRUE if you can replace this parameter only with a vector or an array of the same size. Fixed Size? is FALSE if you can replace this parameter with a vector or array of any size.
Fixed Value? is TRUE if the parameter value is a condition that you specify for trimming a subsystem. Fixed Value? is FALSE if the parameter value is not a condition that you specify for trimming a subsystem.
Item Index specifies the index number of the parameter in the Parameters In array for which this VI returns a Value.
Default Value specifies the Value this VI returns if the parameter you specify is not in the Parameters In array.
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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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.
Parameters Out returns the elements of Parameters In.
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.
Parameter Type returns the type of the parameter you specified.

0Variable (default)—Indicates that the SIM Trim VI can change the value of this parameter to satisfy any conditions you specify. The SIM Linearize VI includes Variable inputs and outputs in the linear time-invariant (LTI) model.
1Static—Indicates that the SIM Trim VI excludes this parameter from the search. The SIM Linearize VI excludes Static inputs and outputs from the LTI model. This VI does not distinguish between Static and Variable states and state derivatives.
2Fixed—Indicates that the SIM Trim VI uses the value of this parameter as a condition for trimming a subsystem. The SIM Linearize VI does not distinguish between Fixed and Variable parameters.
Value returns the values of the parameter you specified.
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