メインコンテンツ

slreportgen.finder.DiagramElementResult クラス

R2026b

名前空間: slreportgen.finder

ブロック線図要素ファインダー結果オブジェクトの作成

説明

Simulink® ブロック線図または Stateflow® ブロック線図内の要素のブロック線図要素検索結果オブジェクト。

DiagramElementResult オブジェクトをレポートまたはレポーターに追加すると、オブジェクトはその getReporter メソッドを使用して要素のプロパティ テーブルを生成します。要素に Subsystem ブロックや Stateflow チャートなどのブロック線図が含まれる場合、getDiagramReporter メソッドを使用して、そのブロック線図のスナップショットを生成するレポーターを取得します。

slreportgen.finder.DiagramElementResult クラスは handle クラスです。

クラス属性

HandleCompatible
true

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

作成

説明

result = DiagramElementResult(elem) は、ブロック線図要素の検索結果オブジェクトを作成します。result オブジェクトには、指定された Simulink ブロック線図または Stateflow ブロック線図の要素が含まれます。

メモ

ブロック線図要素ファインダーの検索メソッドは、この slreportgen.finder.DiagramElementResult オブジェクトのインスタンスを作成して返します。インスタンスを手動で作成する必要はありません。

例

finder = DiagramElementResult(PropertyName=Value) は、名前と値の引数を使用してプロパティを設定します。複数の名前と値の引数を任意の順序で指定できます。

入力引数

すべて展開する

Simulink ブロック線図または Stateflow ブロック線図の要素。要素へのパスまたはハンドルとして指定します。

プロパティ

すべて展開する

パブリック プロパティ

この結果に加える追加のユーザー定義情報。任意の値として指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

保護プロパティ

この読み取り専用プロパティには、この結果で返されるブロック線図要素のハンドルが含まれています。

この読み取り専用プロパティは、この結果で返されるブロック線図要素の名前を指定します。

この読み取り専用プロパティは、この結果で返されるブロック線図要素のタイプを指定します。

例: "Simulink.BlockDiagram"

この読み取り専用プロパティは、この結果で返される要素を含むブロック線図のパスを返します。

メソッド

すべて展開する

例

すべて折りたたむ

sf_car モデル内で Simulink Function サブシステムを検索します。各 slreportgen.finder.DiagramElementResult オブジェクトについて、getDiagramReporter メソッドを呼び出して、サブシステムのブロック線図を取得し、レポートに追加します。

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

model = "sf_car";
openExample(model)

rpt = slreportgen.report.Report("output","pdf");
chapter = Chapter();
chapter.Title = "Diagram Element Result Example";

モデル内でブロック線図を検索します。

diagFinder = DiagramFinder(model);
diagrams = find(diagFinder);
for diag = diagrams

現在のブロック線図内の Simulink Function サブシステムを検索します。

    elemFinder = DiagramElementFinder(diag);
    elemFinder.Types = "slfunction";
    elems = find(elemFinder);
    for elem = elems
        section = ...
            Section(Title=mlreportgen.utils.normalizeString(elem.Name));

結果からブロック線図レポーターを取得し、セクションに追加します。

        rptr = getDiagramReporter(elem);
        if ~isempty(rptr)
            add(section,rptr)
        end
        add(section,elem);
        add(chapter,section);
    end
end

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

Report chapter showing the snapshot and property table of the Simulink Function subsystems in the sf_car model.

バージョン履歴

R2017b で導入