Main Content

slreportgen.report.StateTransitionTable クラス

パッケージ: slreportgen.report
スーパークラス: slreportgen.report.Reporter

状態遷移表レポーター

R2022a 以降

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

説明

slreportgen.report.StateTransitionTable クラスのオブジェクトを使用して、Stateflow.StateTransitionTableChart オブジェクトおよび Simulink® State Transition Table ブロックについてレポートします。このレポーターには以下が含まれます。

  • 状態遷移表に関する詳細を記述したテーブル。

  • 状態遷移表で使用されるシンボルについてのオプションのプロパティ テーブル。

StateTransitionTable オブジェクトは slreportgen.report.Report オブジェクトでのみ使用できます。

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

クラス属性

HandleCompatible
true

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

作成

説明

sttReporter = StateTransitionTable() は、空の状態遷移表レポーターを作成します。sttReporter をレポートに追加する前に、Object プロパティを設定します。

例

sttReporter = StateTransitionTable(sttObj) は、slreportgen.report.StateTransitionTable オブジェクトを作成し、Object プロパティを sttObj に設定します。

sttReporter = StateTransitionTable(Name=Value) は、1 つ以上の名前と値の引数を使用してプロパティを設定します。

プロパティ

すべて展開する

レポート対象の状態遷移表。次のオプションのいずれかとして指定します。

値説明
string スカラーまたは文字配列レポート対象の State Transition Table ブロックのパス
ブロック ハンドルレポート対象の State Transition Table ブロックのブロック ハンドル。ブロック ハンドルを取得するには、関数 getSimulinkBlockHandle または get_param を使用します。
Stateflow.StateTransitionTableChartレポート対象のオブジェクト
slreportgen.finder.BlockResultレポート対象の Stateflow.StateTransitionTableChart オブジェクトを含むブロックを表す検索結果オブジェクト
slreportgen.finder.DiagramElementResultレポート対象の Stateflow.StateTransitionTableChart オブジェクトを表す検索結果オブジェクト。

属性:

GetAccess
public
SetAccess
public

データ型: char | string | double | Stateflow.StateTransitionTableChart | slreportgen.finder.BlockResult | slreportgen.finder.DiagramElementResult

状態遷移表で使用されるシンボルのプロパティ テーブルを含めるかどうか。数値か logical の 0 (false) または 1 (true) として指定します。プロパティ テーブルには、入出力端子のシンボルとローカル、定数、パラメーター、およびデータ ストア メモリのデータ要素のシンボルが含まれます。slreportgen.report.Report オブジェクトの CompileModelBeforeReporting プロパティを設定することで、レポートにシンボル値を追加する前にモデルをコンパイルするかどうかを選択できます。

属性:

GetAccess
public
SetAccess
public

データ型: logical

シンボル テーブルを含める場合のフォーマッタ。mlreportgen.report.BaseTable オブジェクトとして指定します。このプロパティの既定値は、TableStyleName プロパティが STTTableReporter スタイルに設定された BaseTable オブジェクトであり、これは StateTransitionTable の既定のテンプレートに定義されています。シンボル テーブルをカスタマイズするには、既存の BaseTable オブジェクトをカスタマイズするか、新しい BaseTable オブジェクトを TableReporter プロパティに割り当ててカスタマイズします。

属性:

GetAccess
public
SetAccess
public

データ型: mlreportgen.report.BaseTable

このレポーターのテンプレートのソース。次のいずれかのオプションとして指定します。

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

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

  • このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、DOM ドキュメントまたはドキュメント パーツ

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

生成された内容のレンダリングに使用する TemplateSrc のテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。TemplateName が空の場合、レポーターは TemplateSrc の既定のテンプレートを使用します。

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

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

この例では、State Transition Table ブロックについてレポートする方法を示します。

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

import slreportgen.utils.*
import slreportgen.report.*
import slreportgen.finder.*
import mlreportgen.dom.*
import mlreportgen.report.*

章を含む DOCX タイプの slreportgen.report.Report を作成します。

theReport = Report("STT_Generated_Report","docx");
chapter = Chapter("A State Transition Table Block");
append(theReport,chapter);

Simulink® モデルを読み込み、slreportgen.finder.BlockFinder オブジェクトを作成してモデル内のブロックを検索します。

modelName = "slrgex_stt_boiler";
load_system(modelName);
blockFinder = BlockFinder(modelName);

ブロック検索結果を反復処理して、State Transition Table ブロックを表す結果を探します。 

while(blockFinder.hasNext)
  nextRes = blockFinder.next;

State Transition Table ブロックを表す結果が見つかったら、その結果を使用して slreportgen.report.StateTransitionTable レポーターを作成します。さらに、foundSST フラグを true に設定してループを中断します。

  if(isStateTransitionTableBlock(nextRes))
    sttReporter = StateTransitionTable(Object=nextRes,IncludeSymbols=true);

StateTransitionTable レポーターをレポートに追加します。レポートとモデルを閉じ、レポートを表示します。

    append(theReport,sttReporter);
    close(theReport);
    close_system(modelName);
    rptview(theReport);

例の実行に戻って実行を終了します。

    return;
  end
end

コードの次のブロックは、State Transition Table ブロックがモデル内に見つからない場合のみ実行されます。モデルとレポートを閉じます。

close_system(modelName);
close(theReport);

バージョン履歴

R2022a で導入

参考

| (Stateflow) | | | | | | | |

トピック