slreportgen.finder.BlockResult クラス

名前空間: slreportgen.finder
スーパークラス: slreportgen.finder.DiagramElementResult

ブロック ファインダーの結果オブジェクトを作成する

説明

Simulink^® ブロック線図内のブロックの検索結果オブジェクト。

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

作成

説明

result = BlockResult(block) は、BlockFinder によって検出された block の検索結果オブジェクトを作成します。result オブジェクトには Simulink ブロックが含まれます。

メモ

検索メソッド simulink.finder.BlockFinder は、検出したブロックごとにこのタイプのオブジェクトを作成します。このオブジェクトを手動で作成する必要はありません。

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

入力引数

block — Simulink ブロックまたは Stateflow^® ブロック

ブロック パス | ブロック ハンドル

Simulink ブロック。そのブロック パスまたはブロック ハンドルとして指定します。

プロパティ

パブリック プロパティ

Tag — 追加のユーザー定義情報

[] (既定値) | string スカラー | 文字ベクトル | オブジェクト | ...

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

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

保護プロパティ

Object — ブロック ハンドル

ハンドル

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

Name — ブロック名

string

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

Type — ブロック タイプ

string

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

例: "Gain"

BlockPath — ブロックのパス

string

この読み取り専用プロパティは、モデル内のブロックのパスを返します。

DiagramPath — 親ブロック線図のパス

string

この読み取り専用プロパティは、そのブロックを含むモデルまたはサブシステムのパスを返します。

メソッド

パブリック メソッド

getPropertyValues	propVals = getPropertyValues(resultObject,propNames) は、propNames に指定されたプロパティの値を cell 配列に返します。propNames に必要なプロパティ名を指定することにより、結果オブジェクトのプロパティ、またはファインダー結果オブジェクトによって表されるブロックのプロパティにアクセスします。
getDefaultSummaryProperties	propList = getDefaultSummaryProperties(resultObject,TypeSpecificProperties) は、概要テーブルに既定で含まれるファインダー結果クラス プロパティのリストを返します。
getDefaultSummaryTableTitle	tableTitle = getDefaultSummaryTableTitle(resultObject,TypeSpecificTitle) は、resultObject タイプのファインダー結果オブジェクトの概要テーブルについて既定のタイトルを返します。
getReporterLinkTargetID	targetID = getReporterLinkTargetID(resultObject) は、ファインダー結果オブジェクトに関連付けられたレポーターのリンク ターゲット ID を返します。このリンク ターゲット ID は、レポートの任意の部分からレポーターへのハイパーリンクを追加するために使用します。

バージョン履歴

R2017b で導入

参考

slreportgen.finder.BlockFinder | slreportgen.report.Report

トピック

• Simulink および Stateflow 要素用の Report Generator の作成
• レポーターとは