selectCheckInstances

R2026b

Class: Advisor.Application
Namespace: Advisor

Select check instances to use in Model Advisor analysis

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

Syntax

selectCheckInstances(app)

selectCheckInstances(app,'IDs',checkInstanceIDs)

Description

You can select check instances to use in a Model Advisor analysis. A check instance is an instantiation of a ModelAdvisor.Check object in the Model Advisor configuration. When you change the Model Advisor configuration, the check instance ID can change. To obtain the check instance ID, use the getCheckInstanceIDs method.

selectCheckInstances(app) selects all check instances to use for Model Advisor analysis.

selectCheckInstances(app,'IDs',checkInstanceIDs) selects check instances specified by checkInstanceIDs for Model Advisor analysis. You can find check instance IDs by using the getCheckInstanceIDs method.

Note

If a check appears in multiple folders in the Model Advisor tree, the getCheckInstanceIDs method returns multiple check instance IDs. To avoid running multiple instances of the same check, make sure to select a single check instance ID for the check that you want to run from the array of check instance IDs that the getCheckInstanceIDs method returns.

Input Arguments

app — Model Advisor application object

Advisor.Application object

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.

checkInstanceIDs — Check instance IDs

cell array

Check instance IDs to use in Model Advisor analysis, as specified as a cell array of IDs.

You can find check instance IDs by using the getCheckInstanceIDs method. If a check appears in multiple folders in the Model Advisor tree, the getCheckInstanceIDs method returns multiple check instance IDs. To avoid running multiple instances of the same check, make sure to select a single check instance ID for the check that you want to run from the array of check instance IDs that the getCheckInstanceIDs method returns.

Data Types: cell

Examples

Select All Check Instances to Use in Model Advisor Analysis

This example shows how to set the root model, create an Application object, set root analysis, and select all check instances for 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);

% Select all checks
selectCheckInstances(app);

Select Check Instance for Model Advisor Analysis Using Check Instance ID

This example shows how to set the root model, create an Application object, set root analysis, and select a check using a check instance ID.

% 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);

% Select "Identify unconnected lines, input ports, and output 
% ports" check using check instance ID
instanceID = getCheckInstanceIDs(app,'mathworks.design.UnconnectedLinesPorts');
% The check has multiple check instance IDs because it appears in
% multiple folders in the Model Advisor tree.
% Select a single instance of the check to avoid re-running instances of the same check
checkinstanceID = instanceID(1);
selectCheckInstances(app,'IDs',checkinstanceID);

Run Model Advisor Checks Across Model Reference Hierarchy

This example shows how to run the check Check root model Inport block specifications on the model sldemo_mdlref_basic and its referenced model sldemo_mdlref_counter.

Open the example model sldemo_mdlref_basic. In the MATLAB^® Command Window, enter:

openExample("sldemo_mdlref_basic")

The model sldemo_mdlref_basic is a parent model that contains three Model blocks: CounterA, CounterB, and CounterC. These blocks reference the same model, sldemo_mdlref_counter, which is a separate model and not a subsystem of sldemo_mdlref_basic.

Create an Advisor.Application object that you can use to run Model Advisor checks across the model reference hierarchy in sldemo_mdlref_basic.

app = Advisor.Manager.createApplication();

Specify which model or subsystem to analyze. For this example, specify the model sldemo_mdlref_basic as the root of the Model Advisor analysis.

setAnalysisRoot(app,Root = "sldemo_mdlref_basic");

When you specify a model as the analysis root for an Advisor.Application object, Model Advisor analyzes that model and any referenced models. For more information, see setAnalysisRoot.

Suppose that you only want to run the check Check root model Inport block specifications.

By default, the Advisor.Application object is set up to run each check instance in the current Model Advisor configuration and has all check instances selected. Clear the check instances to remove all check instances from the Model Advisor analysis.

deselectCheckInstances(app);

Specify that you want Model Advisor to run only the check Check root model Inport block specifications by finding and using the check instance ID.

checkID = "mathworks.design.RootInportSpec";
instanceIDs = getCheckInstanceIDs(app,checkID);
instanceID = instanceIDs(1);
selectCheckInstances(app,ID = instanceID);

Now the check Check root model Inport block specifications is selected for Model Advisor analysis.

The method getCheckInstanceIDs returns multiple check instance IDs because the check Check root model Inport block specifications appears in multiple folders in the Model Advisor tree. For this example, the instanceID is specified as the first check instance ID returned by getCheckInstanceIDs, but you can select any of the check instance IDs returned by getCheckInstanceIDs.

Note

Alternatively, if you want to load a Model Advisor configuration file instead of selecting individual checks, use the method loadConfiguration.

Run the Model Advisor analysis.

run(app);

Model Advisor runs the check Check root model Inport block specifications on both sldemo_mdlref_basic and sldemo_mdlref_counter.

Get the results from the Model Advisor analysis.

res = getResults(app);

Generate and view a Model Advisor report.

report = generateReport(app);
web(report);

The Model Advisor report provides a summary of the results for sldemo_mdlref_basic and sldemo_mdlref_counter and hyperlinks to individual reports for each model.

Run Model Advisor Checks Across Variants

This example shows how to run the check Identify unconnected lines, input ports, and output ports on the different variant choices in the model slexVariantManagement.

Open the example model slexVariantManagement. In the MATLAB Command Window, enter:

openExample("slexVariantManagement")

The model slexVariantManagement contains several variant subsystem blocks including Controller and Plant. Inside the variant subsystem blocks are different implementations of those components.

slexVariantManagement has multiple variant configurations stored in the variant configuration data object vcd associated with the model. Advisor.Application objects can only run Model Advisor analysis on active variant blocks in models with variant configurations created by using Simulink^® Variant Manager™. For more information, see Manage Variants with Simulink Variant Manager.

Create an Advisor.Application object that you can use to run Model Advisor checks.

app = Advisor.Manager.createApplication();

Specify AnalyzeVariants as true so that Advisor.Application object can run Model Advisor for each of the variant choices in slexVariantManagement.

app.AnalyzeVariants = true;

Specify which model to analyze. For this example, specify the model slexVariantManagement as the root of the Model Advisor analysis.

setAnalysisRoot(app,Root = "slexVariantManagement");

Suppose that you want to run only the check Identify unconnected lines, input ports, and output ports.

By default, the Advisor.Application object is set up to run each check instance in the current Model Advisor configuration and has all check instances selected. Clear the check instances to remove all check instances from the Model Advisor analysis.

deselectCheckInstances(app);

Specify that you want Model Advisor to run the check Identify unconnected lines, input ports, and output ports by finding and using the check instance ID.

checkID = "mathworks.design.UnconnectedLinesPorts";
instanceIDs = getCheckInstanceIDs(app,checkID);
instanceID = instanceIDs(1);
selectCheckInstances(app,ID = instanceID);

Now the check Identify unconnected lines, input ports, and output ports is selected for Model Advisor analysis.

The method getCheckInstanceIDs returns multiple check instance IDs because the check Identify unconnected lines, input ports, and output ports appears in multiple folders in the Model Advisor tree. For this example, the instanceID is specified as the first check instance ID returned by getCheckInstanceIDs, but you can select any of the check instance IDs returned by getCheckInstanceIDs.

Note

Alternatively, if you want to load a Model Advisor configuration file instead of selecting individual checks, use the method loadConfiguration.

Run the Model Advisor analysis.

run(app);

Model Advisor runs the check on both active variants in the model and referenced models.

Get the results from the Model Advisor analysis.

res = getResults(app);

Generate and view a Model Advisor report.

report = generateReport(app);
web(report);

The Model Advisor report provides a summary of the results for slexVariantManagement and hyperlinks to individual reports for each variant.

Version History

Introduced in R2015b