getThresholds

R2026b

Class: slmetric.config.ThresholdConfiguration
Namespace: slmetric.config

(To be removed) Obtain properties of threshold objects

expand all in page

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

T = getThresholds(TH,metricid)

Description

Determine the properties of the threshold objects that a threshold configuration object holds. You can also use this method with the slmetric.config.ThresholdConfiguration.removeThresholds method to identify and remove a threshold object from a slmetric.config.ThresholdConfiguration object.

T = getThresholds(TH,metricid) creates a threshold object or an array of threshold objects.

example

Input Arguments

expand all

slmetric.config.ThresholdConfiguration object for which you want information on the threshold objects it holds.

Metric identifier for model metric or custom model metric that you create. This argument is optional. If you do not specify a metricID, you get information on all thresholds that the Threshold configuration object holds.

Example: 'mathworks.metrics.SimulinkBlockCount'

Data Types: char

Output Arguments

expand all

slmetric.config.Threshold object or array of slmetric.config.Threshold objects corresponding to the slmetric.config.ThresholdConfiguration object that you specify as an input.

Examples

expand all

Use the getThresholds method to identify the slmetric.config.Threshold objects that belong to an slmetric.config.ThresholdConfiguration object.

For the slmetric.config.ThresholdConfiguration object TC, use the getThresholds method.

getThresholds(TC)
1×2 Threshold array with properties:

    MetricID
    AppliesTo

The slmetric.config.ThresholdConfiguration object TC contains two slmetric.config.Threshold objects.

Version History

Introduced in R2018b

collapse all

See Also

| |

Topics