exportMetrics

R2026b

Class: slmetric.Engine
Namespace: slmetric

(To be removed) Export model metrics

The Metrics Dashboard app, model metrics, slmetric API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Design Dashboards.

Syntax

exportMetrics(metric_engine,filename)

exportMetrics(metric_engine,filename,filelocation)

Description

Export model metric data to an XML file.

exportMetrics(metric_engine,filename) exports an XML filename containing metric data to your current folder.

exportMetrics(metric_engine,filename,filelocation) exports an XML filename containing metric data to filelocation.

Input Arguments

metric_engine — Collects and accesses metric data

slmetric.Engine object

When you call execute, metric_engine collects metric data for available metrics or for the specified MetricIDs. Calling getMetrics accesses the collected metric data in metric_engine.

filename — XML file name

character vector

Name of XML file.

Example: 'MyMetrics.xml'

filelocation — File path

character vector

Path to XML file

Example: 'C:/mywork'

Examples

Export Metrics to Current Folder

This example shows how to export metrics for model vdp to XML file MyMetrics.xml in your current folder.

Open the model vdp by entering:

openExample('simulink_general/VanDerPolOscillatorExample')

Create an slmetric.Engine object.

metric_engine = slmetric.Engine();

Specify model for metric analysis.

setAnalysisRoot(metric_engine, 'Root', 'vdp', 'RootType', 'Model');

Collect the model metrics.

execute(metric_engine);

Get the model metric results.

rc = getMetrics(metric_engine);

Export the metric data to an XML file named myMetrics.xml.

exportMetrics(metric_engine, 'MyMetrics.xml');

Export Metrics to Specified Location

This example shows how to export metrics for model vdp to XML file MyMetrics.xml in a specified folder, C:/work.

Open the model vdp by entering:

openExample('simulink_general/VanDerPolOscillatorExample')

Create an slmetric.Engine object.

metric_engine = slmetric.Engine();

Specify model for metric analysis.

setAnalysisRoot(metric_engine, 'Root', 'vdp', 'RootType', 'Model');

Collect the model metrics.

execute(metric_engine);

Get the model metric results.

rc = getMetrics(metric_engine);

Export the metric data to an XML file named myMetrics.xml in C:/work.

exportMetrics(metric_engine, 'MyMetrics.xml', 'C:/work');

Version History

Introduced in R2016a

R2022a: Metrics Dashboard will be removed

The Metrics Dashboard app, model metrics, slmetric API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Design Dashboards.