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(PropertyName=Value) は、名前と値の引数を使用してプロパティを設定します。複数の名前と値の引数を任意の順序で指定できます。

例

入力引数

すべて展開する

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

プロパティ

すべて展開する

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

  • モデル

  • ブロック

  • 注釈

  • 端子

  • ライン

  • ライン セグメント

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

属性:

GetAccess
public
SetAccess
public

プロパティ名をダイアログ ボックス プロンプトとして表示するかどうか。logical の 1 (true) または 0 (false) として指定します。指定に関する詳細は次の通りです。

  • 1 (true) — プロパティ名をダイアログ ボックス プロンプトとして表示します。プロパティ テーブルには、そのプロパティ名の代わりにダイアログ ボックス プロンプトがリストされます。

  • 0 (false) — プロパティ名をダイアログ ボックス プロンプトとして表示しません。プロパティ テーブルには、そのプロパティ名を使用してプロパティがリストされます。

属性:

GetAccess
public
SetAccess
public

データ型: logical

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

空の値をもつプロパティを表示するかどうか。logical の 1 (true) または 0 (false) として指定します。指定に関する詳細は次の通りです。

  • 1 (true) — 空の値をもつプロパティをテーブルに表示します。

  • 0 (false) — 空の値をもつプロパティをテーブルから除外します。

属性:

GetAccess
public
SetAccess
public

データ型: logical

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

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

属性:

GetAccess
public
SetAccess
public

データ型: cell

このレポーターのテンプレートのソース。以下のいずれかの方法で指定します。

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

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

  • このレポーターが使用するテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、ドキュメント オブジェクト モデル (DOM) のドキュメントまたはドキュメント パーツ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true
Dependent
true

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

属性:

GetAccess
public
SetAccess
public

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

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

import slreportgen.report.*
import mlreportgen.report.*
model_name = "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);
ライブ スクリプトを開く

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

import slreportgen.report.*
import mlreportgen.report.*
model_name = "vdp";
rpt = slreportgen.report.Report("output","pdf");
chapter = Chapter(model_name);

load_system(model_name);
ph = get_param("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);
rptview(rpt);
close_system(model_name);

バージョン履歴

R2017b で導入

参考

| | |

トピック