Main Content

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

slmetric.config.Threshold

メトリクス結果しきい値を保持するオブジェクト

このページをすべて展開する

説明

モデル メトリクス結果のしきい値を指定します。

作成

addThreshold を使用して slmetric.config.Threshold オブジェクトを作成します。

プロパティ

すべて展開する

この プロパティ は読み取り専用です。

モデル メトリクスまたはカスタム モデル メトリクスのメトリクス識別子。文字ベクトルとして返されます。

例: 'mathworks.metrics.SimulinkBlockCount'

データ型: char

この プロパティ は読み取り専用です。

しきい値を適用する slmetric.metric.Result プロパティ。文字ベクトルとして返されます。Value および AggregatedValue プロパティにしきい値を適用できます。

データ型: char

オブジェクト関数

addClassification(To be removed) Add metric data classification to slmetric.config.Threshold object
getClassifications(To be removed) Obtain metric data classifications
removeClassification(To be removed) Remove metric threshold classification
validate(To be removed) Validate metric range thresholds

例

すべて折りたたむ

slmetric.config.Threshold および slmetric.config.Configuration オブジェクトを使用して、メトリクス ダッシュボードにしきい値情報を追加します。以下の 3 つのカテゴリのメトリクス データ範囲を定義するしきい値を追加できます。

  • 準拠 — 許容範囲内のメトリクス データ

  • 警告 — 確認が必要なメトリクス データ

  • 非準拠 — モデルの変更が必要なメトリクス データ

slmetric.config.Configuration オブジェクトを作成します。

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

CONF の既定の slmetric.config.ThresholdConfiguration オブジェクトを取得します。

TC = getThresholdConfigurations(CONF);

slmetric.config.Threshold オブジェクトを作成して slmetric.config.ThresholdConfiguration オブジェクトに追加します。このしきい値は、mathworks.metrics.SimulinkBlockCount メトリクスと、slmetric.metric.Results オブジェクトの Value プロパティに対応します。

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

既定では、slmetric.config.Threshold オブジェクトには、準拠カテゴリのメトリクス範囲を定義する slmetric.config.Classification オブジェクトが含まれます。しきい値オブジェクト T に対して関数 getClassifications を使用して分類オブジェクトを取得します。

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 で導入

参考

| | | | | |

トピック