metric.Result

R2026b

Metric data for specified metric algorithm

Since R2022a

Description

A metric.Result object contains the metric data for a specified metric algorithm that traces to the specified unit.

Creation

Syntax

metric_result = metric.Result

Description

metric_result = metric.Result creates a handle to a metric result object.

Alternatively, if you collect results by executing a metric.Engine object, using the getMetrics function on the engine object returns the collected metric.Result objects in an array.

Properties

UserData — User data

string

User data provided by the metric algorithm, returned as a string.

Value — Result value

integer | string | double vector | structure

Result value of the metric for specified algorithm and artifacts, returned as an integer, string, double vector, or structure. For a list of metrics and their result values, see Design Cost Model Metrics and Model Testing Metrics (Simulink Check).

MetricID — Metric identifier

string

Metric identifier for metric algorithm that calculates results, returned as a string.

Example: "DataSegmentEstimate"

Artifacts — Testing artifacts

structure | array of structures

Testing artifacts for which metric is calculated, returned as a structure or an array of structures. For each artifact that the metric analyzes, the returned structure contains these fields:

• UUID — Unique identifier of artifact

• Name — Name of artifact

• ParentUUID — Unique identifier of file that contains artifact

• ParentName — Name of the file that contains artifact

ScopeId — Digital thread URI of the scope

string

Since R2026b

Digital thread URI of the unit or component for which the metric collected results, returned as a string. The ScopeId property identifies the scope using a digital thread URI instead of a structure of UUIDs.

Example: "mwdigitalthread://DO_Project/DO_03_Design/Flight_Control/specification/Flight_Control.slx#addr=Flight_Control"

Data Types: string

ScopeAlias — Display name of the scope

string

Since R2026b

Display name of the unit or component for which the metric collected results, returned as a string.

Example: "Flight_Control"

Data Types: string

Diagnostics — Errors and warnings from metric collection

structure | array of structures

Since R2025a

Errors and warnings from metric collection, returned as a structure or an array of structures. Each structure contains these fields:

• Severity — Severity of the diagnostic message, returned as either "ERROR" or "WARNING".

• Identifier — Identifier for the diagnostic message.

• Message — Diagnostic message.

Data Types: struct

Examples

Collect Metric Data for Each Design Unit in Project

Use a metric.Engine object to collect design cost metric data on a model reference hierarchy in a project.

To open the project, enter this command.

openExample('simulink/VisualizeModelReferenceHierarchiesExample')

The project contains sldemo_mdlref_depgraph, which is the top-level model in a model reference hierarchy. This model reference hierarchy represents one design unit.

Create a metric.Engine object.

metric_engine = metric.Engine();

Update the trace information for metric_engine to reflect any pending artifact changes.

updateArtifacts(metric_engine)

Create an array of metric identifiers for the metrics you want to collect. For this example, create a list of all available design cost estimation metrics.

metric_Ids = getAvailableMetricIds(metric_engine,...
    App="DesignCostEstimation")

metric_Ids =

  1×2 string array

    "DataSegmentEstimate"    "OperatorCount"

To collect results, execute the metric engine.

execute(metric_engine,metric_Ids);

Because you executed the engine without specifying a ScopeId, the engine collects metrics for the entire sldemo_mdlref_depgraph model reference hierarchy.

Use the getMetrics function to access the high-level design cost metric results.

results_OperatorCount = getMetrics(metric_engine,"OperatorCount");
results_DataSegmentEstimate = getMetrics(metric_engine,"DataSegmentEstimate");

disp(['Unit:  ', results_OperatorCount.Artifacts.Name])
disp(['Total Cost:  ', num2str(results_OperatorCount.Value)])

disp(['Unit:  ', results_DataSegmentEstimate.Artifacts.Name])
disp(['Data Segment Size (bytes):  ', num2str(results_DataSegmentEstimate.Value)])

Unit:  sldemo_mdlref_depgraph
Total Cost:  57

Unit:  sldemo_mdlref_depgraph
Data Segment Size (bytes):  228

The results show that for the sldemo_mdlref_depgraph model, the estimated total cost of the design is 57 and the estimated data segment size is 228 bytes.

Use the generateReport function to access detailed metric results in a PDF report. Name the report "MetricResultsReport.pdf".

reportLocation = fullfile(pwd,"MetricResultsReport.pdf");
generateReport(metric_engine,...
    App="DesignCostEstimation",...
    Type="pdf",...
    Location=reportLocation);

The report contains a detailed breakdown of the operator count and data segment estimate metric results.

Version History

Introduced in R2022a

R2026b: ScopeId and ScopeAlias properties replace Scope

The Scope property has been removed. Use the new ScopeId and ScopeAlias properties instead. ScopeId returns the digital thread URI of the unit or component for which the metric collected results. ScopeAlias returns the display name of the unit or component.

R2025a: Stores diagnostic errors and warnings from metric collection

metric.Result objects return diagnostic errors and warnings that occurred during metric collection by using the Diagnostics property.

R2023a: Does not return fields Type and ParentType

metric.Result objects do not return the fields Type and ParentType for the properties Artifacts and Scope.