Stateflow.AtomicSubchart

チャート、ステート、またはボックス内の Atomic サブチャート

説明

Stateflow.AtomicSubchart オブジェクトは、Stateflow^® チャートで独立したサブコンポーネントを作成するために使用します。Atomic サブチャートには以下のことが可能です。

• 同じステートまたはサブチャートを複数のチャートやモデルで再利用する

• 多くのステートまたは階層レベルをもつチャートに小さい変更を加えた後のシミュレーションが高速化する

• 複数の人が同じチャートの異なる部分で作業する場合にチームでの開発がしやすくなる

• チャート内の特定のステートまたはサブチャートで生成されたコードを手動で検査できる

詳細については、Atomic サブチャート使用した再利用可能なサブコンポーネントの作成を参照してください。

作成

構文

atomicSubchart = Stateflow.AtomicSubchart(parent)

説明

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

入力引数

parent — 新しい Atomic サブチャートの親

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

新しい Atomic サブチャートの親。次のいずれかのタイプの Stateflow API オブジェクトとして指定します。

• Stateflow.Box

• Stateflow.Chart

• Stateflow.State

プロパティ

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

内容

Name — Atomic サブチャートの名前

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

Atomic サブチャートの名前。string スカラーまたは文字ベクトルとして指定します。

LabelString — Atomic サブチャートのラベル

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

Atomic サブチャートのラベル。string スカラーまたは文字ベクトルとして指定します。

IsLink — Atomic サブチャートがライブラリ リンクであるかどうか

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

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

Atomic サブチャートがライブラリ リンクであるかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

IsExplicitlyCommented — Atomic サブチャートをコメントアウトするかどうか

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

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

IsImplicitlyCommented — Atomic サブチャートを暗黙的にコメントアウトするかどうか

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

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

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

IsCommented — Atomic サブチャートをコメントアウトするかどうか

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

R2023a 以降

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

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

CommentText — コメント テキスト

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

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

グラフィカルな外観

Position — Atomic サブチャートの位置とサイズ

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

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

BadIntersection — Atomic サブチャートがボックス、ステート、または関数と交差するかどうか

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

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

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

ContentPreviewEnabled — Atomic サブチャートの内容のプレビューを表示するかどうか

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

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

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

8 (既定値) | スカラー

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

FontSize — Atomic サブチャート ラベルのフォント サイズ

スカラー

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

ステート構造

Type — 兄弟ステートの構造

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

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

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

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

スカラー

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

• Atomic サブチャートの Type プロパティが "AND" である。

• Atomic サブチャートを含むチャートの UserSpecifiedStateTransitionExecutionOrder プロパティが true である。

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

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

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

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

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

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

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

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

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

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

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

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

"SelfActivity"

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

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

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

Stateflow.SigLoggingInfo オブジェクト

Atomic サブチャートに対する信号のログのプロパティ。次のプロパティをもつ 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" である場合にのみ適用されます。

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

例: state.LoggingInfo.DataLogging = true;

TestPoint — Atomic サブチャートをテスト ポイントとして設定するかどうか

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

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

デバッグ

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

Stateflow.StateDebug オブジェクト

ステート、Atomic サブチャート、または 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) として指定します。

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

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

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

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

階層

Chart — Atomic サブチャートを含むチャート

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

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

Atomic サブチャートを含むチャート。Stateflow.Chart オブジェクトとして指定します。

Subchart — Atomic サブチャートの内容

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

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

Atomic サブチャートの内容。Stateflow.Chart オブジェクトとして指定します。このオブジェクトを使用して、ステートや遷移などの子を Atomic サブチャートに追加します。詳細については、Atomic サブチャートへの exit 端子および exit ジャンクションの追加を参照してください。

Subviewer — Atomic サブチャートのサブビューアー

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

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

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

Machine — Atomic サブチャートを含むマシン

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

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

Atomic サブチャートを含むマシン。Stateflow.Machine オブジェクトとして指定します。

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

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

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

モデルの階層構造における Atomic サブチャートの親の場所。文字ベクトルとして指定します。

識別

Description — 説明

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

Atomic サブチャートの説明。string スカラーまたは文字ベクトルとして指定します。

Document — ドキュメント リンク

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

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

Tag — ユーザー定義のタグ

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

Atomic サブチャートのユーザー定義のタグ。任意の型のデータとして指定します。

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

読み取り専用: スカラー

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

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

Id — 一意の識別子

読み取り専用: スカラー

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

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

オブジェクト関数

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

例

チャートへの Atomic サブチャートの追加

チャート ch に Atomic サブチャートを追加します。名前は A に設定します。

atomicSubchart = Stateflow.AtomicSubchart(ch);
atomicSubchart.Name = "A";

Atomic サブチャートへの exit 端子および exit ジャンクションの追加

R2021b 以降

A という Atomic サブチャート内で、"exit" というラベルが付いた exit 端子と exit ジャンクションを追加します。

チャート ch 内で、Atomic サブチャート A に対応する Stateflow.AtomicSubchart オブジェクトを検索します。

atomicSubchart = find(ch,"-isa","Stateflow.AtomicSubchart",Name="A");

exit ジャンクションを Atomic サブチャートに追加します。Atomic サブチャートの Subchart プロパティを、exit ジャンクションの親として使用します。exit ジャンクションの PortType プロパティの値を表示します。

exitJunction = Stateflow.Port(atomicSubchart.Subchart,"ExitJunction");
exitJunction.PortType

ans =

    'ExitJunction'

exit ジャンクションのラベルを "exit" に設定します。

exitJunction.labelString = "exit";

一致する exit 端子の Stateflow.Port オブジェクトを検索します。exit 端子の PortType プロパティの値を表示します。

exitPort = Stateflow.findMatchingPort(exitJunction);
exitPort.PortType

ans =

    'ExitPort'

exit 端子のラベルを表示します。

exitPort.labelString

ans =

    'exit'

Atomic サブチャートでの変数のマッピング

R2022b 以降

A という Atomic サブチャート内で、サブチャートの入力 u1 のマッピングを変更します。

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

open_system("sf_atomic_iodata_fixed")

Atomic サブチャート A の Stateflow.AtomicSubchart オブジェクトにアクセスします。

subsystem = find(sfroot,"-isa","Stateflow.AtomicSubchart", ...
    Name="A");

Subchart プロパティを使用して、サブチャートの入力 u1 の Stateflow.Data オブジェクトにアクセスします。

subsystemSymbol = find(subsystem.Subchart, ...
    "-isa","Stateflow.Data",Name="u1");

Chart プロパティを使用して、チャートの入力 u2 の Stateflow.Data オブジェクトにアクセスします。

chartSymbol = find(subsystem.Chart, ...
    "-isa","Stateflow.Data",Name="u2");

サブチャートの入力 u1 のマッピングをチェックします。

getMappingForSymbol(subsystem,subsystemSymbol).Name

ans = 
'u1'

サブチャートの入力 u1 をチャートの入力 u2 にマッピングします。

setMappingForSymbol(subsystem,subsystemSymbol,chartSymbol)
getMappingForSymbol(subsystem,subsystemSymbol).Name

ans = 
'u2'

サブチャートの入力 u1 のマッピングをクリアします。

clearMappingForSymbol(subsystem,subsystemSymbol)
getMappingForSymbol(subsystem,subsystemSymbol).Name

ans = 
'u1'

バージョン履歴

R2010b で導入

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

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

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

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

• オブジェクト関数 commentedBy は、Atomic サブチャートをコメントアウトさせる明示的にコメント化されたオブジェクトを特定します。

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

R2022b: Atomic サブチャートの変数のマッピング

オブジェクト関数 getMappingForSymbol、setMappingForSymbol、clearMappingForSymbol、および disableMappingForSymbol を呼び出して、Atomic サブチャートのシンボルのマッピングを編集します。

参考

関数

• find | Stateflow.findMatchingPort

オブジェクト

• Stateflow.Box | Stateflow.Chart | Stateflow.Port | Stateflow.State

トピック

• Stateflow API の概要
• Atomic サブチャート使用した再利用可能なサブコンポーネントの作成
• Stateflow API のオブジェクトとプロパティの概要