sigsizeinfo

Retrieve signal size coverage information from cvdata object

Syntax

[min,max,allocated] = sigsizeinfo(cvdo,modelObject)

[min,max,allocated] = sigsizeinfo(cvdo,modelObject,portID)

Description

[min,max,allocated] = sigsizeinfo(cvdo,modelObject) returns the minimum, maximum, and allocated signal sizes for the outputs of model component modelObject within the coverage data object cvdo, if modelObject supports variable size signals.

allocated is the upper boundary of the signal size that Simulink^® allocates memory for. The value of allocated is the maximum value specified in the parameters for the model object, such as the PortDimensions parameter of an Inport block. If the upper boundary for the signal size is inf, sigsizeinfo returns inf, and the coverage report does not display a value in the Allocated column for that model object.

[min,max,allocated] = sigsizeinfo(cvdo,modelObject,portID) returns the minimum, maximum, and allocated signal sizes associated with the output port portID of the model component modelObject.

Examples

Retrieve Signal Size Information

This example shows how to retrieve signal size coverage data from a simulation.

Load the model.

modelName = "slvnvdemo_varsize_basic";
load_system(modelName);

The model is already configured to collect coverage. Simulate the model using sim.

simOut = sim(modelName);
covData = simOut.covdata;

Extract the signal size information for the Switch block.

blockName = modelName + "/Switch";
[minVal, maxVal, allocatedVal] = sigsizeinfo(covdata,blockName)

minVal =

     1


maxVal =

     6


allocatedVal =

     6

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

portID — Output port of the block

character array | string array

Output port of the block, specified as a character array or a string array.

Data Types: char | string

Output Arguments

max — Maximum signal size that occurred during simulation

double

Maximum signal size that occurred during simulation for the model object, returned as a scalar double. If the modelObject output is a vector, max is a vector that contains the maximum signal size for each output.

Data Types: double

min — Minimum signal size that occurred during simulation

double

Minimum signal size that occurred during simulation for the model object, returned as a scalar double. If the modelObject output is a vector, min is a vector that contains the minimum signal size for each output.

Data Types: double

allocated — Allocated signal size

double | inf

Allocated signal size output for the model object, returned as a double. allocated is the upper limit set in the parameters of the model object. For example, if the value of the Inport block parameter PortDimensions is 20, allocated returns 20.

If the modelObject output is a vector, allocated is a vector that contains the allocated signal size for each output. If modelObject uses unbounded variable-size arrays, allocated returns inf. For more information about unbounded variable-size arrays, see Customize Variable Sizes.

Data Types: double

Alternatives

Use the coverage settings to collect signal size coverage for a model:

1. Open the model for which you want to collect signal size coverage.

2. In the Simulink 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 Signal Size.

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 R2010b

R2023b: Collect signal size coverage for unbounded variable-size arrays

When a variable-size array is unbounded, allocated returns inf. A signal size is unbounded when you set the maximum signal size of one or more dimension to inf.