getThresholdConfigurations

Class: slmetric.config.Configuration
Namespace: slmetric.config

(To be removed) Specify metric threshold configurations

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.

Syntax

TH = getThresholdConfigurations(CO)

Description

TH = getThresholdConfigurations(CO) returns the slmetric.config.ThresholdConfiguration object that an slmetric.config.Configuration object owns. Use this object to hold specific metric threshold configurations. Metric threshold configurations are compliant, warning, and noncompliant ranges for a specific metric.

Input Arguments

CO — Configuration object

slmetric.config.Configuration object

slmetric.config.Configuration object for which you create a metric threshold configuration. By default, an slmetric.config.Configuration object holds an empty slmetric.config.ThresholdConfiguration object.

Output Arguments

TH — Metric threshold configuration object

slmetric.config.ThresholdConfiguration object

slmetric.config.ThresholdConfiguration object for which you add thresholds corresponding to compliant, noncompliant, and warning ranges for a specific metric.

Examples

Add Thresholds to a Threshold Configuration Object

By default, an slmetric.config.Configuration object holds one slmetric.config.ThresholdConfiguration object. Use the getThresholdConfigurations method to add this object to the base workspace. You can then use the slmetric.config.addThreshold method to add slmetric.config.Threshold objects to this slmetric.config.ThresholdConfiguration object.

Create an slmetric.config.Configuration object.

CONF = slmetric.config.Configuration.new('name', 'Config');

Get the default slmetric.config.ThresholdConfiguration object in CONF.

TC = getThresholdConfigurations(CONF);

Add an slmetric.config.Threshold object to the slmetric.config.ThresholdConfiguration object TC. This threshold is for the mathworks.metrics.SubSystemCount metric and the Value property of the slmetric.metric.Results object.

E = addThreshold(TC,'mathworks.metrics.SubSystemCount','Value');

Use the slmetric.config.Classification and slmetric.config.MetricRange class properties to specify threshold values corresponding to the mathworks.metrics.SubsystemCount metric.

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.