Main Content

slmetric.config.Classification クラス

名前空間: slmetric.config

(削除予定) カテゴリカル メトリクス データ範囲の指定

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

メトリクス ダッシュボード ユーザー インターフェイス、関数 metricdashboard、slmetric パッケージ API、および対応するカスタマイズは将来のリリースで削除される予定です。詳細については、Migrating from Metrics Dashboard to Model Maintainability Dashboardを参照してください。

説明

slmetric.config.Classification クラスを使用してメトリクス データの範囲を Compliant、Warning、および NonCompliant として分類します。メトリクス ダッシュボードには、メトリクス データが分類される範囲が示されます。

作成

slmetric.config.Threshold オブジェクトの場合は、Compliant 範囲に対応する 1 つの slmetric.config.Classification オブジェクトが必要です。1 つの準拠範囲のみ可能です。Warning 範囲と Noncompliant 範囲に対応する複数の slmetric.config.Classification オブジェクトを指定できます。

既定では、しきい値オブジェクトには、Compliant 範囲が -inf ～ inf の slmetric.config.Classification オブジェクトが含まれます。分類オブジェクトを追加するには、slmetric.config.Classification.addClassification メソッドを使用します。

プロパティ

すべて展開する

メトリクス データの値は次の 3 つのカテゴリに分類できます。

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

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

  • Noncompliant — モデルの変更が必要なメトリクス データ。

このプロパティは読み取りと書き込みが可能です。

データ型: char

各 slmetric.metric.config.Classification オブジェクトについて、slmetric.config.MetricRange オブジェクトのプロパティを指定します。このプロパティは読み取りと書き込みが可能です。

例

すべて折りたたむ

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

  • 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 オブジェクトに追加します。このしきい値は、mathworks.metrics.SimulinkBlockCount メトリクスと、slmetric.metric.Results オブジェクトの 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 で導入

すべて折りたたむ

R2022a: メトリクス ダッシュボードは削除予定

メトリクス ダッシュボード ユーザー インターフェイス、関数 metricdashboard、slmetric パッケージ API、および対応するカスタマイズは将来のリリースで削除される予定です。詳細については、Migrating from Metrics Dashboard to Model Maintainability Dashboardを参照してください。

参考

| | | | | |

トピック