Metric ID

slcomp.SimulinkHalsteadDifficulty

Description

The Halstead complexity metrics measure the size and complexity of code, which can help you monitor code quality, identify complex areas in the design, and address software maintainability concerns. One of the Halstead complexity metrics is Halstead difficulty. Halstead difficulty is an estimate of how difficult the code is to read and write, calculated based on the number of total and unique operators and operands in the design.

Use this metric to calculate the Halstead difficulty of the Simulink^® models in your units and components.

Supported Artifacts

You can collect this metric for:

To control what the dashboard classifies as a unit or component, see Categorize Models in Hierarchy as Components or Units.

Computation Details

For information on how the metric calculates the metric results, see Simulink Halstead Complexity.

Collection

To collect data for this metric, execute the metric engine and use getMetrics with the metric ID slcomp.SimulinkHalsteadDifficulty.

metric_engine = metric.Engine;
execute(metric_engine,"slcomp.SimulinkHalsteadDifficulty");
results = getMetrics(metric_engine,"slcomp.SimulinkHalsteadDifficulty")

Results

The metric returns results for each unit and component in the project.

For each unit and component, the metric returns a metric.Result object with properties including:

To get the distribution of Simulink Halstead difficulty, see Simulink Halstead Difficulty Distribution.

For detailed metric results, including the number of total and unique operators and operands, see Simulink Halstead Complexity.