slreportgen.finder.DataDictionaryResult クラス

名前空間: slreportgen.finder
スーパークラス: mlreportgen.finder.Result

データ ディクショナリの検索結果オブジェクト

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

説明

slreportgen.finder.DataDictionaryResult クラスのオブジェクトは、データ ディクショナリの検索の結果を表します。DataDictionaryResult オブジェクトはレポートに直接追加できます。あるいは、getReporter メソッドを使用して結果の slreportgen.report.DataDictionary レポーターにアクセスし、レポーターをカスタマイズしてレポートに追加できます。

slreportgen.finder.DataDictionaryResult クラスは handle クラスです。

クラス属性

HandleCompatible
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

slreportgen.finder.DataDictionaryResult オブジェクトは、明示的に作成しません。slreportgen.finder.DataDictionaryFinder の find メソッドと next メソッドは、検出したデータ ディクショナリごとに slreportgen.finder.DataDictionaryResult オブジェクトを作成します。

プロパティ

すべて展開する

パブリック プロパティ

この結果に加える追加のユーザー定義情報。任意の値として指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

保護プロパティ

この結果によって表されるデータ ディクショナリの絶対パス。string スカラーとして指定します。このプロパティは読み取り専用です。

この結果によって表されるデータ ディクショナリのファイル名。string スカラーとして指定します。このプロパティは読み取り専用です。

メソッド

すべて展開する

例

すべて折りたたむ

この例では次を使用します。

ライブ スクリプトを開く

slreportgen.finder.DataDictionaryResult オブジェクトの getReporter メソッドを使用して、結果のデータ ディクショナリ レポーターにアクセスします。次に、プロパティを設定することでレポーターをカスタマイズします。

長い完全修飾クラス名を使用せずに済むように、MATLAB レポートおよび Simulink レポートの API パッケージをインポートします。

import mlreportgen.report.*
import slreportgen.report.*

Simulink レポートを作成し、目次を追加します。

rpt = slreportgen.report.Report("MyReport","html-file");
append(rpt,TableOfContents);

MATLAB パス全体を検索するディクショナリ ファインダーを作成します。名前に type という単語を含むデータ ディクショナリのみを検索します。

f = slreportgen.finder.DataDictionaryFinder();
f.Name = "*type*";

データ ディクショナリの各結果の節を含む章を作成します。それぞれの結果について、Design Data 概要テーブルに Name、Value、および Class プロパティのみを含めるようにレポーターをカスタマイズします。

ch = Chapter("Data Dictionaries");
while hasNext(f)
    result = next(f);
    s = Section(result.Name);
    rptr = getReporter(result);
    rptr.SummaryProperties = ["Name" "Value" "Class"];
    append(s,rptr);
    append(ch,s);
end

章をレポートに追加します。レポートを閉じて表示します。

append(rpt,ch);
close(rpt);
rptview(rpt);

レポートには、検出したディクショナリごとに sldemo_fuelsys_dd_types.sldd 節と sldemo_fuelsys_dd_types_float.sldd 節があります。各ディクショナリの概要テーブルには、Name、Value、および Class プロパティのみが含まれます。

Chapter 1 of report, containing sections for the data dictionaries sldemo_fuelsys_dd_types.sldd and sldemo_fuelsys_dd_types_float.sldd.

バージョン履歴

R2020b で導入

参考

|

トピック