simulink.multisim.BlockParameter

Specify a range of block parameters

Since R2024a

Description

The simulink.multisim.DesignStudy object represents a design study that allows you to run multiple simulations at a large scale. With the simulink.multisim.BlockParameter object, you can specify values for block parameters in your model for massive simulations using parameter combinations.

Creation

Syntax

bp = simulink.multisim.BlockParameter(blkpath,blkparam,paramval)

Description

bp = simulink.multisim.BlockParameter(blkpath,blkparam,paramval) specifies the value of the block parameter blkparam as paramval for the block blkpath on the simulink.multisim.BlockParameter object bp.

You can use the simulink.multisim.BlockParameter object to specify parameter values for any block throughout a model hierarchy.

Input Arguments

blkpath — Path to block for which to specify parameter value

string | character vector

Path to block for which to specify parameter value, specified as a string or a character vector.

Example: bp = simulink.multisim.BlockParameter("vdp/Mu","Gain","0.1") specifies the Gain parameter value for the block named Mu in the model named vdp as 0.1.

blkparam — Name of block parameter to set

string | character vector

Name of block parameter to set, specified as a string or a character vector.

Example: bp = simulink.multisim.BlockParameter("vdp/Mu","Gain","0.1") specifies the Gain parameter value for the block named Mu in the model named vdp as 0.1.

paramval — Block parameter value

valid value for specified block parameter

Block parameter value, specified as a valid value for the specified block parameter. Many block parameters, such as the Gain parameter of the Gain block, require specifying the parameter value as a string or a character vector, including for numeric block parameter values.

Example: bp = simulink.multisim.BlockParameter("vdp/Mu","Gain","0.1") specifies the Gain parameter value for the block named Mu in the model named vdp as 0.1.

Output Arguments

bp — Specified block parameters with values for simulation

simulink.multisim.BlockParameter object

Specified block parameters with values for simulation, returned as a simulink.multisim.BlockParameter object.

Properties

Name — Name of the block parameter to set

string | character vector

Name of block parameter to set, returned as a string or a character vector.

Values — Block parameter values

valid value for specified block parameter

Block parameter values, returned as a valid value for the specified block parameter.

BlockPath — Path to block for which the parameter value is specified

string | character vector

Path to block for which to specify parameter value, returned as a string or a character vector.

ProcessingFcn — Function handle

function handle | function name

Function handle to process the specified values that run on parallel workers, specified as a function handle or function name. The ProcessingFcn property allows you to perform additional processing on the variable values before the simulation. You can use the ProcessingFcn property to transform the values assigned to the simulink.multisim.BlockParameter object per your requirements. For example, you can use the function to transform a string values of a variable to a timeseries value.

Version History

Introduced in R2024a