slreportgen.report.TestSequence クラス

名前空間: slreportgen.report
スーパークラス: slreportgen.report.Reporter

Test Sequence ブロック レポーター

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

説明

slreportgen.report.TestSequence クラスのオブジェクトを使用して、Simulink® Test Sequence ブロックについてレポートします。Simulink モデルで Test Sequence ブロックを使用するには、Simulink Test™ が必要です。

既定では、TestSequence レポーターは次を生成します。

  • すべてのシンボルのプロパティ テーブル — 入力、出力、ローカル、定数、パラメーター、およびデータ ストア メモリ

  • ステップ階層の入れ子形式のリスト

  • ステップの説明、When 条件、アクション ステートメント、および遷移条件と次のステップのテーブルを含むステップごとの詳細

Test Sequence ブロックでシナリオが使用されている場合、TestSequence レポーターは、シナリオのパラメーターをパラメーターのテーブルに含め、各シナリオのリストをステップ階層に含めます。レポートでは、シナリオのアイコンでシナリオが識別されます。また、Active という語とそれに続くアクティブなシナリオのアイコンでアクティブなシナリオが識別されます。次に例を示します。

Scenario 2 (Active)

アクティブなシナリオがワークスペースで制御されている場合、レポーターはレポートにメモを追加します。この場合、レポートでアクティブなシナリオは識別されません。

内容にフィルターを適用したり内容の形式をカスタマイズしたりするには、TestSequence レポーターのプロパティを使用します。

メモ

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

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

クラス属性

HandleCompatible
true

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

作成

説明

reporter = slreportgen.report.TestSequence は、既定のテンプレートに基づいて空の TestSequence レポーター オブジェクトを作成します。Object プロパティを設定して、レポート対象の Test Sequence ブロックを指定する必要があります。その他のプロパティを使用してレポート オプションを指定します。

reporter = slreportgen.report.TestSequence(testSeqObject) は、TestSequence レポーターを作成し、Object プロパティを指定された Test Sequence ブロックに設定します。

例

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

プロパティ

すべて展開する

レポート対象の Test Sequence ブロック。次のいずれかのタイプの値として指定します。

シンボルをレポートに含めるかどうか。true または false として指定します。IncludeSymbols が true の場合、シンボルのプロパティ テーブルがレポートに含まれます。入出力シンボルのプロパティ テーブルでは、端子番号の順にシンボルが並べ替えられます。ローカル、定数、パラメーター、およびデータ ストア メモリのテーブルでは、シンボル名の順にシンボルが並べ替えられます。

レポートの生成前にモデルがコンパイルされていた場合、プロパティ テーブルの値はコンパイル後の値になります。それ以外の場合、プロパティの値はコンパイル前の値であり、モデルがコンパイルされていないことを示すメモがシンボルの節の最後に記述されます。既定では、モデルはレポートの生成時にコンパイルされます。レポートの生成時にモデルをコンパイルするかどうかは、このレポーターを含む slreportgen.report.Report オブジェクトの CompileModelBeforeReporting プロパティを設定することで制御できます。

データ型: logical

ステップ階層を含めるかどうか。true または false として指定します。IncludeStepHierarchy が true の場合、ステップ階層が入れ子形式のリストとしてレポートに含まれます。リストに含まれるステップ名は、レポート内の対応するステップの内容にリンクしています。

データ型: logical

ステップの内容を含めるかどうか。true または false として指定します。IncludeStepContent が true の場合、各ステップの内容がレポートに含まれます。レポートされるステップの内容に含まれるステップ名は、レポート内のステップ階層にリンクしています。レポートされるステップの内容は、IncludeStepDescription、IncludeStepWhenCondition、IncludeStepAction、IncludeStepTransitions、および IncludeStepRequirements の各プロパティを使用してフィルターを適用できます。

データ型: logical

ステップについてのレポートされる内容にステップの説明を含めるかどうか。true または false として指定します。

データ型: logical

ステップについてのレポートされる内容にステップの When 条件を含めるかどうか。true または false として指定します。When 条件は、When 構造の子ステップを有効にする条件です。

データ型: logical

ステップについてのレポートされる内容にステップのアクションを含めるかどうか。true または false として指定します。

データ型: logical

ステップについてレポートされる内容にステップの遷移表を含めるかどうか。true または false として指定します。ステップの遷移表には、遷移条件と次のステップが含まれます。

データ型: logical

ステップについてのレポートされる内容にステップの要件へのリンクを含めるかどうか。true または false として指定します。ステップの要件にリンクするには、Requirements Toolbox™ が必要です。

データ型: logical

このレポーターで生成されるテーブルのテーブル フォーマッタ。mlreportgen.report.BaseTable オブジェクトとして指定します。このプロパティの既定値は、TableStyleName プロパティが TestSequenceTable スタイルに設定された BaseTable オブジェクトであり、これは TestSequence レポーターの既定のテンプレートに定義されています。テーブルの外観をカスタマイズするには、既定の BaseTable オブジェクトのプロパティを変更するか、独自の BaseTable オブジェクトに置き換えます。BaseTable オブジェクトの Title プロパティにコンテンツを追加すると、生成されたレポートでテーブルのタイトルの前にそのコンテンツが表示されます。

ステップ階層リストのフォーマッタ。mlreportgen.dom.UnorderedList オブジェクトまたは mlreportgen.dom.OrderedList オブジェクトとして指定します。UnorderedList オブジェクトまたは OrderedList オブジェクトがリスト項目を含んでいてはなりません。

このプロパティの既定値は、StyleName プロパティが TestSequenceList スタイルに設定された UnorderedList オブジェクトであり、これは TestSequence レポーターの既定のテンプレートに定義されています。リストの詳細の外観をカスタマイズするには、既定の UnorderedList オブジェクトのプロパティを変更するか、このオブジェクトを独自の UnorderedList オブジェクトまたは OrderedList オブジェクトに置き換えます。

このレポーターのテンプレートのソース。以下のいずれかの方法で指定します。

  • このレポーターのテンプレートを含むファイルのパスを指定する、文字ベクトルまたは string スカラー

  • このレポーターが使用するテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、レポーターまたはレポート

  • このレポーターが使用するテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、ドキュメント オブジェクト モデル (DOM) のドキュメントまたはドキュメント パーツ

指定されるテンプレートは、このレポートが追加されるレポーターと同じタイプでなければなりません。たとえば、Microsoft® Word レポートの場合、TemplateSrc は Word レポーター テンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプで既定のレポーター テンプレートを使用します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このレポーター テンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーター テンプレートは、このレポーターの TemplateSrc プロパティで指定されたテンプレートのテンプレート ライブラリになければなりません。

属性:

GetAccess
public
SetAccess
public

データ型: char | string

このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルまたは string スカラー、あるいは mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラーの値は LinkTarget オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前に配置されます。

属性:

GetAccess
public
SetAccess
public

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

この例では、slreportgen.report.TestSequence オブジェクトを使用して Test Sequence ブロックについてレポートする方法を示します。

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

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

PDF タイプの Simulink® Report Generator レポートを作成します。

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

テスト シーケンスがあるモデルを読み込みます。

model_name = "slrgex_sltestTestSequenceDebouncerExample";
load_system(model_name);
testSeqObj = strcat(model_name,"/Debouncer_Test");

Test Sequence ブロックの章を作成します。

chapter = Chapter(testSeqObj);

Test Sequence ブロックのレポーターを作成します。

rptr = TestSequence(testSeqObj);

レポーターを章に追加し、その章をレポートに追加します。

append(chapter,rptr);
append(rpt,chapter);

レポートとモデルを閉じ、レポートを表示します。

close(rpt);
close_system(model_name);
rptview(rpt);

バージョン履歴

R2020b で導入

参考

(Simulink Test)

トピック