Simulink.Parameter (Simulink Reference)

Specify the value, value range, data type, and other properties of a block parameter.

Description

This class enables you to create workspace objects that you can then use as the values of block parameters, for example, as the value of a Gain block's Gain parameter. The advantage? Parameter objects let you specify not only the value of a parameter but also other information about the parameter, such as the parameter's purpose, its dimensions, its minimum and maximum values, etc. Some Simulink products make use of this information. For example, Simulink and Real-Time Workshop use information specified by Simulink.Parameter objects to determine whether the parameter is tunable (see "Working with Tunable Parameters).

Property Dialog Box

Value: Value of the parameter. You can use MATLAB expressions to specify the numeric type, dimensions, and data type of the parameter, e.g., single([2+5i -1+3.14159i]).
Data type: Data type of the parameter. Simulink determines the data type from the entry in the parameter's Value field. You cannot set this field yourself.
Units: Measurement units in which this value is expressed, e.g., inches. This field is intended for use in documenting this parameter. Simulink ignores it.
Dimensions: Dimensions of the parameter. Simulink determines the dimensions from the entry in the Value field of this parameter. You cannot set this field yourself.
Complexity: Numeric type (i.e., real or complex) of the parameter. Simulink determines the numeric type of this parameter from the entry in the Value field of this parameter. You cannot set this field yourself.
Minimum: Minimum value that the parameter can have when tuned. This field is intended for use in documenting this parameter. Simulink ignores it.
Maximum: Maximum value that the parameter can have. This field is intended for use in documenting this parameter. Simulink ignores it.
Storage class: Storage class of this parameter. See Storage Classes of Tunable Parameters in the Real-Time Workshop documentation for more information.
Alias: Alternate name for this parameter. Simulink ignores this setting.
Description: Description of this parameter. This field is intended for use in documenting this parameter. Simulink ignores it.

Properties

Name
Access
Description

Value
RW
Value of this parameter. (Value)

DataType
RO
String specifying the name of the data type of this parameter. This field is read-only. (Data type)

Dimensions
RO
Vector specifying the dimensions of this parameter. (Dimensions)

Complexity
RO
String specifying the numeric type of this paramter. Valid values are 'real' or 'complex'. (Complexity)

Min
RW
Minimum value that this parameter can have. Simulink ignores this property. (Minimum)

Max
RW
Maximum value that this parameter can have. Simulink ignores this property. (Maximum)

DocUnits
RW
Measurement units in which this parameter's value is expressed. (Units)

RTWInfo
RW
Information used by Real-Time Workshop for generating code for this parameter. The value of this property is an object of Simulink.ParamRTWInfo class.

Name	Access	Description
`Value`	`RW`	Value of this parameter. (Value)
`DataType`	`RO`	String specifying the name of the data type of this parameter. This field is read-only. (Data type)
`Dimensions`	`RO`	Vector specifying the dimensions of this parameter. (Dimensions)
`Complexity`	`RO`	String specifying the numeric type of this paramter. Valid values are `'real`' or `'complex'`. (Complexity)
`Min`	`RW`	Minimum value that this parameter can have. Simulink ignores this property. (Minimum)
`Max`	`RW`	Maximum value that this parameter can have. Simulink ignores this property. (Maximum)
`DocUnits`	`RW`	Measurement units in which this parameter's value is expressed. (Units)
`RTWInfo`	`RW`	Information used by Real-Time Workshop for generating code for this parameter. The value of this property is an object of `Simulink.ParamRTWInfo` class.

Simulink.NumericType Simulink.ParamRTWInfo