slmetric.config.Configuration 类

命名空间: slmetric.config

（即将删除）指定度量数据类别和自定义度量族别

全页展开

以后的版本中将会删除度量仪表板用户界面、metricdashboard 函数、slmetric 包 API 以及相应的自定义项。有关详细信息，请参阅Migrating from Metrics Dashboard to Model Maintainability Dashboard。

描述

slmetric.config.Configuration 的实例包含与阈值和自定义度量族别相关的自定义项。度量引擎在收集数据时会使用这些自定义项，并在度量仪表板上显示它们。

构造

使用 slmetric.config.Configuration 类向度量仪表板添加度量阈值和自定义度量族别。要创建 slmetric.config.Configuration 对象，请使用 new 方法。每个 slmetric.config.Configuration 对象包含一个 slmetric.config.ThresholdConfiguration 对象。

属性

全部展开

用于创建度量仪表板自定义项的配置对象的名称。此属性是可读取/写入的。

数据类型: char

包含度量仪表板自定义项的 XML 文件的名称。此属性是可读取/写入的。

数据类型: char

包含度量仪表板自定义项的 XML 文件的位置。此属性是可选且可读取/写入的。

方法

getMetricFamilyParameterValues(To be removed) Obtain metric family Check Group IDs
getThresholdConfigurations(To be removed) Specify metric threshold configurations
isMetricFamilyParameterParameterized(To be removed) Determine whether Metrics Dashboard configuration object has metric family parameter values
new（将删除）创建用于自定义度量仪表板的配置对象
open(To be removed) Create configuration object associated with XML configuration file in base workspace
openDefaultConfiguration(To be removed) Return shipping Metrics Dashboard configuration object in base workspace
resetMetricFamilyParameterValues(To be removed) Clear metric family parameter values
save(To be removed) Save contents of slmetric.config.Configuration object to XML file
setMetricFamilyParameterValues(To be removed) Obtain compliance and issues metric data on your Model Advisor configuration

示例

全部折叠

使用 slmetric.config 打包的类向度量仪表板添加阈值信息。您可以添加阈值来定义以下类别的度量数据范围：

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

  • Warning - 需要审核的度量数据。

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

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

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

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

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 对象包含与 Compliant 类别对应的默认 slmetric.config.Classification 对象。使用 slmetric.metric.MetricRange 类指定 Compliant 度量范围的度量值。

C = getClassifications(T); % default classification is Compliant
C.Range.Start = 5;
C.Range.IncludeStart = 0;
C.Range.End = 100;
C.Range.IncludeEnd = 0;

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

指定 Warning 度量范围的值。

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

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

指定 NonCompliant 度量范围的值。

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 中推出

全部折叠

另请参阅

| | | | | |

主题