本页采用了机器翻译。点击此处可查看英文原文。

slmetric.config.Threshold

（待移除）用于保存度量结果阈值的对象

全页展开

以后的版本中将会删除度量仪表板用户界面、metricdashboard 函数、slmetric 包 API 以及相应的自定义项。有关详细信息，请参阅从度量盘迁移到模型可维护性仪表盘。

说明

为模型度量结果指定阈值

创建对象

使用 addThreshold 创建一个 slmetric.config.Threshold 对象。

属性

全部展开

此 属性 为只读。

模型度量或自定义模型度量的度量标识符，以字符向量的形式返回。

示例: 'mathworks.metrics.SimulinkBlockCount'

数据类型: char

此 属性 为只读。

slmetric.metric.Result 属性，用于应用阈值，以字符向量的形式返回。您可以对 Value 和 AggregatedValue 属性应用阈值。

数据类型: char

对象函数

addClassification（待移除）向 slmetric.config.Threshold 对象添加度量数据分类
getClassifications（待删除）获取度量数据分类
removeClassification（待移除）移除度量阈值分类
validate（待删除）验证度量范围阈值

示例

全部折叠

使用 slmetric.config.Threshold 和 slmetric.config.Configuration 对象向度量仪表板添加阈值信息。您可以添加阈值来定义以下三个类别的度量数据范围：

  • 合规 - 在可接受范围内的度量数据。

  • 警告 - 需要查看的度量数据。

  • Noncompliant - 需要您修改模型的度量数据。

创建一个 slmetric.config.Configuration 对象。

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

获取 slmetric.config.ThresholdConfiguration 中的默认 CONF 对象。

TC = getThresholdConfigurations(CONF);

创建 slmetric.config.Threshold 对象并将其添加到 slmetric.config.ThresholdConfiguration 对象中。此阈值用于 slmetric.metric.Results 对象的 mathworks.metrics.SimulinkBlockCount 度量和 Value 属性。

T = addThreshold(TC, 'mathworks.metrics.SimulinkBlockCount', 'Value');

默认情况下，slmetric.config.Threshold 对象包含一个 slmetric.config.Classification 对象，该对象定义了符合规范类别的度量范围。使用函数 getClassifications 对阈值对象 T 获取分类对象。

C = getClassifications(T);

分类对象的 Range 属性是一个 slmetric.metric.MetricRange 对象。使用分类对象范围内的 slmetric.metric.MetricRange 函数指定符合类别的度量值。

C.Range.Start = 5;
C.Range.IncludeStart = 0;
C.Range.End = 100;
C.Range.IncludeEnd = 0;

这些值指定合规范围是从 5 到 100 的模块计数。此范围不包括值 5 和 100。

指定警告度量范围的值。

C = addClassification(T,'Warning');
C.Range.Start = -inf;
C.Range.IncludeStart = 0;
C.Range.End = 5;
C.Range.IncludeEnd = 1;

这些值指定警告是介于 -inf 和 5 之间的模块计数。此范围不包括 -inf。但它确实包括 5。

请指定不符合规范的度量范围的值。

C = addClassification(T,'NonCompliant');
C.Range.Start = 100;
C.Range.IncludeStart = 1;
C.Range.End = inf;
C.Range.IncludeEnd = 0;

这些值指定大于 100 的模块计数不符合要求。此范围包括 100。但它不包括 inf。

使用 validate 方法验证与 slmetric.config.ThresholdConfiguration 对象中的阈值对应的度量范围。

validate(T)

如果范围无效，您会收到一条错误消息。在这个示例中，范围是有效的，所以该函数不返回任何值。

保存对配置文件的更改。使用 slmetric.config.setActiveConfiguration 函数激活此配置以便度量引擎使用。

configName = 'Config.xml';
save(CONF,'FileName', configName);
slmetric.config.setActiveConfiguration(fullfile(pwd, configName));

现在，您可以使用此自定义配置对模型运行度量仪表板。

版本历史记录

在 R2018b 中推出

全部折叠

另请参阅

| | | | | |

主题