Main Content

slmetric.config.Configuration クラス

パッケージ: slmetric.config

メトリクス データ カテゴリおよびカスタム メトリクス ファミリを指定する

説明

slmetric.config.Configuration のインスタンスには、しきい値およびカスタム メトリクス ファミリに関するカスタマイズが含まれます。メトリクス エンジンは、データを収集する際にこれらのカスタマイズを使用してメトリクス ダッシュボードに表示します。

作成

slmetric.config.Configuration クラスを使用して、メトリクスしきい値およびカスタム メトリクス ファミリをメトリクス ダッシュボードに追加します。slmetric.config.Configuration オブジェクトを作成するには、new メソッドを使用します。各 slmetric.config.Configuration オブジェクトには、1 つの slmetric.config.ThresholdConfiguration オブジェクトが含まれます。

プロパティ

すべて展開する

メトリクス ダッシュボードのカスタマイズの作成に使用する構成オブジェクトの名前。このプロパティは読み取りと書き込みが可能です。

データ型: char

メトリクス ダッシュボードのカスタマイズが含まれている XML ファイルの名前。このプロパティは読み取りと書き込みが可能です。

データ型: char

メトリクス ダッシュボードのカスタマイズが含まれている XML ファイルの場所。このプロパティはオプションであり、読み取りと書き込みが可能です。

メソッド

getMetricFamilyParameterValues Obtain metric family Check Group IDs
getThresholdConfigurations Specify metric threshold configurations
isMetricFamilyParameterParameterized Determine whether Metrics Dashboard configuration object has metric family parameter values
new Create configuration object for customizing the Metrics Dashboard
open Create configuration object associated with XML configuration file in the base workspace
openDefaultConfiguration Return shipping Metrics Dashboard configuration object in base workspace
resetMetricFamilyParameterValues Clear metric family parameter values
saveSave contents of slmetric.config.Configuration object to XML file
setMetricFamilyParameterValues 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 オブジェクトに追加します。このしきい値は、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;

これらの値は、準拠範囲が 5100 のブロック数であることを指定します。この範囲には、5100 の値は含まれません。

Warning のメトリクス範囲の値を指定します。

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

これらの値は、警告が -inf5 のブロック数であることを指定します。この範囲には、-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 で導入