Simulink.ModelAdvisor

R2026b

Run Model Advisor from MATLAB file

Description

To run the Model Advisor, use instances of this object in MATLAB^® programs. For example, you can perform a standard set of checks.

Many Simulink.ModelAdvisor object functions require or return IDs. An ID is a unique identifier for a Model Advisor check, task, or group. IDs must remain constant. A Simulink.ModelAdvisor object includes functions that enable you to retrieve the ID or IDs for:

• All checks, tasks, and groups

• Checks belonging to groups and tasks

• The active check

• Selected checks, tasks, and groups

To find check IDs in the Model Advisor, use the check context menu.

Find	Action
Check ID	In the left pane of the Model Advisor, select the check. Right-click the check name and select Send Check ID to Workspace. The ID is displayed in the Command Window and sent to the base workspace.
Check IDs for selected checks in a folder	In the left pane of the Model Advisor, select the checks for which you want IDs. Clear the other checks in the folder. Right-click the folder and select Send Check ID to Workspace. An array of the selected check IDs is sent to the base workspace.

If you have a Simulink^® Check™ license, consider using the ModelAdvisor.run (Simulink Check) function instead of the Simulink.ModelAdvisor runCheck or runTask functions.

Creation

Syntax

ma = Simulink.ModelAdvisor.getModelAdvisor(system)

Description

ma = Simulink.ModelAdvisor.getModelAdvisor(system) creates an instance of the Simulink.ModelAdvisor object for the specified model or subsystem. MATLAB creates an instance of this object for each model that you open in the current MATLAB session. Your program can then use the Model Advisor object functions to initialize and run the Model Advisor checks.

Input Arguments

system — Model or subsystem name

model name | subsystem path

Name of the model or subsystem that you want to check.

Data Types: char

Properties

EmitInputParametersToReport — Display check input parameters in Model Advisor report

true (default) | false

A value of true displays input parameters in the Model Advisor report. A value of false does not display input parameters in the Model Advisor report.

Data Types: char

Object Functions

Model Advisor Baseline

getBaselineMode	Determine whether Model Advisor is in baseline data generation mode
setBaselineMode	Set Model Advisor baseline mode
verifyCheckResult	Generate baseline Model Advisor check results file or compare current check results to baseline check results
verifyCheckResultStatus	Verify that a model passed or failed a set of checks
verifyHTML	Generate baseline Model Advisor report or compare current report to baseline report

Model Advisor Checks, Tasks, Groups, and Results

deselectCheck	Clear Model Advisor check
deselectCheckAll	Clear Model Advisor checks
deselectCheckForGroup	Clear Model Advisor checks for groups
deselectCheckForTask	Clear Model Advisor checks that belong to a specified task or set of tasks
deselectTask	Clear Model Advisor checks that belong to a specified task or set of tasks
deselectTaskAll	Clear all Model Advisor tasks
getCheckAll	Get check IDs of all Model Advisor checks
getCheckForGroup	Get checks belonging to Model Advisor check group
getCheckForTask	Get checks belonging to a task
getCheckResultStatus	Obtain Model Advisor check result status
getGroupAll	Get all groups of checks that Model Advisor runs
getSelectedCheck	Get currently selected Model Advisor checks
getSelectedSystem	Get system that Model Advisor targets
getSelectedTask	Get selected Model Advisor tasks
getTaskAll	Get tasks run by Model Advisor
runCheck	Run currently selected checks
runTask	Run currently selected tasks
selectCheck	Select checks
selectCheckAll	Select all checks
selectCheckForGroup	Select check group
selectCheckForTask	Select checks for a specific task or tasks
selectTask	Select Model Advisor task
selectTaskAll	Select all Model Advisor tasks
verifyCheckRan	Verify that Model Advisor ran a set of checks

Model Advisor Reports

closeReport	Close Model Advisor report
displayReport	Display report in Model Advisor window
exportReport	Create copy of Model Advisor report

Customize Model Advisor with Simulink Check

filterResultWithExclusion	Filter excluded objects
getCheckResult	Get Model Advisor check results
getCheckResultData	Obtain Model Advisor check result data
getInputParameters	Get Model Advisor check input parameters
setActionEnable	Set status for check action
setCheckErrorSeverity	Set severity of check failure
setCheckResult	Set result for currently running check
setCheckResultData	Set result data for currently running check
setCheckResultStatus	Set status for currently running check
setInputParameters	Specify input parameters

Version History

Introduced in R2006a

R2026b: Model Advisor task and check selection functions will be removed in a future release

The following functions will be removed in a future release:

• deselectCheck

• deselectCheckForGroup

• deselectCheckForTask

• deselectTask

• deselectTaskAll

• getSelectedTask

• selectCheckAll

• selectCheckForGroup

• selectCheckForTask

• selectTask

• selectTaskAll