slreportgen.report.SummaryTable クラス

名前空間: slreportgen.report

ファインダーの結果の概要テーブル レポーター

R2022a 以降

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

説明

slreportgen.report.SummaryTable クラスのオブジェクトを使用して、ファインダー オブジェクトを使用して Simulink® モデルから取得した検索結果の概要を示します。

メモ

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

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

クラス属性

HandleCompatible
true

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

作成

説明

summaryTableRptr = slreportgen.report.SummaryTable は、ファインダーの結果が未指定の集合について概要テーブルを作成します。

メモ

結果が未指定の Simulink 概要テーブル レポーターをレポートに追加するとエラーになります。

summaryTableRptr = slreportgen.report.SummaryTable(finderResults) は、配列 finderResults のファインダー結果オブジェクトについての概要テーブル レポーターを作成し、FinderResults プロパティを finderResults に設定します。

概要テーブルには、検出されたオブジェクトのプロパティをエントリに含む結果ごとに 1 つの行が含まれます。既定では、結果オブジェクトのタイプによってレポート対象のプロパティが決まります。レポートするプロパティの集合をカスタマイズするには、概要テーブル レポーターの Properties プロパティを使用します。

例

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

プロパティ

すべて展開する

レポート対象のファインダー結果オブジェクト。slreportgen.report.FunctionReferenceResult や slreportgen.report.SignalResult などのファインダー結果クラスのオブジェクトの配列として指定します。

属性:

GetAccess
public
SetAccess
public

概要テーブルのタイトル。string、文字ベクトル、または DOM オブジェクトとして指定します。既定では、このプロパティは空であり、レポーターは finderResults で指定されたファインダー結果オブジェクトの getDefaultSummaryTableTitle メソッドを使用してテーブルのタイトルを作成します。

このプロパティを文字ベクトルまたは string スカラーとして指定すると、生成されるレポートで Style プロパティが 'SummaryTableTitleParagraph' に設定された mlreportgen.dom.Paragraph オブジェクトが作成されます。

属性:

GetAccess
public
SetAccess
public

結果クラスのレポート対象のプロパティ。string スカラーの配列または文字ベクトルの cell 配列として指定します。

このプロパティが空の場合、レポーターは finderResults で指定されたファインダー結果オブジェクトの getDefaultSummaryProperties メソッドを使用して、結果オブジェクトのどのプロパティをレポートするかを決定します。

概要テーブルに追加できるプロパティを識別するには、finderResults で指定されたファインダー結果オブジェクトの getPropertyValues メソッドを使用します。

属性:

GetAccess
public
SetAccess
public

ファインダー結果オブジェクトの概要テーブルを結果オブジェクトの Type プロパティに基づいて分けて作成するかどうか。true または false として指定します。

属性:

GetAccess
public
SetAccess
public

概要テーブルの各オブジェクトの Name プロパティを対応するレポーター オブジェクトにリンクするかどうか。true または false として指定します。

属性:

GetAccess
public
SetAccess
public

ファインダー結果オブジェクトのプロパティが空の列を概要テーブルに含めるかどうか。false または true として指定します。

属性:

GetAccess
public
SetAccess
public

テーブル レポーターのフォーマッタのタイプ。mlreportgen.report.BaseTable オブジェクトとして指定します。このプロパティの既定値は、TableStyleName プロパティが FunctionReferenceTable スタイルに設定された BaseTable オブジェクトであり、これは FunctionReference レポーターの既定のテンプレートに定義されています。

概要テーブルの外観をカスタマイズするには、既定のレポーターをカスタマイズするか、そのレポーターをカスタマイズした BaseTable レポーターに置き換えます。

属性:

GetAccess
public
SetAccess
public

メソッド

すべて展開する

例

すべて折りたたむ

この例では次を使用します。

ライブ スクリプトを開く

この例では、Simulink® モデル内の名前付きの信号を表すファインダー結果についての概要テーブルをレポートに追加する方法を示します。

PDF レポートを作成し、必要なモデルを読み込みます。

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

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

% Open the model to report on
model_name = "sf_car";
load_system(model_name);

% Create a chapter for the Summary Table Reporter
titleStr = "Summary Table for Named Signals in "+model_name;
add(rpt,TitlePage(Title=titleStr,Author=""));

SignalFinder オブジェクトを作成して、モデル内の名前付きの信号をすべて検索します。

sigFinder = slreportgen.finder.SignalFinder(model_name);
sigFinder.IncludeInternalSignals = true;
sigFinder.IncludeUnnamedSignals = false;
results = find(sigFinder);

ファインダー オブジェクトの結果についての概要テーブル レポーターを作成します。

reporter = slreportgen.report.SummaryTable(results);
reporter.Properties = ["Name","Source","DataType","Dimensions"];
reporter.Title = "Named Signals";
add(rpt,reporter);
close(rpt);
rptview(rpt);
close_system(model_name);

詳細

すべて展開する

バージョン履歴

R2022a で導入

参考

| | | | | | |