Main Content

slreportgen.report.SimulinkObjectProperties クラス

パッケージ: slreportgen.report
スーパークラス: slreportgen.report.Reporter

Simulink オブジェクト プロパティのレポーター

説明

SimulinkObjectProperties レポーターは、Simulink® オブジェクトのプロパティとプロパティ値をリストするテーブルを生成します。

メモ

レポートで Simulink オブジェクト プロパティのレポーターを使用するには、slreportgen.report.Report クラスを使用してレポートを作成する必要があります。

slreportgen.report.SimulinkObjectProperties クラスは handle クラスです。

作成

説明

reporter = SimulinkObjectProperties() は、空の Simulink オブジェクト プロパティのレポーターを作成します。Object プロパティを使用して、レポートするオブジェクトを指定します。

生成されるプロパティ テーブルに含める Simulink オブジェクト プロパティのリストを指定するには、レポーターの Properties プロパティを使用します。プロパティを指定しない場合、レポーターはオブジェクト タイプに基づいて既定のプロパティ セットを含めます。たとえば、ブロックのプロパティ テーブルには、そのパラメーター ダイアログ ボックスで設定されているプロパティが含まれます。

生成されるプロパティ テーブルの形式をカスタマイズするには、PropertyTable プロパティを使用します。

メモ

このレポーターは、レポート対象のオブジェクトを含むモデルがまだコンパイルされていない場合は、モデルをコンパイルします。モデルのコンパイルは、モデルがコンパイルされていない場合に未指定となるプロパティに値を伝播するために必要です。生成されたプロパティ テーブルを含むレポートを閉じると、モデルのコンパイルは解除されます。

reporter = SimulinkObjectProperties(obj) は、指定された Simulink オブジェクトのプロパティ値をリストするテーブルを生成するレポーターを作成します。

reporter = SimulinkObjectProperties(Name=Value) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順序で指定できます。

入力引数

すべて展開する

Object プロパティを参照してください。

プロパティ

すべて展開する

プロパティをレポートする Simulink オブジェクト。指定のオブジェクトへのパスまたはハンドルとして指定します。Object 値は、次のいずれかのタイプのオブジェクトでなければなりません。

  • モデル

  • ブロック

  • 注釈

  • 端子

  • ライン

  • ライン セグメント

オブジェクト プロパティ テーブルのレポーター。mlreportgen.report.BaseTable レポーターとして指定します。オブジェクト プロパティのレポーターは、ベース テーブルのレポーターを使用してオブジェクト プロパティを書式設定します。このプロパティが最初に空になっている場合、オブジェクト プロパティのレポーターはこのプロパティを既定のプロパティ テーブル レポーターに設定します。プロパティ テーブルの書式設定をカスタマイズするには、このプロパティを書式設定の要件を満たすベース テーブルのレポーターに設定します。

プロパティ名をダイアログ ボックス プロンプトとして表示するかどうかの選択。logical として指定します。true の場合で、プロパティがオブジェクトのダイアログ ボックスに表示される場合、テーブルには、そのプロパティ名の代わりにダイアログ ボックス プロンプトがリストされます。それ以外の場合、生成されたプロパティ テーブルには、そのプロパティ名を使用してプロパティがリストされます。

空の値をもつプロパティを表示するかどうかの選択。

空の値をもつプロパティを表示するかどうか。logical として指定します。false の場合、値が空のオブジェクト プロパティは、生成されたオブジェクト プロパティ テーブルから除外されます。true の場合、テーブルには値が空のプロパティが含まれます。

レポート対象のオブジェクト プロパティの名前。cell 配列として指定します。

レポート対象とするオブジェクト プロパティの名前の cell 配列。string または文字ベクトルの cell 配列として指定します。プロパティを指定しない場合、レポーターがレポート対象のプロパティ セットを決定します。

このレポーターのテンプレートのソース。次のいずれかのオプションとして指定します。

  • このレポーターのテンプレートを含むファイルのパスを指定する、文字ベクトルまたは string スカラー

  • このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、レポーターまたはレポート

  • このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、DOM ドキュメントまたはドキュメント パーツ

指定されるテンプレートは、このレポーターが追加されるレポートと同じタイプでなければなりません。たとえば、Microsoft® Word レポートの場合、TemplateSrc は Word レポーター テンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプで既定のレポーター テンプレートを使用します。

このレポーターのテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーターのテンプレートは、このレポーターのテンプレート ソース (TemplateSrc) のテンプレート ライブラリになければなりません。

このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルまたは string スカラー、あるいは mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラーの値は LinkTarget オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前に配置されます。

メソッド

すべて展開する

すべて折りたたむ

SimulinkObjectProperties レポーターを使用して、slrgex_vdp モデルのプロパティ テーブルをレポートに追加します。

次のコマンドを実行して、この例で使用するサポート ファイルにアクセスします。

openExample('rptgenext/SimulinkReportGeneratorFilesExample');
import slreportgen.report.*
import mlreportgen.report.*
model_name = "slrgex_vdp";
load_system(model_name);

rpt = slreportgen.report.Report("output","pdf");
chapter = Chapter(model_name);
rptr = SimulinkObjectProperties(model_name);

add(chapter, rptr);
add(rpt, chapter);
close(rpt);
close_system(model_name);
rptview(rpt);

プロパティ テーブルをレポートに追加し、モデルのライン セグメントのプロパティのみを含めます。

次のコマンドを実行して、この例で使用するサポート ファイルにアクセスします。

openExample('rptgenext/SimulinkReportGeneratorFilesExample');
import slreportgen.report.*
import mlreportgen.report.*
model_name = "slrgex_vdp";
rpt = slreportgen.report.Report("output","pdf");
chapter = Chapter(model_name);

load_system(model_name);
ph = get_param("slrgex_vdp/Mu","PortHandles");
outPort = ph.Outport;
line = get_param(outPort,"Line");
rptr = SimulinkObjectProperties(line);
rptr.Properties = {"Parent","SourcePort","StorageClass"};

add(chapter,rptr);
add(rpt,chapter);
close(rpt);
close_system(model_name);
rptview(rpt);

バージョン履歴

R2017b で導入