blocksAffectedByParameter

R2026b

Class: SLSlicerAPI.ParameterDependence
Namespace: SLSlicerAPI

Find Simulink blocks affected by parameter

Syntax

[affectedBlocks,slicerObj] = blocksAffectedByParameter(pd,varUsage)
[affectedBlocks,slicerObj] = blocksAffectedByParameter(pd,varusage,BlockType=blocktypename)


Description

[affectedBlocks,slicerObj] = blocksAffectedByParameter(pd,varUsage) returns a list of the blocks that are affected by the specified parameter varUsage, and the Model Slicer object used in the analysis.

[affectedBlocks,slicerObj] = blocksAffectedByParameter(pd,varusage,BlockType=blocktypename) returns affected blocks of the specified block type.

Input Arguments

pd — Parameter dependence object

SLSlicerAPI.ParameterDependence object

Parameter dependence object, specified as a SLSlicerAPI.ParameterDependence object. The parameter dependence object determines the dependency between parameters and the Simulink model.

varusage — Parameters to query

Simulink.VariableUsage object

Parameters to query that affect the Simulink blocks in the model, specified as a Simulink.VariableUsage object, which stores information about where a variable is used in a model.

blocktypename — Name of block type to search

string character vector

Name of block type to search, specified as a string or character vector. Only blocks of the specified type are searched for whether they use the specified parameter.

Example:

Output Arguments

affectedBlocks — Blocks affected by the parameter

array of block handles

Blocks affected by the parameter, returned as an array of block handles.

slicerObj — Model Slicer object

SLSlicerAPI.SLSlicer object

Model Slicer object used during the analysis, returned as an SLSlicerAPI.SLSlicer object.

Examples

Find All Blocks Affected by a Parameter

% Open example and model
openExample("simulinktest/TestHarnessCallbackExample")
model = "RollAutopilotMdlRef";
open_system(model)

% Create a ParameterDependence object 
pd = SLSlicerAPI.ParameterDependence(model);

% Specify the parameter to query
varusage = Simulink.VariableUsage("rateLim",...
   "AttitudeControllerAutopilotMdlRef");

% Get all blocks affected by the parameter
[affectedBlocks,slicerObj] = ...
   blocksAffectedByParameter(pd,varusage);
names = get_param(affectedBlocks,"Name")

Find Blocks of Specified Type Affected by a Parameter

% Open example and model
openExample("simulinktest/TestHarnessCallbackExample")
model = "RollAutopilotMdlRef"
open_system(model)

% Create a ParameterDependence object 
pd = SLSlicerAPI.ParameterDependence(model);

% Specify the parameter to query
varusage = Simulink.VariableUsage("rateLim","AttitudeControllerAutopilotMdlRef");

% Get only Outport blocks affected by the parameter
[affectedOutports,slicerObj] = blocksAffectedByParameter(pd,varusage,BlockType="Outport");
names = get_param(affectedOutports,"Name")

Version History

Introduced in R2021b