このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
slreportgen.report.SystemHierarchy クラス
名前空間: slreportgen.report
スーパークラス: slreportgen.report.Reporter
説明
Simulink® のモデルまたはサブシステムについて、サブシステムの入れ子形式のリストをレポートで生成するシステム階層レポーターを作成します。
メモ
レポートでシステム階層レポーターを使用するには、slreportgen.report.Report
クラスまたはサブクラスを使用してレポートを作成する必要があります。
slreportgen.report.SystemHierarchy
クラスは handle
クラスです。
作成
説明
rptr = slreportgen.report.SystemHierarchy()
は、既定のテンプレートに基づいて空のシステム階層レポーターを作成します。レポーターのプロパティを使用して、生成されるリストの内容や形式をカスタマイズします。レポーターをレポートに追加する前に、レポーターの Source プロパティでモデルまたはサブシステムを指定する必要があります。空のレポーターをレポートに追加すると、エラーが発生します。
rptr = slreportgen.report.SystemHierarchy(
は、source
)source
で指定されたモデルまたはサブシステムのシステム階層レポーターを作成します。Source プロパティを参照してください。
は、名前と値のペアを使用してレポーター プロパティを設定します。複数の名前と値のペアの引数を任意の順序で指定できます。rptr
= slreportgen.report.SystemHierarchy(Name=Value
)
プロパティ
Source
— Simulink モデルまたはサブシステム
[]
(既定値) | string スカラー | 文字ベクトル | ハンドル
Simulink モデルまたはサブシステム。モデルまたはサブシステムのパスを含む string スカラーまたは文字ベクトルとして指定するか、モデルまたはサブシステムのハンドルとして指定します。
MaxAncestorLevel
— 先祖を含める最大レベル数
Inf
(既定値) | 非負の整数スカラー
生成されるリストにソース サブシステムの先祖を含める最大レベル数。非負の整数スカラーとして指定します。たとえば、MaxAncestorLevel
が 2
の場合、ソースと 2 レベルまでの先祖がリストに含まれます。MaxAncestorLevel
が既定値の Inf
の場合、すべての先祖がリストに含まれます。MaxAncestorLevel
がゼロの場合、リストに先祖は含まれません。
MaxDescendantLevel
— 子孫を含める最大レベル数
Inf
(既定値) | 非負の整数スカラー
生成されるリストにソース モデルまたはサブシステムの子孫を含める最大レベル数。非負の整数スカラーとして指定します。たとえば、MaxDescendantLevel
が 2
の場合、ソースと 2 レベルまでの子孫がリストに含まれます。MaxDescendantLevel
が既定値の Inf
の場合、すべての子孫がリストに含まれます。MaxDescendantLevel
がゼロの場合、リストに子孫は含まれません。
IncludePeers
— サブシステムのピアを含めるかどうか
true
(既定値) | false
生成されるリストにソース サブシステムのピアを含めるかどうか。true
または false
として指定します。
EmphasizeSource
— ソースを強調するかどうか
true
(既定値) | false
生成されるリストでソース モデルまたはサブシステムを強調するかどうか。true
または false
として指定します。EmphasizeSource
が true
の場合、ソース モデルまたはサブシステムの名前が TextFormatter
プロパティに従った形式で示されます。それ以外の場合、リストの他の項目と同様の形式になります。
ListFormatter
— リスト フォーマッタ
mlreportgen.dom.UnorderedList
(既定値) | mlreportgen.dom.OrderedList
生成されるリストの形式を設定するリスト フォーマッタ。mlreportgen.dom.UnorderedList
オブジェクトまたは mlreportgen.dom.OrderedList
オブジェクトとして指定します。このプロパティの既定値は、mlreportgen.dom.UnorderedList
のオブジェクトです。リストの形式をカスタマイズするには、リスト オブジェクトのプロパティを変更するか、そのリスト オブジェクトをリスト項目を含まないカスタマイズしたリスト オブジェクトに置き換えます。
SourceTextFormatter
— ソースの名前を強調表示するためのテキスト フォーマッタ
mlreportgen.dom.Text
生成されるリストでのソース モデルまたはサブシステムの名前の形式を設定するテキスト フォーマッタ オブジェクト。mlreportgen.dom.Text
オブジェクトとして指定します。このプロパティは、EmphasizeSource
プロパティが true
の場合のみ適用されます。SourceTextFormatter
プロパティの初期値は、Bold
プロパティと Italic
プロパティが true
に設定された mlreportgen.dom.Text
オブジェクトです。生成されるリストでの名前の外観をカスタマイズするには、mlreportgen.dom.Text
オブジェクトのプロパティを変更するか、そのオブジェクトをカスタマイズした mlreportgen.dom.Text
オブジェクトに置き換えます。既定または置き換えるテキスト オブジェクトにテキストを追加すると、生成されたレポートでソースの名前の前にそのテキストが表示されます。
IncludeMaskedSubsystems
— マスク サブシステムを含めるかどうか
false
(既定値) | true
生成されるソース システムの子孫のリストにマスク サブシステムを含めるかどうか。true
または false
として指定します。IncludeMaskedSubsystems
が true
の場合、ソース サブシステムより下のレベル数が MaxDescendantLevel
プロパティの値以下であれば、マスク サブシステムとその子孫のサブシステムがリストに含まれます。
システム階層レポーターでマスク サブシステムからレポート内の対応するブロック線図へのリンクを有効にするには、MaskedSystemLinkPolicy
プロパティを 'system'
に設定します。
IncludeReferencedModels
— 参照モデルを含めるかどうか
true
(既定値) | false
生成されるソース システムの子孫のリストに参照モデルを含めるかどうか。true
または false
として指定します。IncludeReferencedModels
が true
の場合、ソース サブシステムより下のレベル数が MaxDescendantLevel
プロパティの値以下であれば、参照モデルとその子孫のサブシステムがリストに含まれます。
IncludeReferencedSubsystems
— 参照サブシステムを含めるかどうか
true
または 1
(既定値) | false
または 0
生成されるソース システムの子孫のリストに参照サブシステムを含めるかどうか。true
または false
として指定します。IncludeReferencedSubsystems
が true
の場合、ソース サブシステムより下のレベル数が MaxDescendantLevel
プロパティの値以下であれば、参照サブシステムとその子孫のサブシステムがリストに含まれます。
IncludeSimulinkLibraryLinks
— Simulink ライブラリ リンクを含めるかどうか
true
(既定値) | false
生成されるソース システムの子孫のリストに Simulink ライブラリ サブシステムにリンクするサブシステムを含めるかどうか。true
または false
として指定します。次のすべての条件を満たす場合のみ、リンクされたサブシステムまたはその子孫のいずれかのサブシステムがリストに含まれます。
IncludeSimulinkLibraryLinks
の値がtrue
である。サブシステムがマスクされていない、サブシステムがマスクされている場合は
IncludeMaskedSubsystems
プロパティの値がtrue
である。ソース サブシステムより下のレベル数が
MaxDescendantLevel
プロパティの値以下である。
IncludeUserLibraryLinks
— ユーザー定義ライブラリへのライブラリ リンクを含めるかどうか
true
(既定値) | false
生成されるソース システムの子孫のリストにユーザー定義ライブラリ サブシステムにリンクするサブシステムを含めるかどうか。true
または false
として指定します。次のすべての条件を満たす場合のみ、リンクされたサブシステムまたはその子孫のいずれかのサブシステムがリストに含まれます。
IncludeUserLibraryLinks
の値がtrue
である。サブシステムがマスクされていない、サブシステムがマスクされている場合は
IncludeMaskedSubsystems
プロパティの値がtrue
である。ソース サブシステムより下のレベル数が
MaxDescendantLevel
プロパティの値以下である。
IncludeVariants
— 含めるバリアント
"Active"
(既定値) | "All"
| "ActivePlusCode"
生成されるソース システムの子孫のリストに含めるバリアント ブロックのバリアント。次の表のいずれかの値として指定します。値は string スカラーまたは文字ベクトルとして指定できます。
値 | 説明 |
---|---|
"Active" | アクティブなバリアント (既定) |
"All" | すべてのバリアント |
"ActivePlusCode" | アクティブなバリアントとコード バリアント |
リストにバリアントが含まれるのは、ソース サブシステムより下のレベル数が MaxDescendantLevel
プロパティの値以下である場合に限られます。
TemplateSrc
— このレポーターのテンプレートのソース
[]
(既定値) | 文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメント パーツ
このレポーターのテンプレートのソース。次のいずれかのオプションとして指定します。
このレポーターのテンプレートを含むファイルのパスを指定する、文字ベクトルまたは string スカラー
このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、レポーターまたはレポート
このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、DOM ドキュメントまたはドキュメント パーツ
指定されるテンプレートは、このレポーターが追加されるレポートと同じタイプでなければなりません。たとえば、Microsoft® Word レポートの場合、TemplateSrc
は Word レポーター テンプレートでなければなりません。TemplateSrc
プロパティが空の場合、このレポーターはレポートの出力タイプで既定のレポーター テンプレートを使用します。
TemplateName
— このレポーターのテンプレートの名前
文字ベクトル | string スカラー
このレポーターのテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーターのテンプレートは、このレポーターのテンプレート ソース (TemplateSrc
) のテンプレート ライブラリになければなりません。
LinkTarget
— このレポーターのハイパーリンク ターゲット
[]
(既定値) | 文字ベクトル | string スカラー | mlreportgen.dom.LinkTarget
オブジェクト
このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルまたは string スカラー、あるいは mlreportgen.dom.LinkTarget
オブジェクトとして指定します。文字ベクトルまたは string スカラーの値は LinkTarget
オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前に配置されます。
メソッド
パブリック メソッド
slreportgen.report.SystemHierarchy.createTemplate | Create system hierarchy reporter template |
slreportgen.report.SystemHierarchy.customizeReporter | Create custom system hierarchy reporter class |
slreportgen.report.SystemHierarchy.getClassFolder | Get location of system hierarchy reporter class definition file |
copy | Create copy of a Simulink reporter object and make deep copies of certain property values |
getImpl | レポーターの実装を取得する |
例
モデルのシステム階層をレポートに含める
レポート生成プログラムに 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 で導入
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)