complexityinfo - Retrieve cyclomatic complexity coverage information from cvdata

  object - MATLAB ([original](https://in.mathworks.com/help/slcoverage/ref/complexityinfo.html)) ([raw](?raw))

Retrieve cyclomatic complexity coverage information from cvdata object

Syntax

Description

[complexity](#bswieqq-1-complexity) = complexityinfo([cvdo](#bswieqq-1%5Fsep%5Fbrxo2jj-1-cvdo),[modelObject](#bswieqq-1%5Fsep%5Fbswieqq-1-object)) returns complexity coverage results from the cvdata objectcvdo for the model component modelObject.

[complexity](#bswieqq-1-complexity) = complexityinfo([cvdo](#bswieqq-1%5Fsep%5Fbrxo2jj-1-cvdo),[modelObject](#bswieqq-1%5Fsep%5Fbswieqq-1-object),[simMode](#bswieqq-1%5Fsep%5Fbswieqq-1-mode)) returns complexity coverage results from the cvdata objectcvdo for the model component modelObject for the simulation mode simMode.

Examples

collapse all

This example shows how to retrieve cyclomatic complexity information for the Gain subsystem of the slvnvdemo_cv_small_controller model.

Load the slvnvdemo_cv_small_controller model.

modelName = 'slvnvdemo_cv_small_controller'; load_system(modelName);

Create a test specification object and enable decision, condition, and MCDC coverage. Then, simulate the model using cvsim.

testObj = cvtest(modelName); testObj.settings.decision = 1; testObj.settings.condition = 1; testObj.settings.mcdc = 1; covData = cvsim(testObj);

Retrieve cyclomatic complexity information for the Gain subsystem.

gainPath = [modelName,'/Gain']; gainComplexity = complexityinfo(covData,gainPath)

The Gain subsystem itself does not record cyclomatic complexity, but the contents of the subsystem do. This can be seen in the results because the total complexity is 1, which includes the subsystem and all of its descendants. In contrast, the local complexity is 0, indicating that the one point of complexity comes from one of the descendants, in this case a Switch block.

switchPath = [modelName,'/Gain/Switch']; switchComplexity = complexityinfo(covData,switchPath)

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.

4. To retrieve cyclomatic complexity 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 cyclomatic complexity for the function slvnvdemo_counter located in the source file slvnvdemo_counter.c.
   complexitySILFunction = complexityinfo(covDataSIL,...
   {"slvnvdemo_counter.c","slvnvdemo_counter"})
   complexitySILFunction =

     3     3

The function slvnvdemo_counter has a cyclomatic complexity of 3. 5. Similarly, retrieve the cyclomatic complexity for the entire system by using only the main generated file, slvnvdemo_counter.c. In this case, you do not need to use a cell array.
complexitySILSystem = complexityinfo(covDataSIL,...
"slvnvdemo_counter.c")
complexitySILSystem =

     4     0  

The first number represents the cyclomatic complexity of the object and its descendants, so the system has a cyclomatic complexity of 4. The second number represents cyclomatic complexity of only the object or file given as the input argument, so the file slvnvdemo_counter.c does not contribute complexity to the system. This makes sense, because the source file is constructed of functions, and the functions report their own cyclomatic complexity.

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.
4. To retrieve cyclomatic complexity for an S-function, use thecomplexityinfo 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 cyclomatic complexity for the function namedcounterbusFcn in the S-function filecounterbus.c, which the S-Function blockslcoverage_sfun_counterbus calls. The S-Function block is inside the TestCounter subsystem in the modelslcoverage_lct_bus.
   covDataSFcn = simOut.covdata;
   complexitySFun = complexityinfo(covDataSFcn,...
   {"slcoverage_lct_bus/TestCounter/slcoverage_sfun_counterbus",...
   "counterbus.c","counterbusFcn"})

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, such as a block or a Stateflow chart, use one of these formats:

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

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:

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

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

Data Types: char | string

Output Arguments

collapse all

Cyclomatic complexity, returned as a two-element array of the form[total_complexity,local_complexity] if cvdo contains cyclomatic complexity coverage results, or an empty array if it does not.

If modelObject has variable-size signals,complexity also contains the variable complexity.

Data Types: double

Alternatives

Use the coverage settings to collect and display cyclomatic complexity coverage results in the coverage report:

1. Open the model.
2. In the Simulink Editor, select Model Settings on theModeling 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.
7. In the docked Coverage Details pane, the coverage report shows the cyclomatic complexity for the model as well as each model object.

Version History

Introduced in R2011a