Stateflow.SimulinkBasedState

チャート、ステート、またはボックス内の Simulink ベースのステート

説明

Stateflow.SimulinkBasedState オブジェクトは、Stateflow^® ステート内に Simulink^® サブシステムを作成するために使用します。Simulink ベースのステートにより、ハイブリッド動的システム、つまり周期的ダイナミクスと連続時間ダイナミクスの間で切り替わるシステムをモデル化できます。詳細については、ステートとしての Simulink サブシステムを参照してください。

作成

構文

simulinkBasedState = Stateflow.SimulinkBasedState(parent)

説明

simulinkBasedState = Stateflow.SimulinkBasedState(parent) は、親であるチャート、ステート、またはボックス内に Stateflow.SimulinkBasedState オブジェクトを作成します。

入力引数

parent — 新しい Simulink ベースのステートの親

Stateflow.Chart オブジェクト | Stateflow.State オブジェクト | Stateflow.Box オブジェクト

新しい Simulink ベースのステートの親。次のいずれかのタイプの Stateflow API オブジェクトとして指定します。

• Stateflow.Box

• Stateflow.Chart

• Stateflow.State

プロパティ

Stateflow API オブジェクトには、Stateflow エディターで設定した値に対応するプロパティがあります。プロパティにアクセスするかプロパティを変更するには、ドット表記を使用します。複数の API オブジェクトの複数のプロパティにアクセスするか、それらを変更するには、関数 get および関数 set をそれぞれ使用します。詳細については、Stateflow オブジェクトのプロパティの変更と関数の呼び出しを参照してください。

内容

Name — Simulink ベースのステートの名前

"" (既定値) | string スカラー | 文字ベクトル

Simulink ベースのステートの名前。string スカラーまたは文字ベクトルとして指定します。

IsExplicitlyCommented — Simulink ベースのステートをコメントアウトするかどうか

false または 0 (既定値) | true または 1

Simulink ベースのステートをコメントアウトするかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。このプロパティを true に設定することは、Simulink ベースのステートを右クリックして [コメント アウト] を選択することと等価です。詳細については、Stateflow チャート内のオブジェクトのコメントアウトを参照してください。

IsImplicitlyCommented — Simulink ベースのステートを暗黙的にコメントアウトするかどうか

読み取り専用: true または 1 | false または 0

この プロパティ は読み取り専用です。

Simulink ベースのステートを暗黙的にコメントアウトするかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。Simulink ベースのステートを含むオブジェクトを明示的にコメントアウトすると、そのステートは暗黙的にコメントアウトされます。Simulink ベースのステートが Atomic サブチャートに含まれている場合、明示的にコメント化されたオブジェクトもその Atomic サブチャートに含まれていない限り、このプロパティは false になります。

IsCommented — Simulink ベースのステートをコメントアウトするかどうか

読み取り専用: true または 1 | false または 0

R2023a 以降

この プロパティ は読み取り専用です。

Simulink ベースのステートをコメントアウトするかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。IsExplicitlyCommented または IsImplicitlyCommented が true の場合、このプロパティは true になります。

CommentText — コメント テキスト

"" (既定値) | string スカラー | 文字ベクトル

Simulink ベースのステートに追加するコメント テキスト。string スカラーまたは文字ベクトルとして指定します。このプロパティは、IsExplicitlyCommented プロパティが true である場合にのみ適用されます。Stateflow エディターで、Simulink ベースのステート上のコメント バッジ をポイントすると、テキストがツールヒントとして表示されます。IsExplicitlyCommented プロパティを false に設定すると、CommentText の値は "" に戻ります。

グラフィカルな外観

Position — Simulink ベースのステートの位置とサイズ

[0 0 90 60] (既定値) | [left top width height]

Simulink ベースのステートの位置とサイズ。[left top width height] 形式の 4 要素数値ベクトルとして指定します。

BadIntersection — Simulink ベースのステートがボックス、ステート、または関数と交差するかどうか

読み取り専用: true または 1 | false または 0

この プロパティ は読み取り専用です。

Simulink ベースのステートがボックス、ステート、または関数とグラフィカルに交差するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

ContentPreviewEnabled — Simulink ベースのステートの内容のプレビューを表示するかどうか

true または 1 (既定値) | false または 0

Simulink ベースのステートの内容のプレビューを表示するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

ArrowSize — 入力遷移の矢印のサイズ

8 (既定値) | スカラー

入力遷移の矢印のサイズ。スカラーとして指定します。

FontSize — Simulink ベースのステートのラベルのフォント サイズ

スカラー

Simulink ベースのステートのラベルのフォント サイズ。スカラーとして指定します。Simulink ベースのステートを含むチャートの StateFont.Size プロパティが、このプロパティの初期値を設定します。

ステート構造

Type — 兄弟ステートの構造

読み取り専用: 'AND' | 'OR'

この プロパティ は読み取り専用です。

兄弟ステートの構造。'AND' または 'OR' として指定します。Simulink ベースのステートは、親であるステートまたはチャートの Decomposition プロパティからこのプロパティを継承します。

ExecutionOrder — パラレル (AND) 構造内の実行順序

スカラー

パラレル (AND) 構造内の Simulink ベースのステートの実行順序。整数スカラーとして指定します。このプロパティは、次の両方の条件が満たされている場合にのみ適用されます。

• Simulink ベースのステートの Type プロパティが "AND" である。

• Simulink ベースのステートを含むチャートの UserSpecifiedStateTransitionExecutionOrder プロパティが true である。

アクティブ ステートの出力

HasOutputData — アクティブ ステート データの出力を作成するかどうか

false または 0 (既定値) | true または 1

Simulink ベースのステートのアクティブ ステート データの出力端子を作成するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。詳細については、アクティブ ステート データによるステート アクティビティの監視を参照してください。

OutputData — アクティブ ステート データ オブジェクト

読み取り専用: Stateflow.Data オブジェクト

この プロパティ は読み取り専用です。

Simulink ベースのステートのアクティブ ステート データ オブジェクト。Stateflow.Data オブジェクトとして指定します。このプロパティは、Simulink ベースのステートの HasOutputData プロパティが true である場合にのみ適用されます。

OutputPortName — アクティブ ステート データ オブジェクトの名前

string スカラー | 文字ベクトル

Simulink ベースのステートのアクティブ ステート データ オブジェクトの名前。string スカラーまたは文字ベクトルとして指定します。このプロパティは、Simulink ベースのステートの HasOutputData プロパティが true である場合にのみ適用されます。

OutputMonitoringMode — アクティブ ステートの出力に対する監視モード

"SelfActivity"

アクティブ ステートの出力データに対する監視モード。string スカラーまたは文字ベクトルとして指定します。Simulink ベースのステートの場合、"SelfActivity" が唯一のオプションです。

信号ログとテスト ポイントの監視

LoggingInfo — 信号のログのプロパティ

Stateflow.SigLoggingInfo オブジェクト

Simulink ベースのステートに対する信号のログのプロパティ。次のプロパティをもつ Stateflow.SigLoggingInfo オブジェクトとして指定します。

• DataLogging — 信号のログを有効にするかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

• DecimateData — ログ データの量を制限するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

• Decimation — 間引き間隔。整数スカラーとして指定します。このプロパティは、DecimateData プロパティが true である場合にのみ適用されます。

• LimitDataPoints — ログに記録するデータ点の数を制限するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

• MaxPoints — ログに記録するデータ点の最大数。整数スカラーとして指定します。このプロパティは、LimitDataPoints プロパティが true である場合にのみ適用されます。

• NameMode — 信号名のソース。"SignalName" または "Custom" として指定します。

• LoggingName — カスタム信号名。string スカラーまたは文字ベクトルとして指定します。このプロパティは、NameMode プロパティが "Custom" である場合にのみ適用されます。

信号のログでは、シミュレーション中に Simulink ベースのステートの自己アクティビティが MATLAB^® ワークスペースに保存されます。詳細については、Log Simulation Output for States and Dataを参照してください。

例: state.LoggingInfo.DataLogging = true;

TestPoint — Simulink ベースのステートをテスト ポイントとして設定するかどうか

false または 0 (既定値) | true または 1

Simulink ベースのステートをテスト ポイントとして設定するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。シミュレーション時にテストポイントをフローティング スコープで監視できます。テスト ポイントの値を MATLAB ワークスペースにログ記録することも可能です。詳細については、テスト ポイントとしての信号の設定 (Simulink)を参照してください。

デバッグ

Debug — デバッガーのプロパティ

Stateflow.StateDebug オブジェクト

Simulink ベースのステートに対するデバッガーのプロパティ。次のプロパティをもつ Stateflow.StateDebug オブジェクトとして指定します。

• OnEntry — On State Entry ブレークポイントを設定するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

• OnDuring — During State ブレークポイントを設定するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

• OnExit — On State Exit ブレークポイントを設定するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

詳細については、チャートのデバッグのためのブレークポイントの設定を参照してください。

例: simulinkBasedState.Debug.Breakpoints.OnEntry = true;

例: simulinkBasedState.Debug.Breakpoints.OnDuring = true;

例: simulinkBasedState.Debug.Breakpoints.OnExit = true;

階層

Chart — Simulink ベースのステートを含むチャート

読み取り専用: Stateflow.Chart オブジェクト

この プロパティ は読み取り専用です。

Simulink ベースのステートを含むチャート。Stateflow.Chart オブジェクトとして指定します。

Subviewer — Simulink ベースのステートのサブビューアー

読み取り専用: Stateflow.Chart オブジェクト | Stateflow.State オブジェクト | Stateflow.Box オブジェクト

この プロパティ は読み取り専用です。

Simulink ベースのステートのサブビューアー。Stateflow.Chart、Stateflow.State、Stateflow.Box のいずれかのオブジェクトとして指定します。サブビューアーは、Simulink ベースのステートをグラフィカルに表示できるチャートまたはサブチャートです。

Machine — Simulink ベースのステートを含むマシン

読み取り専用: Stateflow.Machine オブジェクト

この プロパティ は読み取り専用です。

Simulink ベースのステートを含むマシン。Stateflow.Machine オブジェクトとして指定します。

Path — モデルの階層構造における親の場所

読み取り専用: 文字ベクトル

この プロパティ は読み取り専用です。

モデルの階層構造における Simulink ベースのステートの親の場所。文字ベクトルとして指定します。

識別

Description — 説明

"" (既定値) | string スカラー | 文字ベクトル

Simulink ベースのステートの説明。string スカラーまたは文字ベクトルとして指定します。

Document — ドキュメント リンク

"" (既定値) | string スカラー | 文字ベクトル

Simulink ベースのステートのドキュメント リンク。string スカラーまたは文字ベクトルとして指定します。

Tag — ユーザー定義のタグ

[] (既定値) | 任意のデータ型

Simulink ベースのステートのユーザー定義のタグ。任意の型のデータとして指定します。

SSIdNumber — セッションに依存しない識別子

読み取り専用: スカラー

この プロパティ は読み取り専用です。

セッションに依存しない識別子。整数スカラーとして指定します。このプロパティを使用して、Simulink ベースのステートをその親チャート内の他のオブジェクトと区別します。

Id — 一意の識別子

読み取り専用: スカラー

この プロパティ は読み取り専用です。

一意の識別子。整数スカラーとして指定します。SSIdNumber とは異なり、このプロパティの値は新しい MATLAB セッションを開始するたびに再割り当てされ、オブジェクトが削除されるとリサイクルされる場合があります。

オブジェクト関数

getParent	オブジェクトの親の特定
getReferences	シンボル名への参照の特定
renameReferences	シンボル名の変更とそのシンボル名への参照の更新
commentedBy	グラフィカル オブジェクトを暗黙的にコメントアウトするオブジェクトの特定
getMappingForSymbol	Atomic サブチャート、Atomic ボックス、または Simulink ベースのステート内のシンボルに対するマッピングを取得
setMappingForSymbol	Atomic サブチャート、Atomic ボックス、または Simulink ベースのステート内のシンボルに対するマッピングを設定
clearMappingForSymbol	Atomic サブチャート、Atomic ボックス、または Simulink ベースのステート内のシンボルに対するマッピングをクリア
dialog	プロパティ ダイアログ ボックスを開く
view	編集環境でオブジェクトを表示
highlight	グラフィカル オブジェクトの強調表示
fitToView	グラフィカル オブジェクトの拡大表示

例

チャートへの Simulink ベースのステートの追加

チャート ch に Simulink ベースのステートを追加します。名前は A に設定します。

simulinkBasedState = Stateflow.SimulinkBasedState(ch);
simulinkBasedState.Name = "A";

Simulink ベースのステートでの変数のマッピング

R2023a 以降

Locked という Simulink ベースのステート内で、出力 we のマッピングを変更します。

モデル sf_clutch.slx を開きます。

open_system("sf_clutch.slx")

Simulink ベースのステート Locked の Stateflow.SimulinkBasedState オブジェクトにアクセスします。

subsystem = find(sfroot,"-isa","Stateflow.SimulinkBasedState",  ...
    Name="Locked");

Simulink ベースのステートの出力 we のマッピングをチェックします。

getMappingForSymbol(subsystem,"we").Name

ans = 
'we'

Simulink ベースのステートの出力 we をチャートの出力 wv にマッピングします。

setMappingForSymbol(subsystem,"we","wv")
getMappingForSymbol(subsystem,"we").Name

ans = 
'wv'

Simulink ベースのステートの出力 we のマッピングをクリアします。

clearMappingForSymbol(subsystem,"we")
getMappingForSymbol(subsystem,"we").Name

ans = 
'we'

バージョン履歴

R2017b で導入

R2023a: 新しいオブジェクト関数とプロパティ

Stateflow.SimulinkBasedState オブジェクトに、次の新しいオブジェクト関数とプロパティが追加されました。

• オブジェクト関数 setMappingForSymbol は、Simulink ベースのステートのシンボルをメイン チャート シンボルにマッピングします。

• オブジェクト関数 clearMappingForSymbol は、Simulink ベースのステートのシンボルに対するマッピングをクリアします。

• オブジェクト関数 getMappingForSymbol は、Simulink ベースのステートのシンボルのマッピング先であるメイン チャート シンボルを返します。

• オブジェクト関数 getReferences は、チャートが Simulink ベースのステートの名前を参照している場所を返します。

• オブジェクト関数 renameReferences は、Simulink ベースのステートの名前を変更し、チャート内のその Simulink ベースのステートの名前への参照をすべて更新します。

• オブジェクト関数 commentedBy は、Simulink ベースのステートをコメントアウトさせる明示的にコメント化されたオブジェクトを特定します。

• プロパティ IsCommented は、Simulink ベースのステートをコメントアウトするかどうかを示します。このプロパティは、オブジェクト関数 isCommented を置き換えるものです。

参考

Stateflow.Box | Stateflow.Chart | Stateflow.State

トピック

• Stateflow API の概要
• ステートとしての Simulink サブシステム
• Stateflow API のオブジェクトとプロパティの概要