Main Content

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.SignalFinderfind メソッドと next メソッドは、検出した信号ごとに slreportgen.finder.SignalResult オブジェクトを作成します。

プロパティ

すべて展開する

パブリック プロパティ

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

属性:

NonCopyable
true

データ型: any

保護プロパティ

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

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

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

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

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

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

メソッド

すべて展開する

すべて折りたたむ

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 で導入