Documentation

Contents

Simulink.ModelAdvisor

Run Model Advisor from MATLAB file

Description

Use instances of this class in MATLAB® programs to run the Model Advisor, for example, to perform a standard set of checks. MATLAB software creates an instance of this object for each model that you open in the current MATLAB session. To get a handle to a model's Model Advisor object, execute the following command

ma = Simulink.ModelAdvisor.getModelAdvisor(model);

where model is the name of the model or subsystem that you want to check. Your program can then use the Model Advisor object's methods to initialize and run the Model Advisor's checks.

About IDs

Many Simulink.ModelAdvisor object methods require or return IDs. An ID is a string that identifies a Model Advisor check, task, or group. ID must remain constant. A Simulink.ModelAdvisor object includes methods that enable you to retrieve the ID or IDs for all checks, tasks, and groups, checks belonging to groups and tasks, the active check, and selected checks, tasks and groups. See the Simulink.ModelAdvisor Method Summary for more information.

You can also determine check IDs as follows:

  1. In the Model Advisor, select View > Source Tab.

  2. Navigate to the folder that contains the check.

  3. In the right pane, click Source. The Model Advisor displays the Title, TitleID, and Source information for each check in the folder.

Syntax

ma = Simulink.ModelAdvisor

Arguments

ma

A variable representing the Simulink.ModelAdvisor object you create.

Properties

EmitInputParametersToReport

The EmitInputParametersToReport property specifies the display of check input parameters in the Model Advisor report.

ValueDescription

'true' (default)

Display check input parameters in the Model Advisor report.

'false'

Do not display check input parameters in the Model Advisor report.

Method Summary

Name

Description

closeReport

Close Model Advisor report.

deselectCheck

Clear checks.

deselectCheckAll

Clear all checks.

deselectCheckForGroup

Clear a group of checks.

deselectCheckForTask

Clear checks that belong to a specified task or set of tasks.

deselectTask

Clear tasks.

deselectTaskAll

Clear all tasks.

displayReport

Display Model Advisor report.

exportReport

Copy report to a specified location.

filterResultWithExclusion

Filter objects that have been excluded by user-defined exclusions.

getBaselineMode

Get baseline mode setting for the Model Advisor.

getCheckAll

Get the IDs of the checks performed by the Model Advisor.

getCheckForGroup

Get checks belonging to a check group.

getCheckForTask

Get checks belonging to a task.

getCheckResult

Get check results.

getCheckResultData

Get check result data.

getCheckResultStatus

Get pass/fail status of a check or set of checks.

getGroupAll

Get the IDs of the groups of tasks performed by the Model Advisor.

getInputParameters

Get input parameters of a check.

getListViewParameters

Get list view parameters of a check.

getModelAdvisor

Get the Model Advisor for a model or subsystem.

getSelectedCheck

Get selected checks.

getSelectedSystem

Get path of system currently targeted by the Model Advisor.

getSelectedTask

Get selected tasks.

getTaskAll

Get the IDs of the tasks performed by the Model Advisor.

Simulink.ModelAdvisor.openConfigUI

Start the Model Advisor Configuration editor.

Simulink.ModelAdvisor.reportexists

Determine whether a report exists for a system or subsystem.

runCheck

Run selected checks.

runTask

Run checks for selected tasks.

selectCheck

Select checks.

selectCheckAll

Select all checks.

selectCheckForGroup

Select a group of checks.

selectCheckForTask

Select checks that belong to a specified task.

selectTask

Select tasks.

selectTaskAll

Select all tasks.

setActionEnable

Set enable/disable status for a check action.

setBaselineMode

Set baseline mode for the Model Advisor.

setCheckErrorSeverity

Set severity of a check failure.

setCheckResult

Set result for the currently running check.

setCheckResultData

Set result data for the currently running check.

setCheckResultStatus

Set pass/fail status for the currently running check.

setListViewParameters

Set list view parameters for a check.

verifyCheckRan

Verify that checks have run.

verifyCheckResult

Generate a baseline set of check results or compare the current set of results to the baseline results.

verifyCheckResultStatus

Verify that a model has passed or failed a set of checks.

verifyHTML

Generate a baseline report or compare the current report to a baseline report.

Methods

closeReport

Purpose

Close Model Advisor report

Syntax

closeReport

Description

Closes the report associated with this Model Advisor object, which closes the Model Advisor window.

See Also

displayReport

deselectCheck

Purpose

Clear check

Syntax

success = deselectCheck(ID)

Arguments

ID

String or cell array that specifies the IDs of the checks to be cleared.

success

True (1) if the check is cleared.

Description

This method clears the checks specified by ID.

    Note:   This method cannot clear disabled checks.

See Also

getCheckAll, deselectCheckForGroup, selectCheck

deselectCheckAll

Purpose

Clear all checks

Syntax

success = deselectCheckAll

Arguments

success

True (1) if all checks are cleared.

Description

Clears all checks that are not disabled.

See Also

selectCheckAll

deselectCheckForGroup

Purpose

Clear group of checks

Syntax

success = deselectCheckForGroup(groupName)

Arguments

groupName

String or cell array that specifies the names of the groups to be cleared.

success

True (1) if the method succeeds in clearing the specified group.

Description

Clears a specified group of checks.

See Also

selectCheckForGroup

deselectCheckForTask

Purpose

Clear checks that belong to specified task or set of tasks

Syntax

success = deselectCheckForTask(ID)

Arguments

ID

String or cell array of strings that specify the IDs of tasks whose checks are to be cleared.

success

True (1) if the specified tasks are cleared.

Description

Clears checks belonging to the tasks specified by the ID argument.

See Also

getTaskAll, selectCheckForTask

deselectTask

Purpose

Clear task

Syntax

success = deselectTask(ID)

Arguments

ID

String or cell array that specifies the ID of tasks to be cleared

success

True (1) if the method succeeded in clearing the specified tasks.

Description

Clears the tasks specified by ID.

See Also

selectTask, getTaskAll

deselectTaskAll

Purpose

Clears all tasks

Syntax

success = deselectTaskAll

Arguments

success

True (1) if this method succeeds in clearing all tasks.

Description

Clears all tasks.

See Also

selectTaskAll

displayReport

Purpose

Display report in Model Advisor window

Syntax

displayReport

Description

Displays the report associated with this Model Advisor object in the Model Advisor window. The report includes the most recent results of running checks on the system associated with this Model Advisor object and the current selection status of checks, groups, and tasks for the system.

See Also

Simulink.ModelAdvisor.reportexists

exportReport

Purpose

Create copy of report generated by Model Advisor

Syntax

[success message] = exportReport(destination)

Arguments

destination

Path name of copy to be made of the report file.

success

True (1) if this method succeeded in creating a copy of the report at the specified location.

message

Empty if the copy was successful; otherwise, the reason the copy did not succeed.

Description

This method creates a copy of the last report generated by the Model Advisor and stores the copy at the specified location.

See Also

Simulink.ModelAdvisor.reportexists

filterResultWithExclusion

Purpose

Filter objects that have been excluded by user-defined exclusions.

Syntax

filteredResultHandles = obj.filterResultWithExclusion(ResultHandles)

Arguments

filteredResultHandles

An array of objects causing exclusion enabled checks to warn or fail.

obj

A variable representing the Simulink.ModelAdvisor.getModelAdvisor object.

ResultHandles

An array of objects causing a check warning or failure.

Description

This method filters objects that cause a check warning or failure with checks that have exclusions enabled.

    Note:   This method is intended for excluding objects from custom checks created with the Model Advisor's customization API, a feature available with Simulink® Verification and Validation™ .

See Also

getModelAdvisor

getBaselineMode

Purpose

Determine whether Model Advisor is in baseline data generation mode

Syntax

mode = getBaselineMode

Arguments

mode

Boolean value indicating baseline mode.

Description

The mode output variable returns true if the Model Advisor is in baseline data mode. Baseline data mode causes the verification methods of the Model Advisor, for example, verifyHTML, to generate baseline data.

See Also

setBaselineMode, verifyHTML, verifyCheckResult, verifyCheckResultStatus

getCheckAll

Purpose

Get IDs of all checks

Syntax

IDs = getCheckAll

Arguments

IDs

Cell array of strings specifying the IDs of all checks performed by the Model Advisor.

Description

Returns a cell array of strings specifying the IDs of all checks performed by the Model Advisor.

See Also

getTaskAll, getGroupAll

getCheckForGroup

Purpose

Get checks that belong to check group

Syntax

IDs = getCheckForGroup(groupName)

Arguments

groupName

String specifying the name of a group.

IDs

Cell array of IDs.

Description

Returns a cell array of IDs of the tasks and checks belonging to the group specified by groupName.

See Also

getCheckForTask

getCheckForTask

Purpose

Get checks that belong to task

Syntax

checkIDs = getCheckForTask(taskID)

Arguments

taskID

ID of a task.

checkIDs

Cell array of IDs of checks belonging to the specified task.

Description

Returns a cell array of IDs of the checks belonging to the task specified by taskID.

See Also

getCheckForGroup

getCheckResult

Purpose

Get results of running check or set of checks

Syntax

result = getCheckResult(ID)

Arguments

ID

ID of a check or cell array of check IDs.

result

A check result or cell array of check results.

Description

Gets results for the specified checks. The format of the results depends on the checks that generated the data.

    Note:   This method is intended for accessing results generated by custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

getCheckResultData, getCheckResultStatus

getCheckResultData

Purpose

Get data resulting from running check or set of checks

Syntax

result = getCheckResultData(ID)

Arguments

ID

Check ID or cell array of check IDs.

result

Data from a check result or cell array of data from check results.

Description

Gets the check result data for the specified checks. The format of the data depends on the checks that generated the data.

    Note:   This method is intended for accessing check result data generated by custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

getCheckResult, getCheckResultStatus

getCheckResultStatus

Purpose

Get status of check or set of checks

Syntax

result = getCheckResultStatus(ID)

Arguments

ID

Check ID or cell array of check IDs.

result

Boolean or a cell array of Boolean values indication the pass or fail status of a check or set of checks.

Description

Invoke this method after running a set of checks to determine whether the checks passed or failed.

See Also

getCheckResult, getCheckResultData

getGroupAll

Purpose

Get all groups of checks run by Model Advisor

Syntax

IDs = getGroupAll

Arguments

IDs

Cell array of IDs of all groups of checks run by the Model Advisor.

Description

Returns a cell array of IDs of all groups of checks run by the Model Advisor.

See Also

getCheckAll, getTaskAll

getInputParameters

Purpose

Get input parameters of check

Syntax

params = obj.getInputParameters(check_ID)

Arguments

params

A cell array of ModelAdvisor.InputParameter objects.

obj

A variable representing the Simulink.ModelAdvisor object.

check_ID

A string that uniquely identifies the check.

You can omit the check_ID if you use the method inside a check callback function.

Description

Returns the input parameters associated with a check.

    Note:   This method is intended for accessing custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

ModelAdvisor.InputParameter

getListViewParameters

Purpose

Get list view parameters of check

Syntax

params = obj.getListViewParameters(check_ID)

Arguments

params

A cell array of ModelAdvisor.ListViewParameter objects.

obj

A variable representing the Simulink.ModelAdvisor object.

check_ID

A string that uniquely identifies the check.

You can omit the check_ID if you use the method inside a check callback function.

Description

Returns the list view parameters associated with a check.

    Note:   This method is intended for accessing custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

setListViewParameters, ModelAdvisor.ListViewParameter

getModelAdvisor

Purpose

Get Model Advisor object for system or subsystem

Syntax

obj = Simulink.ModelAdvisor.getModelAdvisor(system)
obj = Simulink.ModelAdvisor.getModelAdvisor(system, 'new')

Arguments

system

Name of model or subsystem.

'new'

Required when changing Model Advisor working scope from one system to another without closing the previous session. Alternatively, you can close the previous session before invoking getModelAdvisor, in which case 'new' can be omitted.

obj

Model Advisor object.

Description

This static method (see Static Methods) creates and returns an instance of Simulink.ModelAdvisor class for the model or subsystem specified by system.

getSelectedCheck

Purpose

Get currently selected checks

Syntax

IDs = getSelectedCheck

Arguments

IDs

Cell array of IDs of currently selected checks.

Description

Returns the IDs of the currently selected checks in the Model Advisor.

See Also

getSelectedTask

getSelectedSystem

Purpose

Get system currently targeted by Model Advisor

Syntax

path = getSelectedSystem

Arguments

path

Path of the selected system.

Description

Gets the path of the system currently targeted by the Model Advisor. That is, the system or subsystem most recently selected for checking either interactively by the user or programmatically via Simulink.ModelAdisor.getModelAdvisor.

See Also

getModelAdvisor

getSelectedTask

Purpose

Get selected tasks

Syntax

IDs = getSelectedTask

Arguments

IDs

Cell array of IDs of currently selected tasks.

Description

Returns the IDs of the currently selected tasks in the Model Advisor.

See Also

getSelectedCheck

getTaskAll

Purpose

Get tasks run by Model Advisor

Syntax

IDs = getTaskAll

Arguments

IDs

Cell array of IDs of tasks run by the Model Advisor.

Description

Returns a cell array of IDs of tasks run by the Model Advisor.

See Also

getCheckAll, getGroupAll

Simulink.ModelAdvisor.openConfigUI

Purpose

Starts Model Advisor Configuration editor

Syntax

Simulink.ModelAdvisor.openConfigUI

Description

This static method starts the Model Advisor Configuration editor. Use the Model Advisor Configuration editor to create customized configurations for the Model Advisor.

    Note:   The Model Advisor Configuration editor is an optional feature available with Simulink Verification and Validation software (see Organize Checks and Folders Using the Model Advisor Configuration Editor for more information).

    • Before starting the Model Advisor Configuration editor, ensure that the current folder is writable. If the folder is not writable, you see an error message when you start the Model Advisor Configuration editor.

    • The Model Advisor Configuration editor uses the Simulink project (slprj) folder (for more information, see Model Reference Simulation Targets) in the current folder to store reports and other information. If this folder does not exist in the current folder, the Model Advisor Configuration editor creates it.

Simulink.ModelAdvisor.reportexists

Purpose

Determine whether report exists for model or subsystem

Syntax

exists = reportexists('system')

Arguments

system

String specifying path of a system or subsystem.

exists

True (1) if a report exists for system.

Description

This method returns true (1) if a report file exists for the model (system) or subsystem specified by system in the slprj/modeladvisor subfolder of the MATLAB working folder.

See Also

exportReport

runCheck

Purpose

Run currently selected checks

Syntax

success = runCheck(ID)

Arguments

ID

ID or cell array of IDs of checks to run.

success

True (1) if the checks were run.

Description

Runs the checks currently selected in the Model Advisor. Invoking this method is equivalent to selecting the Run Selected Checks button on the Model Advisor window.

See Also

selectCheck

runTask

Purpose

Run currently selected tasks

Syntax

success = runTask

Arguments

success

True (1) if the tasks were run.

Description

Runs the tasks currently selected in the Model Advisor. Invoking this method is equivalent to selecting the Run Selected Checks button on the Model Advisor window.

See Also

selectTask

selectCheck

Purpose

Select check

Syntax

success = selectCheck(ID)

Arguments

ID

ID or cell array of IDs of checks to be selected.

success

True (1) if this method succeeded in selecting the specified checks.

Description

Select the check specified by ID. This method cannot select a check that is disabled.

See Also

selectCheckAll, selectCheckForGroup, deselectCheck

selectCheckAll

Purpose

Select all checks

Syntax

success = selectCheckAll

Arguments

success

True (1) if this method succeeded in selecting all checks.

Description

Selects all checks that are not disabled.

See Also

selectCheck, selectCheckForGroup, deselectCheck

selectCheckForGroup

Purpose

Select group of checks

Syntax

success = selectCheckForGroup(ID)

Arguments

ID

ID or cell array of group IDs.

success

True (1) if this method succeeded in selecting the specified groups

Description

Selects the groups specified by ID.

See Also

deselectCheckForGroup

selectCheckForTask

Purpose

Select checks that belong to specified task or set of tasks

Syntax

success = selectCheckForTask(ID)

Arguments

ID

ID or cell array of IDs of tasks whose checks are to be selected.

success

True (1) if this method succeeded in selecting the checks for the specified tasks

Description

Selects checks belonging to the tasks specified by the ID argument.

See Also

deselectCheckForTask

selectTask

Purpose

Select task

Syntax

success = selectTask(ID)

Arguments

ID

ID or cell array of IDs of the task to be selected.

success

True (1) if this method succeeds in selecting the specified tasks.

Description

Selects a task.

See Also

deselectTask

selectTaskAll

Purpose

Select all tasks

Syntax

success = selectTaskAll

Arguments

success

True (1) if this method succeeds in selecting all tasks.

Description

Selects all tasks.

See Also

deselectTaskAll

setActionEnable

Purpose

Set status for check action

Syntax

obj.setActionEnable(value)

Arguments

obj

A variable representing the Simulink.ModelAdvisor object.

value

Boolean value indicating whether the Action box is enabled or disabled.

  • true — enable the Action box.

  • false — Disable the Action box.

Description

The setActionEnable method specifies the enables or disables the Action box. Only a check callback function can invoke this method.

    Note:   This method is intended for accessing custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

ModelAdvisor.Action

setBaselineMode

Purpose

Set baseline data generation mode for Model Advisor

Syntax

setBaselineMode(mode)

Arguments

mode

Boolean value indicating setting of Model Advisor's baseline mode, either on (true) or off (false).

Description

Sets the Model Advisor's baseline mode to mode. Baseline mode causes the Model Advisor's verify methods to generate baseline comparison data for verifying the results of a Model Advisor run.

See Also

getBaselineMode, verifyCheckResult, verifyHTML

setCheckErrorSeverity

Purpose

Set severity of check failure

Syntax

obj.setCheckErrorSeverity(value)

Arguments

obj

A variable representing the Simulink.ModelAdvisor object.

value

Integer indicating severity of failure.

  • 0 — Check Result = Warning

  • 1 — Check Result = Failed

Description

Sets result status for a currently running check that fails to value. Only a check callback function can invoke this method.

    Note:   This method is intended for accessing custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

setCheckResultStatus

setCheckResult

Purpose

Set result for currently running check

Syntax

success = setCheckResult(result)

Arguments

result

String or cell array that specifies the result of the currently running task.

success

True (1) if this method succeeds in setting the check result.

Description

Sets the check result for the currently running check. Only the callback function of a check can invoke this method.

    Note:   This method is intended for use with custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

getCheckResult, setCheckResultData, setCheckResultStatus

setCheckResultData

Purpose

Set result data for currently running check

Syntax

success = setCheckResultData(data)

Arguments

data

Result data to be set.

success

True (1) if this method succeeds in setting the result data for the current check

Description

Sets the check result data for the currently running check. Only the callback function of a check can invoke this method.

    Note:   This method is intended for use with custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

getCheckResultData, setCheckResult, setCheckResultStatus

setCheckResultStatus

Purpose

Set status for currently running check

Syntax

success = setCheckResultStatus(status)

Arguments

status

Boolean value that indicates the status of the check that just ran, either pass (true) or fail (false)

success

True (1) if the status was set.

Description

Sets the pass or fail status for the currently running check to status. Only the callback function of the check can invoke this method.

    Note:   This method is intended for use with custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

getCheckResultStatus, setCheckResult, setCheckResultData, setCheckErrorSeverity

setListViewParameters

Purpose

Specify list view parameters for check

Syntax

obj.setListViewParameters(check_ID, params)

Arguments

obj

A variable representing the Simulink.ModelAdvisor object.

check_ID

A string that uniquely identifies the check.

You can omit the check_ID if you use the method inside a check callback function.

params

A cell array of ModelAdvisor.ListViewParameter objects.

Description

Set the list view parameters for the check.

    Note:   This method is intended for accessing custom checks created with the Model Advisor's customization API, an optional feature available with Simulink Verification and Validation software. For more information, see Define Custom Checks in the Simulink Verification and Validation documentation.

See Also

getListViewParameters, ModelAdvisor.ListViewParameter

verifyCheckRan

Purpose

Verify that Model Advisor has run set of checks

Syntax

[success, missingChecks, additionalChecks] = verifyCheckRan(IDs)

Arguments

IDs

Cell array of IDs of checks to verify.

success

Boolean value specifying whether the checks ran.

missingChecks

Cell array of IDs for specified checks that ran.

additionalChecks

Cell array of IDs for unspecified checks that ran.

Description

The output variable success returns true if all the checks specified by IDs have run. If not, success returns false, missingChecks lists specified checks that did not run. The additionalChecks argument lists unspecified checks that ran.

See Also

verifyCheckResultStatus

verifyCheckResult

Purpose

Generate baseline Model Advisor check results file or compare current check results to baseline check results

Syntax

[success message] = verifyCheckResult(baseline, checkIDs)

Arguments

baseline

Path of the baseline check results MAT-file.

checkIDs

Cell array of check IDs.

success

Boolean value specifying whether the method succeeded.

message

String specifying an error message.

Description

If the Model Advisor is in baseline mode (see setBaselineMode), this method stores the most recent results of running the checks specified by checkIDs in a MAT-file at the location specified by baseline. If the method is unable to store the check results at the specified location, it returns false in the output variable success and the reason for the failure in the output variable message. If the Model Advisor is not in baseline mode, this method compares the most recent results of running the checks specified by checkIDs with the report specified by baseline. If the current results match the baseline results, this method returnstrue as the value of the success output variable.

    Note:   You must run the checks specified by checkIDs (see runCheck) before invoking verifyCheckResult.

This method enables you to compare the most recent check results generated by the Model Advisor with a baseline set of check results. You can use the method to generate the baseline report as well as perform current-to-baseline result comparisons. To generate a baseline report, put the Model Advisor in baseline mode, using setBaselineMode. Then invoke this method with the baseline argument set to the location where you want to store the baseline results. To perform a current-to-baseline report comparison, first ensure that the Model Advisor is not in baseline mode (see getBaselineMode). Then invoke this method with the path of the baseline report as the value of the baseline input argument.

See Also

setBaselineMode, getBaselineMode, runCheck, verifyCheckResultStatus

verifyCheckResultStatus

Purpose

Verify that model has passed or failed set of checks

Syntax

[success message] = verifyCheckResultStatus(baseline, checkIDs)

Arguments

baseline

Array of Boolean variables.

checkIDs

Cell array of check IDs.

success

Boolean value specifying whether the method succeeded.

message

String specifying an error message.

Description

This method compares the passor fail (true or false) statuses from the most recent running of the checks specified by checkIDs with the Boolean values specified by baseline. If the statuses match the baseline, this method returns true as the value of the success output variable.

    Note:   You must run the checks specified by checkIDs (see runCheck) before invoking verifyCheckResultStatus.

See Also

runCheck

verifyHTML

Purpose

Generate baseline Model Advisor report or compare current report to baseline report

Syntax

[success message] = verifyHTML(baseline)

Arguments

baseline

Path of a Model Advisor report.

success

Boolean value specifying whether the method succeeded.

message

String specifying an error message.

Description

If the Model Advisor is in baseline mode (see setBaselineMode), this method stores the report most recently generated by the Model Advisor at the location specified by baseline. If the method is unable to store a copy of the report at the specified location, it returns false in the output variable success and the reason for the failure in the output variable message. If the Model Advisor is not in baseline mode, this method compares the report most recently generated by the Model Advisor with the report specified by baseline. If the current report has exactly the same content as the baseline report, this method returns true as the value of the success output variable.

This method enables you to compare a report generated by the Model Advisor with a baseline report to determine if they differ. You can use the method to generate the baseline report as well as perform current-to-baseline report comparisons. To generate a baseline report, put the Model Advisor in baseline mode. Then invoke this method with the baseline argument set to the location where you want to store the baseline report. To perform a current-to-baseline report comparison, first ensure that the Model Advisor is not in baseline mode (see getBaselineMode). The invoke this method with the path of the baseline report as the value of the baseline input argument.

See Also

setBaselineMode, getBaselineMode, verifyCheckResult

Was this topic helpful?