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

slmetric.metric.Metric クラス

名前空間: slmetric.metric
スーパークラス:

(削除予定) モデル メトリクスを作成する抽象クラス

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

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

説明

モデル メトリクスを作成する抽象基底クラス。モデル メトリクスを作成するには、slmetric.metric.Metric クラスから派生させた MATLAB® クラスを作成します。

プロパティ

すべて展開する

メトリクス計算のコンパイル モード。モデル メトリクスでモデルのコンパイルが必要な場合は、PostCompile を指定します。モデル メトリクスでモデルのコンパイルが必要でない場合は、None を指定します。

例: 'PostCompile'

データ型: char

メトリクスが計算されるモデル コンポーネント。メトリクスは、タイプに一致しているすべてのコンポーネントについて計算されます。

メトリクスの説明。

データ型: char

一意のメトリクス識別子。

データ型: char

このプロパティを使用して、メトリクス アルゴリズムの変更をメトリクス エンジンに伝えます。

データ型: uint32

カスタム メトリクス アルゴリズムの名前を指定します。

データ型: char

メトリクスで収集される値の名前を指定します。メトリクス ダッシュボードで詳細な結果を表示すると、ValueName がテーブル ビューおよびツリー ビューで、収集された値の列ヘッダーとして示されます。

データ型: char

メトリクスで収集される集計値の名前を指定します。このプロパティを指定するには、AggregationMode を None に設定します。メトリクス ダッシュボードで詳細な結果を表示すると、AggregatedValueName がテーブル ビューおよびツリー ビューで、収集された集計値の列ヘッダーとして示されます。

データ型: char

メトリクスで収集する測定の名前を指定します。このプロパティを設定するのは、メトリクス アルゴリズムによって、アルゴリズムが返す結果オブジェクトに測定を書き込む場合のみです。メトリクス ダッシュボードで詳細な結果を表示すると、MeasuresNames がテーブル ビューおよびツリー ビューで、収集された測定の列ヘッダーとして示されます。

データ型: char

メトリクスで収集して集計される測定の名前を指定します。このプロパティを設定するのは、メトリクス アルゴリズムによって、アルゴリズムが返す結果オブジェクトに測定を書き込み、かつ AggregationMode が None に設定されている場合のみです。メトリクス ダッシュボードで詳細な結果を表示すると、AggregatedMeasuresNames がテーブル ビューおよびツリー ビューで、収集して集計された測定の列ヘッダーとして示されます。

データ型: char

true の場合、メトリクス アルゴリズムで生成される結果は、モデルまたはライブラリのソース ファイルが変更された場合にのみ変更されます。ソース ファイルとメトリクスの Version が変更されていない場合は、メトリクス データは再生成されません。false の場合、slmetric.Engine.execute を呼び出すごとに、当該メトリクスの新規データが収集され、メトリクス リポジトリに保存されます。

データ型: logical

コンポーネント階層全体で slmetric.metric.Result オブジェクト プロパティ Value および Measure を集計する演算を指定します。メトリクス アルゴリズムは、集計値を slmetric.metric.Result オブジェクト プロパティ AggregatedValues および AggregatedMeasures に出力します。次のオプションがあります。

  • Sum:コンポーネント階層全体での、Value プロパティとそのすべての子コンポーネントの Value プロパティの合計を返します。

  • Max:コンポーネント階層全体での、Value プロパティとそのすべての子コンポーネントの Value プロパティの最大値を返します。

  • None:メトリクス値の集計はありません。

データ型: char

slmetric.metric.Result オブジェクト プロパティ Details にデータが含まれるかどうかを指定します。既定値は false です。このプロパティの値を false に設定すると、メトリクス ダッシュボード フィルターが有効になります。

データ型: logical

メソッド

algorithm(削除予定) メトリクス データ解析のロジックの指定

バージョン履歴

R2016a で導入

すべて折りたたむ

参考

| | |

トピック