Main Content

Stateflow.Box

チャート、ステート、ボックス、または関数内のボックス

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

    説明

    Stateflow.Box オブジェクトは、関数やステートなど、チャート内のオブジェクトを整理するために使用します。ボックスを使用すると、ステートや関数を別個の名前空間にカプセル化することもできます。詳細については、ボックスを使用したチャート オブジェクトのグループ化を参照してください。

    作成

    構文

    box = Stateflow.Box(parent)

    説明

    例

    box = Stateflow.Box(parent) は、親であるチャート、ステート、ボックス、またはグラフィカル関数内に Stateflow.Box オブジェクトを作成します。

    入力引数

    すべて展開する

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

    プロパティ

    すべて展開する

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

    内容

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

    ボックスのラベル。string スカラーまたは文字ベクトルとして指定します。

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

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

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

    R2023a 以降

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

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

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

    グラフィカルな外観

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

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

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

    ボックスがグループ化されたボックスであるかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。グループ化されたボックスをコピーして貼り付けると、ボックスだけでなく、その内容もすべてコピーされます。詳細については、グループ化によるコピーと貼り付けを参照してください。

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

    ボックスの内容のプレビューを表示するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。このプロパティは、IsSubchart プロパティが true である場合にのみ適用されます。

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

    ステート構造

    R2022b 以降

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

    • 親のステートまたはチャートの Decomposition プロパティが "PARALLEL_AND" である。

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

    階層

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

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

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

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

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

    ボックスを含むマシン。Stateflow.Machine オブジェクトとして指定します。

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

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

    識別

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

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

    ボックスのユーザー定義のタグ。任意の型のデータとして指定します。

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

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

    オブジェクト関数

    find階層内で指定したオブジェクトの識別
    getChildrenオブジェクトの子の特定
    getParentオブジェクトの親の特定
    getReferencesシンボル名への参照の特定
    renameReferencesシンボル名の変更とそのシンボル名への参照の更新
    commentedByグラフィカル オブジェクトを暗黙的にコメントアウトするオブジェクトの特定
    dialogプロパティ ダイアログ ボックスを開く
    view編集環境でオブジェクトを表示
    highlightグラフィカル オブジェクトの強調表示
    fitToViewグラフィカル オブジェクトの拡大表示

    例

    すべて折りたたむ

    チャート ch にボックスを追加します。名前は A に設定します。

    box = Stateflow.Box(ch);
box.Name = "A";

    バージョン履歴

    R2006a より前に導入

    すべて展開する

    参考

    | |

    トピック