slreportgen.report.Notes クラス

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

Simulink または Stateflow のブロック線図メモ レポーター

このページをすべて展開する

説明

Simulink® または Stateflow® のブロック線図メモについてレポートするレポーターを作成します。モデルのメモの詳細については、Write In-Model Documentation Using Notesを参照してください。

メモ

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

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

クラス属性

HandleCompatible
true

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

作成

説明

notes = slreportgen.report.Notes は、空の slreportgen.report.Notes レポーターを作成します。

notes = slreportgen.report.Notes(source) は source で指定されたシステムの slreportgen.report.Notes レポーターを作成し、Source プロパティを source に設定します。

例

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

プロパティ

すべて展開する

メモを抽出するソース。string スカラー、文字ベクトル、ハンドル、または slreportgen.finder.DiagramResult オブジェクトとして指定します。ソースには、モデル、サブシステム、Stateflow チャート、Stateflow 真理値表、または Stateflow 状態遷移表を指定できます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true
Dependent
true

メモのタイプ。次の表のいずれかの値として指定します。

値説明
"Internal"メモの内容はモデルに含まれて、.mldatx ファイルに保存されます。
"External"メモの内容はモデルの外部にあり、URL で指定されます。
"Inherited"メモの内容は、指定されたブロック線図ソースの先祖から派生します。
"None"ブロック線図にメモはありません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true
Dependent
true

データ型: char | string

NoteType が "Inherit" のメモについてレポートするかどうか。logical の 1 (true) または 0 (false) として指定します。指定に関する詳細は次の通りです。

  • 1 (true) — NoteType が "Inherit" のメモについてレポートします。

  • 0 (false) — NoteType が "Inherit" のメモを省略します。

レポートされるメモの内容は親のメモの NoteType プロパティに基づきます。

値説明
"Internal"親のメモ内容へのリンク。
"External"

親のメモで指定された外部の内容へのリンク。

"None"空のコンテンツ。

属性:

GetAccess
public
SetAccess
public

データ型: logical

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

  • このレポーターのテンプレートを含むファイルのパスを指定する、文字ベクトルまたは 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

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

この例では、sldemo_autotrans モデルのメモをレポートします。この例では、モデル全体のメモをレポートします。モデルの各サブシステムのブロック線図とメモをレポートする例については、モデルのメモのレポートを参照してください。

この例では、メモの章を作成し、その章に slreportgen.report.Notes レポーターを追加することで、章にモデルのメモを含めます。

model = "sldemo_autotrans";
open_system(model);

import mlreportgen.report.*
import slreportgen.report.*

rpt = slreportgen.report.Report(model + "_Notes_Report","pdf");
open(rpt);

ch = Chapter(Title=(model+" Notes"));
notes = Notes(model);
add(ch,notes);
add(rpt,ch);

close(rpt);
rptview(rpt);

ヒント

バージョン履歴

R2020a で導入

参考

| | | |

トピック