slmetric.metric.MetaInformation Class

Namespace: slmetric.metric

(To be removed) Access meta-information for metrics

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.

Description

You can use the properties of an slmetric.metric.MetaInformation object to access meta-information for a shipped metric or custom metric. The meta-information includes the metric name, description, and information about the type of data that the metric collects.

The property values in an slmetric.metric.MetaInformation object correspond to the property values defined in the metric class definition. For information on how to specify the properties of a custom metric, see Create a Custom Model Metric for Nonvirtual Block Count.

Construction

Use the method getMetricMetaInformation to return an slmetric.metric.MetaInformation object for a metric.

Properties

Name — Metric name

character vector

Metric name, returned as a character vector.

Example: 'Model Advisor standards check compliance for High Integrity'

Data Types: char | string

Description — Metric description

character vector

Metric description, returned as a character vector.

Example: 'Metric that counts the percentage of checks that passed for the High Integrity Model Advisor standards check grouping.'

Data Types: char | string

MeasuresNames — Names of measurements

cell array of character vectors

Names of measurements that the metric collects, returned as a cell array of character vectors. The measurements provide detailed information about the metric values.

For example, the shipped metric mathworks.metrics.ModelAdvisorCheckCompliance.hisl_do178 measures the number of high-integrity Model Advisor checks that passed and the total number of Model Advisor checks. For the metric mathworks.metrics.ModelAdvisorCheckCompliance.hisl_do178, the property MeasuresNames returns {'Passed Checks';'Total Checks'}.

Example: {'Passed Checks';'Total Checks'}

AggregatedMeasuresNames — Names of aggregated measurements

cell array of character vectors

Names of aggregated measurements that the metric collects, returned as a cell array of character vectors.

For example, the shipped metrics aggregate measurements across the model component hierarchy. For more information, see Model Metric Data Aggregation.

Example: {'Passed Checks (incl. Descendants)';'Total Checks (incl. Descendants)'}

ValueName — Name of value that metric collects

character vector

Name of value that the metric collects, returned as a character vector.

For example, the shipped metric mathworks.metrics.ModelAdvisorCheckCompliance.hisl_do178 returns the fraction of high-integrity Model Advisor checks that passed. For the metric mathworks.metrics.ModelAdvisorCheckCompliance.hisl_do178, the property ValueName returns 'Checks Passed'.

Example: 'Checks Passed'

Data Types: char

AggregatedValueName — Name of aggregated value that metric collects

cell array of character vectors

Name of aggregated value that the metric collects, returned as a cell array of character vectors.

For example, the shipped metrics aggregate values across the model component hierarchy. For more information, see Model Metric Data Aggregation.

Example: {'Passed Checks (incl. Descendants)','Total Checks (incl. Descendants)'}

Version History

Introduced in R2018b

R2022a: Metrics Dashboard will be removed

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.