Main Content

slreportgen.report.SystemHierarchy クラス

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

システム階層レポーター

R2019b 以降

説明

Simulink® のモデルまたはサブシステムについて、サブシステムの入れ子形式のリストをレポートで生成するシステム階層レポーターを作成します。

メモ

レポートでシステム階層レポーターを使用するには、slreportgen.report.Report クラスまたはサブクラスを使用してレポートを作成する必要があります。

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

クラス属性

HandleCompatible
true

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

作成

説明

rptr = slreportgen.report.SystemHierarchy() は、既定のテンプレートに基づいて空のシステム階層レポーターを作成します。レポーターのプロパティを使用して、生成されるリストの内容や形式をカスタマイズします。レポーターをレポートに追加する前に、レポーターの Source プロパティでモデルまたはサブシステムを指定する必要があります。空のレポーターをレポートに追加すると、エラーが発生します。

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

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

プロパティ

すべて展開する

Simulink モデルまたはサブシステム。モデルまたはサブシステムのパスを含む string スカラーまたは文字ベクトルとして指定するか、モデルまたはサブシステムのハンドルとして指定します。

生成されるリストにソース サブシステムの先祖を含める最大レベル数。非負の整数スカラーとして指定します。たとえば、MaxAncestorLevel2 の場合、ソースと 2 レベルまでの先祖がリストに含まれます。MaxAncestorLevel が既定値の Inf の場合、すべての先祖がリストに含まれます。MaxAncestorLevel がゼロの場合、リストに先祖は含まれません。

生成されるリストにソース モデルまたはサブシステムの子孫を含める最大レベル数。非負の整数スカラーとして指定します。たとえば、MaxDescendantLevel2 の場合、ソースと 2 レベルまでの子孫がリストに含まれます。MaxDescendantLevel が既定値の Inf の場合、すべての子孫がリストに含まれます。MaxDescendantLevel がゼロの場合、リストに子孫は含まれません。

生成されるリストにソース サブシステムのピアを含めるかどうか。true または false として指定します。

生成されるリストでソース モデルまたはサブシステムを強調するかどうか。true または false として指定します。EmphasizeSourcetrue の場合、ソース モデルまたはサブシステムの名前が TextFormatter プロパティに従った形式で示されます。それ以外の場合、リストの他の項目と同様の形式になります。

生成されるリストの形式を設定するリスト フォーマッタ。mlreportgen.dom.UnorderedList オブジェクトまたは mlreportgen.dom.OrderedList オブジェクトとして指定します。このプロパティの既定値は、mlreportgen.dom.UnorderedList のオブジェクトです。リストの形式をカスタマイズするには、リスト オブジェクトのプロパティを変更するか、そのリスト オブジェクトをリスト項目を含まないカスタマイズしたリスト オブジェクトに置き換えます。

生成されるリストでのソース モデルまたはサブシステムの名前の形式を設定するテキスト フォーマッタ オブジェクト。mlreportgen.dom.Text オブジェクトとして指定します。このプロパティは、EmphasizeSource プロパティが true の場合のみ適用されます。SourceTextFormatter プロパティの初期値は、Bold プロパティと Italic プロパティが true に設定された mlreportgen.dom.Text オブジェクトです。生成されるリストでの名前の外観をカスタマイズするには、mlreportgen.dom.Text オブジェクトのプロパティを変更するか、そのオブジェクトをカスタマイズした mlreportgen.dom.Text オブジェクトに置き換えます。既定または置き換えるテキスト オブジェクトにテキストを追加すると、生成されたレポートでソースの名前の前にそのテキストが表示されます。

生成されるソース システムの子孫のリストにマスク サブシステムを含めるかどうか。true または false として指定します。IncludeMaskedSubsystemstrue の場合、ソース サブシステムより下のレベル数が MaxDescendantLevel プロパティの値以下であれば、マスク サブシステムとその子孫のサブシステムがリストに含まれます。

システム階層レポーターでマスク サブシステムからレポート内の対応するブロック線図へのリンクを有効にするには、MaskedSystemLinkPolicy プロパティを 'system' に設定します。

生成されるソース システムの子孫のリストに参照モデルを含めるかどうか。true または false として指定します。IncludeReferencedModelstrue の場合、ソース サブシステムより下のレベル数が MaxDescendantLevel プロパティの値以下であれば、参照モデルとその子孫のサブシステムがリストに含まれます。

生成されるソース システムの子孫のリストに参照サブシステムを含めるかどうか。true または false として指定します。IncludeReferencedSubsystemstrue の場合、ソース サブシステムより下のレベル数が MaxDescendantLevel プロパティの値以下であれば、参照サブシステムとその子孫のサブシステムがリストに含まれます。

生成されるソース システムの子孫のリストに Simulink ライブラリ サブシステムにリンクするサブシステムを含めるかどうか。true または false として指定します。次のすべての条件を満たす場合のみ、リンクされたサブシステムまたはその子孫のいずれかのサブシステムがリストに含まれます。

  • IncludeSimulinkLibraryLinks の値が true である。

  • サブシステムがマスクされていない、サブシステムがマスクされている場合は IncludeMaskedSubsystems プロパティの値が true である。

  • ソース サブシステムより下のレベル数が MaxDescendantLevel プロパティの値以下である。

生成されるソース システムの子孫のリストにユーザー定義ライブラリ サブシステムにリンクするサブシステムを含めるかどうか。true または false として指定します。次のすべての条件を満たす場合のみ、リンクされたサブシステムまたはその子孫のいずれかのサブシステムがリストに含まれます。

  • IncludeUserLibraryLinks の値が true である。

  • サブシステムがマスクされていない、サブシステムがマスクされている場合は IncludeMaskedSubsystems プロパティの値が true である。

  • ソース サブシステムより下のレベル数が MaxDescendantLevel プロパティの値以下である。

生成されるソース システムの子孫のリストに含めるバリアント ブロックのバリアント。次の表のいずれかの値として指定します。値は string スカラーまたは文字ベクトルとして指定できます。

説明
"Active"アクティブなバリアント (既定)
"All"すべてのバリアント
"ActivePlusCode"アクティブなバリアントとコード バリアント

リストにバリアントが含まれるのは、ソース サブシステムより下のレベル数が MaxDescendantLevel プロパティの値以下である場合に限られます。

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

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

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

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

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

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

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

メソッド

すべて展開する

すべて折りたたむ

レポート生成プログラムに slreportgen.report.SystemHierarchy レポーターを追加して、slrgex_fuelsys モデルのシステム階層をレポートに含めます。slreportgen.finder.DiagramFinder オブジェクトを追加して、モデルのブロック線図を生成します。システム階層レポーターで、入れ子形式のリストのサブシステムから対応するブロック線図へのリンクを生成します。

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

openExample('rptgenext/SimulinkReportGeneratorFilesExample');
% Import the API packages
import slreportgen.report.*
import mlreportgen.report.*
import mlreportgen.dom.*

% Load the model
model = "slrgex_fuelsys";
load_system(model);

% Create a report
rpt = slreportgen.report.Report("output","pdf");

% Create a chapter reporter
chapter = Chapter("System Hierarchy for the " + model + " Model");

% Create a SystemHierarchy reporter for the model
rptr = SystemHierarchy(model);

% Add the SystemHierarchy reporter to the chapter.
% Add the chapter to the report
add(chapter, rptr);
add(rpt, chapter);

% Find the diagrams for the subsystems
finder = slreportgen.finder.DiagramFinder(model);
while hasNext(finder)
    result = next(finder);
    ch = Chapter(result.Name);
    add(ch, result);
    add(rpt, ch);
end

% Close and view the output report
close(rpt);
close_system(model);
rptview(rpt);

生成されるレポートに次のシステム階層が含まれます。

サブシステムに対応するブロック線図を表示するには、リストでサブシステムをクリックします。

バージョン履歴

R2019b で導入