mcdcinfo

Retrieve modified condition/decision coverage information from cvdata object

Syntax

covInfo = mcdcinfo(cvdo,modelObject)

covInfo = mcdcinfo(cvdo, modelObject, simMode)

covInfo = mcdcinfo(cvdo,modelObject,ignoreDescendants)

[covInfo, description] = mcdcinfo(cvdo,modelObject)

Description

covInfo = mcdcinfo(cvdo,modelObject) returns modified condition decision coverage (MCDC) results from the cvdata object cvdo for the model component specified by modelObject.

covInfo = mcdcinfo(cvdo, modelObject, simMode) returns MCDC results from the cvdata object cvdo for the model component specified by modelObject for the simulation mode simMode.

covInfo = mcdcinfo(cvdo,modelObject,ignoreDescendants) returns MCDC results for modelObject, depending on the value of ignoreDescendants.

[covInfo, description] = mcdcinfo(cvdo,modelObject) returns MCDC results and text descriptions of each condition/decision in modelObject.

Examples

Retrieve MCDC Coverage Information

Collect MCDC coverage for the slvnvdemo_cv_small_controller model and determine the percentage of MCDC coverage collected for the Logic block in the Gain subsystem:

mdl = 'slvnvdemo_cv_small_controller';
openExample(mdl);
open_system(mdl);
%Create test specification object
testObj = cvtest(mdl)
%Enable MCDC coverage
testObj.settings.mcdc = 1;
%Simulate model
data = cvsim(testObj)
%Retrieve MCDC results for Logic block
blk_handle = get_param([mdl, '/Gain/Logic'], 'Handle');
cov = mcdcinfo(data, blk_handle)
%Percentage of MCDC outcomes covered
percent_cov = 100 * cov(1) / cov(2)

Extract MCDC Results from a Model in Software-in-the-Loop Mode

1. Open the example and load the model.

   openExample("slcoverage/RetrieveCodeCoverageResultsExample");

2. Use the setupSILCoverage function to configure the model for code coverage analysis. The output is a Simulink.SimulationInput object.

   simIn = setupSILCoverage("slvnvdemo_counter_harness");

3. Simulate the model.

   simOut = sim(simIn);

4. To retrieve coverage results for the generated code that represents a specific block, use the block path. For example, retrieve the MCDC results for the Logic block named And by passing the block path relative to the top model.

   covDataSIL = simOut.covdata;
   mcdcBlockSIL = mcdcinfo(covDataSIL,...
                           "slvnvdemo_counter/And")

       
       mcdcBlockSIL =
       
            2     2
   

5. To retrieve coverage results for a function in the generated code, use a cell array that contains the generated source file name and function name. For example, retrieve the MCDC coverage results for the function slvnvdemo_counter located in the source file slvnvdemo_counter.c.

   mcdcSILFunction = mcdcinfo(covDataSIL,{"slvnvdemo_counter.c",...
                                          "slvnvdemo_counter"})

       mcdcSILFunction =
       
            2     2

Extract MCDC Code Coverage Results from an S-Function Block

1. Open the example and load data into the workspace.

   openExample("slcoverage/RetrieveSFunCoverageResultsExample");
   load slcoverage_lct_data.mat

2. Use the setupSFcnCoverage function to configure the model for coverage analysis. The output is a Simulink.SimulationInput object.

   simIn = setupSFcnCoverage("slcoverage_lct_bus");

3. Simulate the model.

   simOut = sim(simIn);

4. To retrieve coverage results for an S-function, use the mcdcinfo function and specify a cell array that contains the handle or full path of the block, followed by the file name of the S-function source file. Optionally, you can also specify a specific function inside that source file. For this example, retrieve the MCDC results for the function named counterbusFcn in the S-function file counterbus.c, which the S-Function block slcoverage_sfun_counterbus calls. The S-Function block is inside the TestCounter subsystem in the model slcoverage_lct_bus.

   covDataSFcn = simOut.covdata;
   mcdcSFun = mcdcinfo(covDataSFcn,...
       {"slcoverage_lct_bus/TestCounter/slcoverage_sfun_counterbus",...
       "counterbus.c","counterbusFcn"})

       
       mcdcSFun =
       
            1     2
   

Input Arguments

cvdo — Coverage data

cvdata object

Coverage data, specified as a cvdata object.

Data Types: cvdata

modelObject — Model object

character array | string array | Simulink® handle | Stateflow® ID | cell array

Model object, specified as a character array, string array, Simulink handle, Stateflow ID, or cell array.

To specify a model object, such as a block or a Stateflow chart, use one of these formats:

Object Specification	Description
BlockPath	Full path to a model or block
BlockHandle	Handle to a model or block
slObj	Handle to a Simulink API object
sfID	Stateflow ID
sfObj	Handle to a Stateflow API object from a singly instantiated Stateflow chart
{BlockPath,sfID}	Cell array with the path to a Stateflow chart or atomic subchart and the ID of an object contained in that chart or subchart
{BlockPath,sfObj}	Cell array with the path to a Stateflow chart or subchart and a Stateflow object API handle contained in that chart or subchart
{BlockHandle,sfID}	Cell array with a handle to a Stateflow chart or atomic subchart and the ID of an object contained in that chart or subchart

To specify an S-Function block or its contents, use one of these formats:

Object Specification	Description
{BlockPath,fileName}	Cell array with the path to an S-Function block and the name of a source file
{BlockHandle,fileName}	Cell array with an S-Function block handle and the name of a source file
{BlockPath,fileName,functionName}	Cell array with the path to an S-Function block, the name of a source file, and a function name
{BlockHandle,fileName,functionName}	Cell array with an S-Function block handle, the name of a source file, and a function name

To specify a code coverage result, such as coverage data collected during software-in-the-loop (SIL) or processor-in-the-loop (PIL) analysis, use one of these formats:

Object Specification	Description
{fileName,functionName}	Cell array with the name of a source file and a function name
{Model,fileName}	Cell array with a model name or model handle and the name of a source file
{Model,fileName,functionName}	Cell array with a model name or model handle, the name of a source file, and a function name

Data Types: char | string | cell | Stateflow.State | Stateflow.Transition

simMode — Simulation mode

character array | string array

Simulation mode during coverage analysis, specified as one of these options:

Object Specification	Description
"Normal"	Model in normal simulation mode.
"SIL" or "PIL"	Model in software-in-the-loop (SIL) or processor-in-the-loop (PIL) simulation mode.
"ModelRefSIL" or "ModelRefPIL"	Model reference in SIL or PIL simulation mode.
"ModelRefTopSIL" or "ModelRefTopPIL"	Model reference in SIL or PIL simulation mode with the code interface set to top model.

Data Types: char | string

ignoreDescendants — Whether to ignore descendants in coverage results

false or 0 (default) | true or 1

Whether to ignore descendants in coverage results, specified as a numeric or logical 1 (true) or 0 (false), where:

• 0 (false) includes coverage results of descendant objects.

• 1 (true) ignores coverage results of descendant objects.

Data Types: single | double | logical

Output Arguments

covInfo — Coverage information

scalar

Coverage information, returned as a two-element array of the form [covered_outcomes,total_outcomes] if cvdo contains MCDC data, or an empty array if it does not.

covered_outcomes	Number of MCDC outcomes satisfied for modelObject
total_outcomes	Total number of MCDC outcomes for modelObject

Data Types: double

description — MCDC coverage description

structure

MCDC coverage description, returned as a structure array with the following fields:

isFiltered — Block exclusion flag

0 | 1

Block exclusion flag, returned as 1 if the block is excluded and 0 if it is not.

Data Types: double

filterRationale — Block coverage filter rationale

character array

Block coverage filter rationale, returned as a character array.

Data Types: char

justifiedCoverage — Number of justified coverage objective outcomes

scalar

Number of justified coverage objective outcomes, returned as a scalar double.

Data Types: double

text — Description of the measured objective

character array

Description of the measured objective, returned as a character array.

Data Types: char

condition — Information for individual MCDC outcomes

structure

Information for individual MCDC outcomes, returned as a structure with the following fields:

isFiltered — MCDC outcome exclusion flag

0 | 1

MCDC outcome exclusion flag, returned as 1 if the MCDC outcome is excluded or 0 if it is not.

Data Types: double

isJustified — MCDC outcome justification flag

0 | 1

MCDC outcome justification flag, returned as 1 if the MCDC outcome is justified or 0 if it is not.

Data Types: double

filterRationale — Coverage filter rationale

character array

Coverage filter rationale, returned as a character array. If a filter is not applied, or the applied filter does not contain filter rules, filterRationale is returned as an empty array.

Data Types: char

text — Description of MCDC outcome

character array

Description of the MCDC outcome, returned as a character array.

Data Types: char

achieved — MCDC outcome flag

0 | 1

MCDC outcome flag, returned as 1 if the MCDC outcome is fully satisfied, and 0 if it is not. The MCDC outcome is fully satisfied if each condition independently affects the decision outcome.

Data Types: double

trueResult — Condition values that achieve the true MCDC result

scalar

Condition values that achieve the true MCDC result, returned as a

Data Types: double

falseResult — Number of time steps condition is false

scalar

Number of time steps the condition is false, returned as a scalar.

Data Types: double

trueExecutedIn — Aggregated coverage test case traceability information

structure array | []

Aggregated coverage test case traceability information, returned as a structure array. If your coverage data does not contain aggregated results from multiple simulations, trueExecutedIn is an empty array. If your coverage data contains aggregated results, trueExecutedIn indicates which test runs executed the true condition outcome and has the following fields:

uniqueId	Unique identifier for the cvdata object created by the test case that executed this condition outcome, returned as a character array.
analyzedModel	The name of the model analyzed, returned as a character array.
description	The test case description, returned as a character array.
date	The date and time of the simulation that created the cvdata object, returned as a character array.
traceLabel	The short name of the test case, returned as a character array.
testRunInfo	Test details, returned as a structure array.
testRunInfo.runid	The identifier of the run that generated the coverage result, returned as a scalar double.
testRunInfo.runName	The name of the test case that generated the coverage result, returned as a character array.
testRunInfo.testId	Identifying data for the test case that generated the coverage result, returned as a structure array.
testRunInfo.testId.uuid	The unique identifier for the test case that generated the coverage result, returned as a character array.
testRunInfo.testId.contextType	The test context in which the coverage result was obtained, returned as one of these values: 'RE' for the Coverage Results Explorer 'ST' for the Test Manager in Simulink Test™

Data Types: struct

falseExecutedIn — Aggregated coverage test case traceability information

structure array | []

Aggregated coverage test case traceability information, returned as a structure array. If your coverage data does not contain aggregated results from multiple simulations, falseExecutedIn is an empty array. If your coverage data contains aggregated results, falseExecutedIn indicates which test runs executed the false condition outcome and has the following fields:

uniqueId	Unique identifier for the cvdata object created by the test case that executed this condition outcome, returned as a character array.
analyzedModel	The name of the model analyzed, returned as a character array.
description	The test case description, returned as a character array.
date	The date and time of the simulation that created the cvdata object, returned as a character array.
traceLabel	The short name of the test case, returned as a character array.
testRunInfo	Test details, returned as a structure array.
testRunInfo.runid	The identifier of the run that generated the coverage result, returned as a scalar double.
testRunInfo.runName	The name of the test case that generated the coverage result, returned as a character array.
testRunInfo.testId	Identifying data for the test case that generated the coverage result, returned as a structure array.
testRunInfo.testId.uuid	The unique identifier for the test case that generated the coverage result, returned as a character array.
testRunInfo.testId.contextType	The test context in which the coverage result was obtained, returned as one of these values: 'RE' for the Coverage Results Explorer 'ST' for the Test Manager in Simulink Test

Data Types: struct

Data Types: double

Data Types: struct

Alternatives

Use the coverage settings to collect MCDC coverage for a model:

1. Open the model.

2. In the Model Editor, select Model Settings on the Modeling tab.

3. On the Coverage pane of the Configuration Parameters dialog box, select Enable coverage analysis.

4. Under Coverage metrics, select MCDC as the structural coverage level.

5. Click OK to close the Configuration Parameters dialog box and save your changes.

6. Simulate the model by clicking the Run button and review the results.

Version History

Introduced in R2006b