slreportgen.report.SystemIO クラス

名前空間: slreportgen.report
スーパークラス: slreportgen.report.Reporter

Simulink システム入出力信号レポーター

説明

Simulink^® モデルまたはサブシステムの入出力信号についてレポートするレポーターを作成します。

メモ

レポートで SystemIO レポーターを使用するには、slreportgen.report.Report クラスを使用してレポートを作成する必要があります。

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

クラス属性

HandleCompatible

true

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

作成

説明

slreportgen.report.SystemIO は、空の slreportgen.report.SystemIO レポーター オブジェクトを作成します。Object プロパティを使用して、レポートするモデルまたはサブシステムを指定します。既定では、レポーターはシステムの入出力についての概要テーブルを生成します。入力の概要テーブルには、入力信号の接続元がリストされます。出力の概要テーブルには、出力信号の接続先がリストされます。レポーターは、入出力端子のプロパティをリストする信号の詳細の節も生成します。生成されるレポートの内容や外観をカスタマイズするには、レポーターのプロパティを使用します。たとえば、信号の詳細に関する節の内容や外観をカスタマイズするには DetailsReporter プロパティを使用します。

slreportgen.report.SystemIO(object) は、object で指定されたモデルまたはサブシステムのレポーターを作成します。Object プロパティを参照してください。

slreportgen.report.SystemIO(Name=Value) は、名前と値の引数を使用してレポーター プロパティを設定します。複数の名前と値の引数を任意の順序で指定できます。

プロパティ

Object — レポート対象のモデルまたはサブシステム

string スカラー | 文字ベクトル | ハンドル | slreportgen.finder.DiagramResult オブジェクト | slreportgen.finder.BlockResult オブジェクト

レポート対象の Simulink モデルまたはサブシステム。モデルまたはサブシステムのパスを含む文字ベクトルまたは string スカラーとして指定するか、モデルまたはサブシステムのハンドルとして指定するか、slreportgen.finder.DiagramResult オブジェクトまたは slreportgen.finder.BlockResult オブジェクトとして指定します。

属性:

GetAccess	public
SetAccess	public

InputSummaryProperties — 各入力についてレポートするプロパティのリスト

string 配列 | 文字ベクトルの cell 配列

各入力についてレポートするプロパティのリスト。string 配列、または文字ベクトルの cell 配列として指定します。既定では、Port、Inport Block、Source、Name、および DataType がリストに含まれます。Inport Block についてレポートされる値は、システムの入力信号に対応する Inport ブロックの名前です。リストに含めることができる信号プロパティは次のとおりです。

• "Port"

• "Source"

• "Name"

• "Description"

• "DataType"

• "Complexity"

• "Dimensions"

• "Min"

• "Max"

• "SampleTime"

• "Units"

さらに、対応する Inport ブロックの次のブロック プロパティも指定できます。

• "Inport Block"

• "Inport Block Description"

属性:

GetAccess	public
SetAccess	public

OutputSummaryProperties — 各出力についてレポートするプロパティのリスト

string 配列 | 文字ベクトルの cell 配列

各出力についてレポートするプロパティのリスト。string 配列、または文字ベクトルの cell 配列として指定します。既定では、Port、Outport Block、Destination、Name、および DataType がリストに含まれます。Outport Block についてレポートされる値は、システムの出力信号に対応する Outport ブロックの名前です。リストに含めることができる信号プロパティは次のとおりです。

• "Port"

• "Destination"

• "Name"

• "Description"

• "DataType"

• "Complexity"

• "Dimensions"

• "Min"

• "Max"

• "SampleTime"

• "Units"

さらに、対応する Outport block の次のブロック プロパティも指定できます。

• "Outport Block"

• "Outport Block Description"

属性:

GetAccess	public
SetAccess	public

ShowInputSummary — 入力の概要テーブルを表示するかどうか

true (既定値) | false

サブシステムまたはモデルへの入力をまとめたテーブルを表示するかどうか。true または false として指定します。テーブルに含まれる入力についてのプロパティは InputSummaryProperties プロパティで決まります。

属性:

GetAccess	public
SetAccess	public

ShowOutputSummary — 出力の概要テーブルを表示するかどうか

true (既定値) | false

サブシステムまたはモデルからの出力をまとめたテーブルを表示するかどうか。true または false として指定します。テーブルに含まれる出力についてのプロパティは OutputSummaryProperties プロパティで決まります。

属性:

GetAccess	public
SetAccess	public

ShowDetails — 各入出力の詳細を表示するかどうか

true (既定値) | false

各入出力の詳細を表示するかどうか。true または false として指定します。ShowDetails が true の場合、レポーターは slreportgen.report.SimulinkObjectProperties レポーターを入出力の概要テーブルの後に挿入します。Object がモデルの場合は、入出力ブロックに関する詳細が含まれます。Object がサブシステムの場合は、入出力端子に関する詳細が含まれます。概要テーブルの端子番号は、その端子の対応する SimulinkObjectProperties レポーターにリンクしています。

属性:

GetAccess	public
SetAccess	public

ShowEmptyColumns — 概要テーブルに空の列を表示するかどうか

false (既定値) | true

概要テーブルに空の列を表示するかどうか。true または false として指定します。ShowEmptyColumns が true の場合、概要テーブルにデータがない列が含まれます。

属性:

GetAccess	public
SetAccess	public

InputSummaryReporter — 入力の概要テーブルのテーブル フォーマッタ

mlreportgen.report.BaseTable オブジェクト

入力の概要テーブルのテーブル フォーマッタ。mlreportgen.report.BaseTable レポーターとして指定します。既定値は BaseTable レポーターです。テーブルの外観をカスタマイズするには、既定のテーブル レポーターのプロパティを変更するか、そのテーブル レポーターをカスタマイズしたテーブル レポーターに置き換えます。既定またはカスタマイズしたテーブル レポーターの Title プロパティに内容を追加すると、生成されたレポートでテーブルのタイトルの前にその内容が表示されます。

属性:

GetAccess	public
SetAccess	public

OutputSummaryReporter — 出力の概要テーブルのテーブル フォーマッタ

mlreportgen.report.BaseTable オブジェクト

出力の概要テーブルのテーブル フォーマッタ。mlreportgen.report.BaseTable レポーターとして指定します。既定値は BaseTable レポーターです。テーブルの外観をカスタマイズするには、既定のテーブル レポーターのプロパティを変更するか、そのテーブル レポーターをカスタマイズしたテーブル レポーターに置き換えます。既定またはカスタマイズしたテーブル レポーターの Title プロパティに内容を追加すると、生成されたレポートでテーブルのタイトルの前にその内容が表示されます。

属性:

GetAccess	public
SetAccess	public

DetailsReporter — 詳細テーブルのフォーマッタ

slreportgen.report.SimulinkObjectProperties オブジェクト

詳細テーブルのフォーマッタ。slreportgen.report.SimulinkObjectProperties レポーターとして指定します。既定値は SimulinkObjectProperties レポーターです。詳細テーブルの外観をカスタマイズするには、既定の SimulinkObjectProperties レポーターのプロパティを変更するか、そのレポーターをカスタマイズした SimulinkObjectProperties レポーターに置き換えます。

属性:

GetAccess	public
SetAccess	public

ListFormatter — 接続元リストと接続先リストのリスト フォーマッタ

mlreportgen.dom.UnorderedList オブジェクト | mlreportgen.dom.OrderedList オブジェクト

接続元リストと接続先リストのリスト フォーマッタ。mlreportgen.dom.UnorderedList オブジェクトまたは mlreportgen.dom.OrderedList オブジェクトとして指定します。接続元リストは、入力信号が接続されているブロックのリストです。接続先リストは、出力信号が接続されているブロックのリストです。既定のフォーマッタは UnorderedList オブジェクトです。リストの外観をカスタマイズするには、既定のリスト フォーマッタのプロパティを変更するか、そのリスト フォーマッタを子を含まないカスタマイズしたリスト オブジェクトに置き換えます。

属性:

GetAccess	public
SetAccess	public

TemplateSrc — このレポーターのテンプレートのソース

文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメント パーツ

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

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

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

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

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

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

TemplateName — このレポーターのテンプレートの名前

文字ベクトル | string スカラー

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

属性:

GetAccess	public
SetAccess	public

データ型: char | string

LinkTarget — このレポーターのハイパーリンク ターゲット

[] (既定値) | 文字ベクトル | string スカラー | mlreportgen.dom.LinkTarget オブジェクト

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

属性:

GetAccess	public
SetAccess	public

メソッド

パブリック メソッド

slreportgen.report.SystemIO.createTemplate	既定の slreportgen.report.SystemIO レポーター テンプレートをコピー
slreportgen.report.SystemIO.customizeReporter	slreportgen.report.SystemIO クラスのサブクラスを作成
slreportgen.report.SystemIO.getClassFolder	Get location of folder that contains the slreportgen.report.SystemIO class definition file
copy	Create copy of a Simulink reporter object and make deep copies of certain property values
getImpl	レポーターの実装を取得する

例

モデルの入出力についてのレポート

この例では、slreportgen.report.SystemIO レポーターを使用して、モデルとそのサブシステムの入出力についてレポートします。

model_name = "f14";
load_system(model_name);

Simulink レポートを作成します。

rpt = slreportgen.report.Report("SystemIO_example","docx");

モデル内のすべてのブロック線図を検索するファインダーを作成します。

finder = slreportgen.finder.DiagramFinder(model_name);

各ブロック線図の入出力をレポートを作成します。SystemIO レポーターを作成し、レポートに追加します。

ch = mlreportgen.report.Chapter("Diagrams");
while hasNext(finder)
  result = next(finder);
  if strcmpi(result.Type,"Simulink.SubSystem") ...
          || strcmpi(result.Type,"Simulink.BlockDiagram")
      sect = mlreportgen.report.Section(result.Name);
      add(sect,result);
      ioRptr = slreportgen.report.SystemIO(result);        
      add(sect,ioRptr);
      add(ch,sect);
  end
end

レポートに章を追加し、レポートを閉じます。

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

ヒント

• SystemIO レポーターでレポートされる入出力信号のプロパティは Simulink のプロパティに対応しており、get_param を使用してクエリできます。たとえば、DataType プロパティと Dimensions プロパティは、Simulink の端子ハンドルの CompiledPortDataType プロパティと CompiledPortDimensions プロパティに対応します。

• Simulink では、バス信号については、信号が非バーチャル バスであるかバーチャル バスであるかに基づいて CompiledPortDataType プロパティと CompiledPortDimensions プロパティの値を決定します。

バージョン履歴

R2020a で導入

R2021b: InputSummaryProperties と OutputSummaryProperties の既定値

R2021b 以降では、InputSummaryProperties プロパティの既定値は ["Port" "Inport Block" "Source" "Name" "DataType"]、OutputSummaryProperties プロパティの既定値は ["Port" "Outport Block" "Destination" "Name" "DataType"] です。R2021b より前は、InputSummaryProperties の既定値は ["Source" "Name" "DataType"]、OutputSummaryProperties の既定値は ["Destination" "Name" "DataType"] でした。

R2021b より前は、InputSummaryProperties プロパティまたは OutputSummaryProperties プロパティの値に関係なく、モデルの信号の Inport ブロックまたは Outport ブロック、およびサブシステムの信号の端子番号が SystemIO オブジェクトで常にレポートされていました。R2021b 以降では、モデルまたはサブシステムの信号の Inport ブロックまたは Outport ブロックをレポートするには、InputSummaryProperties プロパティまたは OutputSummaryProperties プロパティのプロパティ リストに Inport Block または Outport Block を含める必要があります。端子番号をレポートするには、プロパティ リストに Port を含める必要があります。

R2021b: プロパティ リストでの Inport ブロックまたは Outport ブロックの指定

R2021b 以降では、InputSummaryProperties プロパティで Inport Block Name の代わりに Inport Block、OutputSummaryProperties プロパティで Outport Block Name の代わりに Outport Block を指定できます。Inport Block Name と Outport Block Name も引き続き有効です。

参考

slreportgen.finder.DiagramResult | slreportgen.finder.BlockResult

トピック

• システムの入出力のレポート
• Simulink および Stateflow 要素用の Report Generator の作成
• レポーターとは