Main Content

slreportgen.report.Notes クラス

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

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

R2020a 以降

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

説明

Simulink® または Stateflow® のブロック線図メモについてレポートするレポーターを作成します。

メモ

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

プロパティ

すべて展開する

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

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

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

このプロパティは読み取り専用です。

NoteType が 'Inherit' のメモについてレポートするかどうか。true または false として指定します。次の表に示すように、レポートされるメモの内容は親のメモ タイプに基づきます。

親のメモ タイプレポートされるメモの内容
'Internal'親のメモ内容へのリンク
'External'親のメモで指定された外部の内容へのリンク
'None'空のコンテンツ

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

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

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

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

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

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

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

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

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

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

model = "slreportgendemo_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 で導入

参考

| |

トピック