sltest.testmanager.CoverageSettings class

Package: sltest.testmanager

Modify coverage settings

Description

Instances of sltest.testmanager.CoverageSettings let you set the values in the Coverage Settings section in a test file, test suite, or test case.

The sltest.testmanager.CoverageSettings class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

The getCoverageSettings methods for test file, test suite, and test case objects return an sltest.testmanager.CoverageSettings object, which lets you access the coverage collection and metric settings.

Properties

RecordCoverage — Enable coverage collection

false (default) | true

Specify if the coverage collection is on or off, false for off and true for on.

Coverage collection is enabled or disabled in the Test Manager Coverage Settings. The corresponding UI option is Record coverage for system under test.

Example: 'Decision',true

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

MdlRefCoverage — Collect coverage for referenced models

false (default) | true

Coverage collection for referenced models is enabled or disabled in the Test Manager Coverage Settings. The corresponding UI option is Record coverage for referenced models.

Example: 'Decision',true

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

MetricSettings — Coverage metric setting selection

string

Selection of coverage settings that are enabled or disabled, specified as a string. For the set of possible strings, see the parameter info for CovMetricSettings in Coverage metric settings (Simulink Coverage) and sltest.plugins.coverage.CoverageMetrics. Coverage metric settings can be modified only at the test file level.

Coverage metrics are enabled or disabled in the Test Manager by selecting the check boxes in the Coverage Settings section.

Example: "dw"

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

CoverageFilterFilename — Coverage filter to use for coverage analysis

string array

The file name of a coverage filter file or files on the MATLAB^® path, specified as a string array. The file names specify the coverage filters that override filter files specified in the model configuration settings. An empty value, "", attaches no coverage filter. For more information on coverage filters, see Coverage Filtering (Simulink Coverage). The coverage filter setting propagates down from test files to test suites and test cases, and its results are displayed at the Result Set level.

Specify the coverage filter file name in the Test Manager, in the Coverage filter filename table of the Coverage Settings section.

Example: "covfilter.cvf"

Example: ["covfilter.cvf1";"covfilter2.cvf"]

Example: ""

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

Examples

Enable MCDC and Signal Range Coverage Metrics and Specify a Coverage Filter

% Get coverage settings object from the test file
cov = getCoverageSettings(testfile);
cov.RecordCoverage = true;

% Enable MCDC and signal range coverage metrics
cov.MetricSettings = "mr";

% Specify a coverage filter
cov.CoverageFilterFilename = "covfilter.cvf";

Version History

Introduced in R2016a