Overall Design Summary

Metric ID

modeldesign.OverallMaintainability[slcomp.OverallDesignSummary]

Description

This metric returns the overall cyclomatic complexity and Halstead difficulty for each unit in your project. These values represent the combined maintainability measurements across all design layers in the unit. Use this metric to compare the overall maintainability of units in your project.

Supported Artifacts

This metric collects metric results for Units in the project. To control what the dashboard classifies as a unit, see Categorize Models in Hierarchy as Components or Units.

Collection

To collect data for this metric, execute the metric engine with the metric ID.

metric_engine = metric.Engine;
results = execute(metric_engine,"modeldesign.OverallMaintainability[slcomp.OverallDesignSummary]")

View the metric result values for a specific unit.

results(1).Value
results(1).ScopeAlias

You can also collect all overall maintainability metrics at once by using the group ID.

results = execute(metric_engine,"modeldesign.OverallMaintainability[]")

Results

The metric returns an array of metric.Result objects, one for each unit in the project. Use the Value property of the metric result object to view the metric result values. Use the ScopeId and ScopeAlias properties to identify which unit the result belongs to.

The ScopeAlias property returns the name of the unit.

The Value property returns a structure with these fields: