generateReport

Class: Advisor.Application
Namespace: Advisor

Generate report for Model Advisor analysis

expand all in page

Syntax

generateReport(app)
generateReport(___,Name,Value)

Description

Generate a Model Advisor report for an Application object analysis.

generateReport(app) generates a Model Advisor report for each component specified by the Application object. By default, Model Advisor generates a summary report report.html and a report for each model component in a folder in the current working directory. The folder name is the name of the analysis root.

example

generateReport(___,Name,Value) specifies where the report generates using one or more Name,Value pair arguments. For example, you can specify the name and location of the folder that contains the generated Model Advisor reports.

example

Input Arguments

expand all

Model Advisor application object, specified as an Advisor.Application object. 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.

Path to folder for generated report, specified as a character vector or string array.

By default, Model Advisor reports generate in a folder in the current working directory.

Example: report = generateReport(app,'Location','my_work')

Name of folder for generated reports, specified as a character vector or string array.

By default, the folder name is the name of the analysis root.

Example: report = generateReport(app,'Name','my_reports')

Examples

expand all

This example shows how to generate a report with the analysis root name in the current folder.

Open a model. For this example, open the model sldemo_mdlref_basic.

openExample('sldemo_mdlref_basic');

Create an Advisor.Application object.

app = Advisor.Manager.createApplication();

Specify the model sldemo_mdlref_basic as the root of the Model Advisor analysis.

RootModel='sldemo_mdlref_basic';
setAnalysisRoot(app,'Root',RootModel);

Run Model Advisor analysis.

run(app);

This code runs each of the selected checks. For information on how to run only specific checks, see Advisor.Application.

Generate Model Advisor reports.

report = generateReport(app);

Model Advisor generates a summary report report.html and a report for each model component. The reports generate inside a folder sldemo_mdlref_basic in the current working directory.

Open the summary report in a web browser.

web(report);

This example shows how to generate reports in a folder with a specific name and location.

Open a model. For this example, open the model sldemo_mdlref_basic.

openExample('sldemo_mdlref_basic');

Create an Advisor.Application object.

app = Advisor.Manager.createApplication();

Specify the model sldemo_mdlref_basic as the root of the Model Advisor analysis.

RootModel='sldemo_mdlref_basic';
setAnalysisRoot(app,'Root',RootModel);

Run Model Advisor analysis.

run(app);

Create a new folder named my_work in the current working directory.

mkdir my_work

Generate Model Advisor reports in a folder named my_reports in the folder my_work.

report = generateReport(app,...
'Location','my_work',...
'Name','my_reports');

Model Advisor generates a summary report report.html and a report for each model component.

Current Folder with "my_work" folder, "my_reports" subfolder, and the generated reports

Open the summary report in a web browser.

web(report);

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.

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 and inactive variant blocks in models with variant configurations created by using Variant Manager. For more information, see Variant Manager for Simulink and Variant Configurations.

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

See Also

| | |