deselectComponents

R2026b

Class: Advisor.Application
Namespace: Advisor

Clear model components from Model Advisor analysis

expand all in page

Advisor.Application and its methods will be removed in a future release. Use ModelAdvisor.run instead.

Syntax

deselectComponents(app)
deselectComponents(app,Name,Value)

Description

Clear model components from Model Advisor analysis. A model component is any subsystem or model reference that you can use to run Model Advisor. Models that the root model references and that setAnalysisRoot specifies are model components.

deselectComponents(app) clears all components from Model Advisor analysis.

example

deselectComponents(app,Name,Value) clears model components specified by Name,Value pair arguments from Model Advisor analysis.

example

Input Arguments

expand all

Model Advisor application object, specified as an Advisor.Application object. You can use an Advisor.Application object to run Model Advisor checks on a model reference hierarchy. Create an Advisor.Application object by using the method Advisor.Manager.createApplication.

Name-Value Arguments

expand all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Component IDs to clear from Model Advisor analysis, specified as a character vector or a cell array of character vectors.

Example: 'Controller'

Example: {'MyReferencedModelA','MyReferencedModelB'}

Data Types: cell | char

Clear components specified by IDs and component children from Model Advisor analysis.

Data Types: logical

Examples

expand all

This example shows how to set the root model, create an Advisor.Application object, set root analysis, and clear all components from Model Advisor analysis.

% Open the model
openExample('sldemo_mdlref_basic');

% Set root model to  sldemo_mdlref_basic model
RootModel='sldemo_mdlref_basic';

% Create an Application object
app = Advisor.Manager.createApplication();

% Set the Application object root analysis
setAnalysisRoot(app,'Root',RootModel);

% Deselect all components
deselectComponents(app);

This example shows how to set the root model, create an Advisor.Application object, set root analysis, and clear model components using IDs.

% Open the model
openExample('sldemo_mdlref_basic');

% Set root model to  sldemo_mdlref_basic model
RootModel='sldemo_mdlref_basic';

% Create an Application object
app = Advisor.Manager.createApplication();

% Set the Application object root analysis
setAnalysisRoot(app,'Root',RootModel);

% Deselect component using IDs
deselectComponents(app,'IDs',RootModel);

Version History

Introduced in R2015b

See Also

| | |