Main Content

decisioninfo

Retrieve decision coverage information from cvdata object

Description

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

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

covInfo = decisioninfo(cvdo, modelObject, ignore_descendants) returns decision coverage results for modelObject, depending on the value of ignore_descendants.

[covInfo, description] = decisioninfo(cvdo, modelObject) returns decision coverage results and text descriptions of decision points associated with modelObject.

Examples

collapse all

This example shows how to view decision coverage data for a block in your model.

Load the model.

modelName = 'slvnvdemo_cv_small_controller';
load_system(modelName);

Configure the coverage settings for the model by using a Simulink.SimulationInput object.

simIn = Simulink.SimulationInput(modelName);
simIn = setModelParameter(simIn,'CovEnable','on');
simIn = setModelParameter(simIn,'CovMetricStructuralLevel','Decision');
simIn = setModelParameter(simIn,'CovSaveSingleToWorkspaceVar','on');
simIn = setModelParameter(simIn,'CovSaveName','covData');

Simulate the model by passing simIn as the input to sim.

simOut = sim(simIn);
covData = simOut.covData;

View the decision coverage results for the Saturation block by calling decisioninfo with the block path.

blockPath = [modelName,'/Saturation'];
decisionCov = decisioninfo(covData,blockPath)
decisionCov =

     3     4

decisioninfo returns an array with two scalars. The first value is the number of satisfied decision outcomes, and the second value is the number of total decision outcomes. Use these to determine the percentage of satisfied decision outcomes for the Saturation block.

percentDecisionCov = 100 * decisionCov(1) / decisionCov(2)
percentDecisionCov =

    75

Input Arguments

collapse all

Coverage data, specified as a cvdata object.

Data Types: cvdata

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

To specify a model object, for example a block or a Stateflow chart, use one of the following formats:

Object SpecificationDescription

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 the following formats:

Object SpecificationDescription

{BlockPath, fName}

Cell array with the path to an S-Function block and the name of a source file

{BlockHandle, fName}

Cell array with an S-Function block handle and the name of a source file

{BlockPath, fName, funName}

Cell array with the path to an S-Function block, the name of a source file, and a function name

{BlockHandle, fName, funName}

Cell array with an S-Function block handle, the name of a source file an a function name

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

Object SpecificationDescription

{fileName, funName}

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, funName}

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

Simulation mode during coverage analysis, specified as one of the following:

Object SpecificationDescription

'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 software-in-the-loop (SIL) or processor-in-the-loop (PIL) simulation mode.

'ModelRefTopSIL' (or 'ModelRefTopPIL')

Model reference in software-in-the-loop (SIL) or processor-in-the-loop (PIL) simulation mode with the code interface set to top model.

Data Types: char | string

Whether to ignore descendants in coverage results, specified as 0 or 1, where:

  • 0 includes coverage results of descendant objects.

  • 1 ignores coverage results of descendant objects.

Data Types: single | double

Output Arguments

collapse all

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

covered_outcomesNumber of decision outcomes satisfied for modelObject
total_outcomesTotal number of decision outcomes for modelObject

Data Types: double

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

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

Data Types:

Block coverage filter rationale, returned as a character array.

Data Types: char

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

Data Types: double

Block justification flag, returned as 1 if the block is justified or 0 if it is not.

Data Types: double

Information for individual decisions, returned as a structure array with the following fields:

Decision exclusion flag, returned as 1 if the decision is excluded or 0 if it is not.

Data Types: double

Decision justification flag, returned as 1 if the decision is justified or 0 if it is not.

Data Types: double

Coverage filter rationale, returned as a character array.

Data Types: char

Description of the decision, returned as a character array.

Data Types: char

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

textOutcome of the decision, returned as 'true' or 'false'.
executionCountThe number of time steps the decision had this outcome, returned as a scalar double.
isFilteredDecision outcome exclusion flag, returned as 1 if the outcome is excluded or 0 if it is not.
isJustifiedDecision outcome justification flag, returned as 1 if the outcome is justified or 0 if it is not.
filterRationaleCoverage filter rationale, returned as a character array.
executedInAggregated coverage test case traceability information, returned as a structure array. If your coverage data does not contain aggregated results from multiple simulations, executedIn is an empty array. If your coverage data contains aggregated results, executedIn indicates which test runs executed the decision outcome.
executedIn.uniqueIdUnique identifier for the cvdata object created by the test case that executed this condition outcome, returned as a character array.
executedIn.analyzedModelThe name of the model analyzed, returned as a character array.
executedIn.descriptionThe test case description, returned as a character array.
executedIn.dateThe date and time of the simulation that created the cvdata object, returned as a character array.
executedIn.traceLabelThe short name of the test case, returned as a character array.
executedIn.testRunInfoTest details, returned as a structure array.
executedIn.testRunInfo.runidThe identifier of the run that generated the coverage result, returned as a scalar double.
executedIn.testRunInfo.runNameThe name of the test case that generated the coverage result, returned as a character array.
executedIn.testRunInfo.testIdIdentifying data for the test case that generated the coverage result, returned as a structure array.
executedIn.testRunInfo.testId.uuidThe unique identifier for the test case that generated the coverage result, returned as a character array.
executedIn.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 Simulink Test™ Manager

Data Types: struct

Data Types: struct

Data Types: struct

Alternatives

Use the coverage settings to collect and display decision coverage results:

  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 Decision 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.

Introduced in R2006b