Main Content

slreportgen.webview.WebViewDocument クラス

パッケージ: slreportgen.webview

Web ビュー ドキュメント ジェネレーターの作成

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

説明

1 つ以上の Simulink® モデルの Web ビューを含む HTML ドキュメントを生成するドキュメント ジェネレーターを作成します。

slreportgen.webview.WebViewDocument クラスは handle クラスです。

作成

説明

wvdocgen = slreportgen.webview.WebViewDocument(docname,model) は、指定されたモデルの Web ビューを含む HTML ドキュメントを指定された場所に生成するドキュメント ジェネレーターを作成します。ジェネレーターの fill メソッドを使用してドキュメントを生成します。

例

wvdocgen = slreportgen.webview.WebViewDocument(docname,model1,model2,...modeln) は、2 つ以上のモデルが含まれる Web ビューを作成するドキュメント ジェネレーターを作成します。このコンストラクターは、既定の slreportgen.webview.ExportOptions オブジェクトの配列をジェネレーターの ExportOptions プロパティに割り当て、生成されるドキュメントの Web ビューに各モデルを 1 つ含めます。オブジェクトを使用して、エクスポートするモデルにカスタム エクスポート オプションを指定することができます。

wvdocgen = slreportgen.webview.WebViewDocument(docname,{model1,model2,...modeln}) は、既定の slreportgen.webview.ExportOptions オブジェクトをジェネレーターの ExportOptions プロパティに割り当てます。これは、エクスポートするすべてのモデルに適用されます。

wvdocgen = slreportgen.webview.WebViewDocument(docname) は、初期状態ではモデルまたはモデルの集合が未指定の Web ビュー ドキュメント ジェネレーターを作成します。ジェネレーターの ExportOptions プロパティの Systems プロパティを使用して、このジェネレーターが生成する Web ビューに含めるモデルを指定します。

入力引数

すべて展開する

このジェネレーターによって生成されたレポートを含む zip ファイル、フォルダー、またはそれら両方の名前。このジェネレーターの PackageType プロパティは、生成されるレポートをファイル、フォルダー、またはそれら両方としてパッケージ化するかどうかを指定するために使用します。拡張子を指定する場合は、拡張子を .htmx にしなければなりません。拡張子を指定しない場合は、Report Generator によって .htmx が付加されます。

対話型 HTML Web ビューにエクスポートする Simulink モデルの名前。文字ベクトルとして指定します。

プロパティ

すべて展開する

ドキュメント内の現在のホールの識別子。これは読み取り専用プロパティです。

slreportgen.webview.ExportOptions オブジェクトの配列。エクスポートするモデルごと、またはモデルの集合ごとに 1 つ指定します。ジェネレーターのコンストラクターは、指定したモデルの既定値を使用してこのプロパティを設定します。生成される Web ビューへのモデルのエクスポートをカスタマイズするには、ExportOptions オブジェクトのプロパティを使用します。たとえば、マスク サブシステムとライブラリ ブロックのブロック線図を含めるため、または含めるかどうかを指定するために追加のモデルを指定できます。

ユーザー メモを含めるかどうか。数値か logical の 0 (false) または 1 (true) として指定します。

データ型: logical

同じ名前の既存のレポートを上書きするかどうかを指定します。True は既存のレポートを上書きします。False は新しい名前でレポートを生成します。

ドキュメントの出力ディレクトリのパス。

出力ドキュメントに使用するパッケージ化。次の文字ベクトルのいずれかで指定します。

  • 'zipped' — .htmx 拡張子をもつ zip ファイルを作成

  • 'unzipped' — ファイルのフォルダーを作成

  • 'both' — 圧縮および解凍された出力の両方を作成

このレポートの生成に使用する HTML テンプレートへのパス。テンプレートには .htmtx 拡張子が付いています。既定では、このプロパティは既定のテンプレートを指します。カスタム テンプレートを使用するには、このプロパティをカスタム テンプレートのパスに設定します。

生成された Web ビュー ドキュメントを表示する HTML ブラウザーのタイトル バーに表示するテキスト。既定のテキストは、"Simulink の Web ビュー - Simulink Report Generator で作成" です。

メソッド

すべて展開する

例

すべて折りたたむ

import slreportgen.webview.*
open_system('f14')
d = WebViewDocument('f14WebView', 'f14');
fill(d);
rptview(d);

この例のエクスポート オプションを使用して、f14 モデル内に Simulink ライブラリ ブロックの Band-Limited White Noise を実装するサブシステムを表示し、slrgex_sf_car モデル内に Engine ブロックを実装する Stateflow® チャートを表示できます。この例でエクスポート オプションを有効にしていない場合、サブシステムとチャートは、エクスポートされた Web ビュー内で単にブロックとして表示されます。

import slreportgen.webview.*
open_system('f14');
open_system('slrgex_sf_car');
wvdoc = WebViewDocument(...
    'myWebview','f14','slrgex_sf_car'); 
opts = wvdoc.ExportOptions;
 
f14Opts = opts(1);
f14Opts.IncludeMaskedSubsystems = true; 
f14Opts.IncludeSimulinkLibraryLinks = true;

sfcarOpts = opts(2);
sfcarOpts.IncludeMaskedSubsystems = true; 

fill(wvdoc)
rptview(wvdoc);

この例では、f14 のルート システムと Aircraft Dynamics Model サブシステムをエクスポートします。

import slreportgen.webview.*
open_system('f14');
wvdoc = WebViewDocument('myWebView', ...
    {'f14', 'f14/Aircraft Dynamics Model'});
wvdoc.ExportOptions.SearchScope = 'Current';
fill(wvdoc)
rptview(wvdoc);

この例では、f14 のルート システムと Controller サブシステムをエクスポートします。

import slreportgen.webview.*
open_system('f14');
wvdoc = WebViewDocument(...
    'mydoc', 'f14/Controller');
wvdoc.ExportOptions.SearchScope = 'CurrentAndAbove';
fill(wvdoc)
rptview(wvdoc);

バージョン履歴

R2017a で導入

参考

|