Main Content

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

slreportgen.report.ElementDiagram クラス

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

要素のブロック線図のスナップショットと表題のレポーター

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

説明

Simulink® または Stateflow® の要素のブロック線図レポーターを作成します。レポートに追加された ElementDiagram レポーターは要素のスナップショットを作成します。レポーターは、スナップショットをイメージの形式で表題と共にレポートに追加します。Sourceプロパティを使用して目的の要素を指定します。

メモ

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

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

作成

説明

diagram = ElementDiagram は、空の要素ブロック線図レポーターを作成します。Simulink または Stateflow の要素のスナップショットを取得するように、そのプロパティを設定します。

例

diagram = ElementDiagram(source) は、source で指定されたブロック線図またはチャートの要素のブロック線図レポーターを作成します。このレポーターをレポートに追加すると、要素のブロック線図のスナップショットが作成され、そのスナップショットが表題と共にレポートに追加されます。スナップショット イメージ ファイルはレポートの一時フォルダーに格納されます。レポートを閉じると、イメージ ファイルがレポートにコピーされ、一時フォルダーは削除されます。削除されないようにするには、レポートの Debug プロパティを使用します。mlreportgen.report.Report を参照してください。

例

入力引数

すべて展開する

Source プロパティを参照してください。

プロパティ

すべて展開する

ブロック線図要素のソース。次の値のいずれかとして指定します。

  • Simulink ブロックまたは Stateflow チャート ブロックのパスを含む文字ベクトルまたは string スカラー

  • Simulink ブロックまたは Stateflow チャート ブロックのハンドル

  • Stateflow オブジェクト

  • ブロック、注釈、または Stateflow オブジェクトの Simulink 識別子 (SID)

  • slreportgen.finder.DiagramElementResult オブジェクト

メモ

Simulink.Port オブジェクトは、このレポーターの有効なソースではありません。

スナップショット レポーター。既定で mlreportgen.report.FormalImage クラスのオブジェクトに設定されます。このプロパティを手動で設定する必要はありません。FormalImage オブジェクトは、要素のブロック線図のスナップショットをレポートに追加します。スナップショットのサイズを制御するには、その mlreportgen.report.FormalImage プロパティを設定します。

スナップショット イメージの形式。文字ベクトルまたは string スカラーとして指定します。サポートされる形式は、次のとおりです。

  • 'bmp' — ビットマップ イメージ。

  • 'gif' — グラフィックス交換形式。

  • 'jpg' — JPEG イメージ。

  • 'png' — PNG イメージ。

  • 'emf' — 拡張メタファイル。Windows® プラットフォームの DOCX 出力でのみサポートされます。

  • 'svg' — Scalable Vector Graphics。

  • 'tiff' — タグ イメージのファイル形式。HTML 出力ではサポートされません。

  • 'pdf' — PDF イメージ。

バージョン履歴を参照してください。

ブロック線図要素イメージのスケーリングのオプション。string または文字ベクトルとして指定します。有効なスケーリング オプションは次のとおりです。

  • auto — PDF または Word (docx) 出力の場合、auto は、縦横比を維持しながらページに収まるように要素イメージをスケーリングします。まず、要素イメージは、ページ幅に合わせてスケーリングされます。イメージの高さがページの高さを超える場合、イメージは再度スケール ダウンされます。この追加のスケーリングで、イメージは 1 インチの余白を空けて現在のページに収まるようになります。この余白は表題用のスペースになります。スケーリングは HTML 出力には適用されません。

  • custom — 要素イメージの高さと幅を、このレポーターの Height プロパティと Width プロパティの値に設定します。

  • zoom — このレポーターの Zoom プロパティで指定されているパーセント値に要素イメージのサイズを拡大または縮小します。イメージの最大高さと最大幅を指定するには、MaxHeight プロパティと MaxWidth プロパティをそれぞれ使用します。

メモ

次のいずれかのプロパティ設定の組み合わせでは、java.lang.OutOfMemoryError が発生する可能性があります。

  • Scaling を zoom に設定し、かつ Zoom、MaxHeight、および MaxWidth プロパティを大きい値に設定する

  • Scaling を custom に設定し、かつ Height および Width プロパティを大きい値に設定する

このエラーを回避するには、ズームの Scaling には、より小さい Zoom、MaxHeight、および MaxWidth プロパティ値を使用します。カスタムの Scaling には、より小さい Height および Width プロパティ値を使用します。より小さい値を使用すると、ブロック線図がページに収まるようになります。

ブロック線図要素イメージの設定高さ。string として指定します。このプロパティは、このレポーターの Scaling プロパティが custom に設定されている場合にのみ適用されます。

Height の形式は valueUnits です。ここで、Units は高さの単位の略語で、value は単位の数です。次の表に Units の有効な略語を示します。

単位単位の略語
ピクセルpx
センチメートルcm
インチin
ミリメートルmm
パイカpc
ポイントpt

ブロック線図要素イメージの設定幅。string として指定します。このプロパティは、このレポーターの Scaling プロパティが custom に設定されている場合にのみ適用されます。

Width の形式は valueUnits です。ここで、Units は高さの単位の略語で、value は単位の数です。Units の有効な略語の表については、Height プロパティを参照してください。

ブロック線図要素イメージのズーム量。string として指定します。Zoom の形式は value% です。ここで、value はブロック線図要素イメージが拡大または縮小されるパーセントです。

ズーム スケーリングの最大高さ。string として指定します。このプロパティは、このレポーターの Scaling プロパティが zoom に設定されている場合にのみ適用されます。MaxHeight の形式は valueUnits です。ここで、Units は高さの単位の略語で、value は単位の数です。Units の有効な略語の表については、このレポーターの Height プロパティを参照してください。

ズーム スケーリングの最大幅。string として指定します。このプロパティは、このレポーターの Scaling プロパティが zoom に設定されている場合にのみ適用されます。MaxWidth の形式は valueUnits です。ここで、Units は高さの単位の略語で、value は単位の数です。Units の有効な略語の表については、このレポーターの Height プロパティを参照してください。

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

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

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

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

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

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

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

メソッド

すべて展開する

例

すべて折りたたむ

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

openExample('f14')

rpt = slreportgen.report.Report("output","pdf");
open(rpt)
chap = Chapter();
chap.Title = "Element Diagram Reporter Example";

diag = ElementDiagram("f14/Actuator Model");
diag.Snapshot.Caption = "f14 Simulink Model - Actuator Model block";

add(chap,diag)
add(rpt,chap)

close(rpt)
rptview(rpt)

openExample('f14')
modelsys = "f14/Aircraft Dynamics Model";

rpt = slreportgen.report.Report("output","pdf");
open(rpt)
chapter = mlreportgen.report.Chapter();
chapter.Title = "Element Snapshots";

diag = slreportgen.report.ElementDiagram(modelsys);
add (chapter,diag)

blkfinder = slreportgen.finder.BlockFinder(modelsys);
blks = find(blkfinder);
for blk = blks
   blkDiag = slreportgen.report.ElementDiagram...
       (blk.Object);
   blkDiag.Snapshot.Caption = strcat(blk.DiagramPath,...
       "/", blk.Name);
   add(chapter,blkDiag)   % Add diagram element image
   add(chapter,blk)       % Add property table
end

add(rpt,chapter)
close(rpt)
rptview(rpt)

バージョン履歴

R2018b で導入

すべて展開する

参考

| | | | |

トピック