SIM Get Parameter Value VI

Owning Palette: Trim & Linearize VIs

Requires: Control Design and Simulation Module

Returns the value and type of a parameter you specify. Wire data to the Item Name and Default Value inputs to determine the polymorphic instance to use or manually select the instance.

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 node runs. This input provides standard error in functionality.
	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. 0 Variable (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. 1 Static—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. 2 Fixed—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. This output provides standard error out functionality.

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 node runs. This input provides standard error in functionality.
	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. 0 Variable (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. 1 Static—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. 2 Fixed—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. This output provides standard error out functionality.

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 node runs. This input provides standard error in functionality.
	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. 0 Variable (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. 1 Static—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. 2 Fixed—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. This output provides standard error out functionality.

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 node runs. This input provides standard error in functionality.
	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. 0 Variable (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. 1 Static—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. 2 Fixed—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. This output provides standard error out functionality.