slreportgen.finder.SignalResult クラス

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

信号の検索結果オブジェクト

R2021a 以降

説明

slreportgen.finder.SignalResult クラスのオブジェクトは、モデルまたはブロックで使用される信号の検索の結果を表します。SignalResult オブジェクトはレポートに直接追加できます。あるいは、getReporter メソッドを使用して結果の slreportgen.report.Signal レポーターにアクセスし、レポーターをカスタマイズしてレポートに追加できます。

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

クラス属性

HandleCompatible

true

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

作成

slreportgen.finder.SignalResult オブジェクトは、明示的に作成しません。slreportgen.finder.SignalFinder の find メソッドと next メソッドは、検出した信号ごとに slreportgen.finder.SignalResult オブジェクトを作成します。

プロパティ

パブリック プロパティ

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

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

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

属性:

NonCopyable

true

データ型: any

保護プロパティ

Object — ブロック出力端子

ハンドル

検出した信号を表すブロック出力端子。ハンドルとして指定します。このプロパティは読み取り専用です。

Name — 検出した信号の名前

string スカラー

検出した信号の名前。string スカラーとして指定します。このプロパティは読み取り専用です。

Source block — 信号の接続元ブロックの名前

string スカラー

検出した信号の接続元であるブロックの名前。string スカラーとして指定します。このプロパティは読み取り専用です。

SourcePortNumber — 出力端子の番号

double

検出した信号を表す出力端子の番号。整数として指定します。このプロパティは読み取り専用です。

RelatedObject — この信号を使用するモデルまたはブロックの名前

string スカラー

この信号を使用するモデルまたはブロックの名前。string スカラーとして指定します。このプロパティの値は、この信号の検出に使用された slreportgen.finder.SignalFinder オブジェクトの Container プロパティの値に対応します。このプロパティは読み取り専用です。

Relationship — 信号とコンテナー モデルまたはブロックの関係

"Input" | "Output" | "Internal" | "Control" | "State"

検出した信号とコンテナー モデルまたはブロックの関係。"Input"、"Output"、"Internal"、"Control"、または "State" として指定します。コンテナー モデルまたはブロックは、RelatedObject プロパティで指定されます。

メソッド

パブリック メソッド

getDefaultSummaryProperties	propList = getDefaultSummaryProperties(signalResult,TypeSpecificProperties) は、概要テーブルに既定で含まれるファインダー結果クラス プロパティのリストを返します。
getDefaultSummaryTableTitle	tableTitle = getDefaultSummaryTableTitle(signalResult,TypeSpecificTitle) は、resultObject タイプのファインダー結果オブジェクトの概要テーブルについて既定のタイトルを返します。
getDestinationPorts	ports = getDestinationPorts(signalResult) は、signalResult によって表される信号に接続されている入力端子または制御端子のハンドルを返します。返される端子は、信号のグラフィカルな接続先です。バーチャル ブロックと非バーチャル ブロックのどちらにも属することができます。
getVirtualDestinationPorts	ports = getVirtualDestinationPorts(signalResult) は、signalResult によって表される信号に接続されている入力端子または制御端子のハンドルを返します。返される端子は、信号の非バーチャルな接続先です。非バーチャル ブロックにのみ属することができます。たとえば、exampleModel 内のブロックからの信号出力がバーチャル サブシステム Sub1 内にあるブロック Gain1 に接続されている場合、このメソッドは exampleModel/Sub1/Gain1 への入力端子を返します。
getPropertyValues	propVals = getPropertyValues(signalResult,propNames) は、propNames に指定されたプロパティの値を cell 配列に返します。propNames に必要なプロパティ名を指定することにより、結果オブジェクトのプロパティ、またはファインダー結果オブジェクトによって表される信号のプロパティにアクセスします。
getReporter	reporter = getReporter(signalResult) は、signalResult によって表される信号の slreportgen.report.Signal レポーター オブジェクトを返します。レポーターを使用して、レポートされる情報と情報の書式設定をカスタマイズします。
getReporterLinkTargetID	targetID = getReporterLinkTargetID(signalResult) は、ファインダー結果オブジェクトに関連付けられたレポーターのリンク ターゲット ID を返します。このリンク ターゲット ID は、レポートの任意の部分からレポーターへのハイパーリンクを追加するために使用します。

例

信号の結果に関するレポーターのカスタマイズ

slreportgen.finder.SignalResult オブジェクトの getReporter メソッドを使用して、結果の信号レポーターにアクセスします。次に、プロパティを設定することでレポーターをカスタマイズします。

長い完全修飾クラス名を使用せずに済むように、MATLAB レポートおよび Simulink レポートの API パッケージをインポートします。

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

Simulink レポートを作成します。

rpt = slreportgen.report.Report("MySignalReport","pdf");

信号情報の章を作成します。

chapter = mlreportgen.report.Chapter();
chapter.Title = "Signals";

モデルを読み込みます。

model_name = "slrgex_vdp";
load_system(model_name);

信号ファインダーを作成します。

finder = slreportgen.finder.SignalFinder(model_name);

信号を検索します。検出した信号ごとにレポーターを取得し、空のプロパティ値をレポートするように指定して、レポーターを章に追加します。

while hasNext(finder)
    result = next(finder);
    
    reporter = getReporter(result);
    reporter.ShowEmptyValues = true;
 
    add(chapter,reporter);
end

章をレポートに追加します。

add(rpt,chapter);

レポートを閉じて表示します。

close(rpt);
rptview(rpt);

バージョン履歴

R2021a で導入

参考

slreportgen.finder.SignalFinder | slreportgen.report.Signal

トピック

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