このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。
Stateflow.Box
チャート、ステート、ボックス、または関数内のボックス
説明
Stateflow.Box
オブジェクトは、関数やステートなど、チャート内のオブジェクトを整理するために使用します。ボックスを使用すると、ステートや関数を別個の名前空間にカプセル化することもできます。詳細については、ボックスを使用したチャート オブジェクトのグループ化を参照してください。
作成
入力引数
parent
— 新しいボックスの親
Stateflow.Chart
オブジェクト | Stateflow.State
オブジェクト | Stateflow.Box
オブジェクト | Stateflow.Function
オブジェクト
新しいボックスの親。次のいずれかのタイプの Stateflow® API オブジェクトとして指定します。
Stateflow.Box
プロパティ
Stateflow API オブジェクトには、Stateflow エディターで設定した値に対応するプロパティがあります。プロパティにアクセスするかプロパティを変更するには、ドット表記を使用します。複数の API オブジェクトの複数のプロパティにアクセスするか、それらを変更するには、関数 get
および関数 set
をそれぞれ使用します。詳細については、Stateflow オブジェクトのプロパティの変更と関数の呼び出しを参照してください。
内容
Name
— ボックスの名前
""
(既定値) | string スカラー | 文字ベクトル
ボックスの名前。string スカラーまたは文字ベクトルとして指定します。
LabelString
— ボックスのラベル
"?"
(既定値) | string スカラー | 文字ベクトル
ボックスのラベル。string スカラーまたは文字ベクトルとして指定します。
IsExplicitlyCommented
— ボックスをコメント アウトするかどうか
false
または 0 (既定値) | true
または 1
ボックスをコメント アウトするかどうか。数値あるいは logical の 1 (true
) または 0 (false
) として指定します。このプロパティを true
に設定することは、ボックスを右クリックして [コメント アウト] を選択することと等価です。詳細については、Stateflow チャート内のオブジェクトのコメントアウトを参照してください。
IsImplicitlyCommented
— ボックスを暗黙的にコメント アウトするかどうか
true
または 1 | false
または 0
この プロパティ は読み取り専用です。
ボックスを暗黙的にコメント アウトするかどうか。数値あるいは logical の 1 (true
) または 0 (false
) として指定します。ボックスを含むオブジェクトを明示的にコメントアウトすると、そのボックスは暗黙的にコメントアウトされます。ボックスが Atomic サブチャートまたは Atomic ボックスに含まれている場合、明示的にコメント化されたオブジェクトもその Atomic サブチャートまたは Atomic ボックスに含まれていない限り、このプロパティは false
になります。
IsCommented
— ボックスをコメントアウトするかどうか
true
または 1 | false
または 0
R2023a 以降
この プロパティ は読み取り専用です。
ボックスをコメントアウトするかどうか。数値あるいは logical の 1 (true
) または 0 (false
) として指定します。IsExplicitlyCommented
または IsImplicitlyCommented
が true
の場合、このプロパティは true
になります。
CommentText
— コメント テキスト
""
(既定値) | string スカラー | 文字ベクトル
ボックスのコメント テキスト。string スカラーまたは文字ベクトルとして指定します。このプロパティは、IsExplicitlyCommented
プロパティが true
である場合にのみ適用されます。Stateflow エディターで、ボックス上のコメント バッジ をポイントすると、テキストがツールヒントとして表示されます。
IsExplicitlyCommented
プロパティを false
に設定すると、CommentText
の値は ""
に戻ります。
グラフィカルな外観
Position
— ボックスの位置とサイズ
[0 0 90 60]
(既定値) | [left top width height]
ボックスの位置とサイズ。[left top width height]
形式の 4 要素数値ベクトルとして指定します。
BadIntersection
— ボックスが、ボックス、ステート、または関数と交差するかどうか
true
または 1 | false
または 0
この プロパティ は読み取り専用です。
ボックスが、ボックス、ステート、または関数とグラフィカルに交差するかどうか。数値あるいは logical の 1 (true
) または 0 (false
) として指定します。
IsGrouped
— ボックスがグループ化されたボックスであるかどうか
false
または 0 (既定値) | true
または 1
ボックスがグループ化されたボックスであるかどうか。数値あるいは logical の 1 (true
) または 0 (false
) として指定します。グループ化されたボックスをコピーして貼り付けると、ボックスだけでなく、その内容もすべてコピーされます。詳細については、グループ化によるコピーと貼り付けを参照してください。
IsSubchart
— ボックスがサブチャートであるかどうか
false
または 0 (既定値) | true
または 1
ボックスがサブチャートであるかどうか。数値あるいは logical の 1 (true
) または 0 (false
) として指定します。
ContentPreviewEnabled
— ボックスの内容のプレビューを表示するかどうか
false
または 0 (既定値) | true
または 1
ボックスの内容のプレビューを表示するかどうか。数値あるいは logical の 1 (true
) または 0 (false
) として指定します。このプロパティは、IsSubchart
プロパティが true
である場合にのみ適用されます。
FontSize
— ボックス ラベルのフォント サイズ
スカラー
ボックス ラベルのフォント サイズ。スカラーとして指定します。ボックスを含むチャートの StateFont.Size
プロパティが、このプロパティの初期値を設定します。
ステート構造
ExecutionOrder
— パラレル (AND) 構造内の実行順序
スカラー
R2022b 以降
パラレル (AND) 構造内のボックスのサブステートの実行順序。整数スカラーとして指定します。このプロパティは、次の両方の条件が満たされている場合にのみ適用されます。
親のステートまたはチャートの
Decomposition
プロパティが"PARALLEL_AND"
である。ボックスを含むチャートの
UserSpecifiedStateTransitionExecutionOrder
プロパティがtrue
である。
階層
Chart
— ボックスを含むチャート
Stateflow.Chart
オブジェクト
この プロパティ は読み取り専用です。
ボックスを含むチャート。Stateflow.Chart
オブジェクトとして指定します。
Subviewer
— ボックスのサブビューアー
Stateflow.Chart
オブジェクト | Stateflow.State
オブジェクト | Stateflow.Box
オブジェクト | Stateflow.Function
オブジェクト
この プロパティ は読み取り専用です。
ボックスのサブビューアー。Stateflow.Chart
、Stateflow.State
、Stateflow.Box
、Stateflow.Function
のいずれかのオブジェクトとして指定します。サブビューアーは、ボックスをグラフィカルに表示できるチャートまたはサブチャートです。
Machine
— ボックスを含むマシン
Stateflow.Machine
オブジェクト
この プロパティ は読み取り専用です。
ボックスを含むマシン。Stateflow.Machine
オブジェクトとして指定します。
Path
— モデルの階層構造における親の場所
文字ベクトル
この プロパティ は読み取り専用です。
モデルの階層構造におけるボックスの親の場所。文字ベクトルとして指定します。
識別
Description
— 説明
""
(既定値) | string スカラー | 文字ベクトル
ボックスの説明。string スカラーまたは文字ベクトルとして指定します。
Document
— ドキュメント リンク
""
(既定値) | string スカラー | 文字ベクトル
ボックスのドキュメント リンク。string スカラーまたは文字ベクトルとして指定します。
Tag
— ユーザー定義のタグ
[]
(既定値) | 任意のデータ型
ボックスのユーザー定義のタグ。任意の型のデータとして指定します。
Id
— 一意の識別子
スカラー
この プロパティ は読み取り専用です。
一意の識別子。整数スカラーとして指定します。このプロパティを使用して、ボックスをモデル内の他のオブジェクトと区別します。このプロパティの値は、新しい MATLAB® セッションを開始するたびに再割り当てされ、オブジェクトが削除されるとリサイクルされる場合があります。
オブジェクト関数
find | 階層内で指定したオブジェクトの識別 |
getChildren | オブジェクトの子の特定 |
getParent | オブジェクトの親の特定 |
getReferences | シンボル名への参照の特定 |
renameReferences | シンボル名の変更とそのシンボル名への参照の更新 |
commentedBy | グラフィカル オブジェクトを暗黙的にコメントアウトするオブジェクトの特定 |
dialog | プロパティ ダイアログ ボックスを開く |
view | 編集環境でオブジェクトを表示 |
highlight | グラフィカル オブジェクトの強調表示 |
fitToView | グラフィカル オブジェクトの拡大表示 |
例
チャートへのボックスの追加
チャート ch
にボックスを追加します。名前は A
に設定します。
box = Stateflow.Box(ch);
box.Name = "A";
バージョン履歴
R2006a より前に導入R2023a: 新しいオブジェクト関数とプロパティ
Stateflow.Box
オブジェクトに、次の新しいオブジェクト関数とプロパティが追加されました。
オブジェクト関数
getReferences
は、チャートがボックスの名前を参照している場所を返します。オブジェクト関数
renameReferences
は、ボックスの名前を変更し、チャート内のそのボックス名への参照をすべて更新します。オブジェクト関数
commentedBy
は、ボックスをコメントアウトさせる明示的にコメント化されたオブジェクトを特定します。プロパティ
IsCommented
は、ボックスをコメントアウトするかどうかを示します。このプロパティは、オブジェクト関数isCommented
を置き換えるものです。
R2022b: ExecutionOrder
プロパティ
ExecutionOrder
プロパティは、パラレル (AND) 構造内のボックスのサブステートの実行順序を指定します。
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)