Stateflow.Function
チャート、ステート、ボックス、または関数内のグラフィカル関数
説明
Stateflow.Function オブジェクトは、制御フロー ロジックと反復ループを含むグラフィカル関数を作成するために使用します。グラフィカル関数は、コネクティブ ジャンクションと遷移を使用するフロー チャートで作成します。グラフィカル関数は、ステートと遷移のアクションで呼び出すことができます。詳細については、グラフィカル関数の定義によるロジック パターンの再利用を参照してください。
作成
入力引数
プロパティ
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 プロパティが、このプロパティの初期値を設定します。
デバッグ
グラフィカル関数に対するデバッガーのプロパティ。次のプロパティをもつ Stateflow.FunctionDebug オブジェクトとして指定します。
Breakpoints.OnDuring—During Function Callブレークポイントを設定するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。
詳細については、チャートのデバッグのためのブレークポイントの設定を参照してください。
例: func.Debug.Breakpoints.OnDuring = true;
コード生成
生成コード内でのグラフィカル関数の外観。次のいずれかの値として指定します。
"Auto"— 内部計算により、生成コード内の関数の外観が決まります。"Function"— 関数は別個の C 関数として実装されます。"Inline"— 関数に対する呼び出しがコードで置き換えられます。ただし、関数が再帰の一部でない場合に限ります。
詳細については、ステート関数の生成コード内インライン化 (Simulink Coder)を参照してください。
階層
この プロパティ は読み取り専用です。
グラフィカル関数を含むチャート。Stateflow.Chart オブジェクトとして指定します。
この プロパティ は読み取り専用です。
グラフィカル関数のサブビューアー。Stateflow.Chart、Stateflow.State、Stateflow.Box、Stateflow.Function のいずれかのオブジェクトとして指定します。サブビューアーは、グラフィカル関数をグラフィカルに表示できるチャートまたはサブチャートです。
この プロパティ は読み取り専用です。
グラフィカル関数を含むマシン。Stateflow.Machine オブジェクトとして指定します。
この プロパティ は読み取り専用です。
モデルの階層構造におけるグラフィカル関数の親の場所。文字ベクトルとして指定します。
識別
グラフィカル関数の説明。string スカラーまたは文字ベクトルとして指定します。
グラフィカル関数のドキュメント リンク。string スカラーまたは文字ベクトルとして指定します。
グラフィカル関数のユーザー定義のタグ。任意の型のデータとして指定します。
この プロパティ は読み取り専用です。
セッションに依存しない識別子。整数スカラーとして指定します。このプロパティを使用して、グラフィカル関数をその親チャート内の他のオブジェクトと区別します。
この プロパティ は読み取り専用です。
一意の識別子。整数スカラーとして指定します。SSIdNumber とは異なり、このプロパティの値は新しい MATLAB® セッションを開始するたびに再割り当てされ、オブジェクトが削除されるとリサイクルされる場合があります。
オブジェクト関数
find | 階層内で指定したオブジェクトの識別 |
getChildren | オブジェクトの子の特定 |
getParent | オブジェクトの親の特定 |
defaultTransitions | 指定したオブジェクト内のデフォルト遷移の特定 |
getReferences | シンボル名への参照の特定 |
renameReferences | シンボル名の変更とそのシンボル名への参照の更新 |
commentedBy | グラフィカル オブジェクトを暗黙的にコメントアウトするオブジェクトの特定 |
dialog | プロパティ ダイアログ ボックスを開く |
view | 編集環境でオブジェクトを表示 |
highlight | グラフィカル オブジェクトの強調表示 |
fitToView | グラフィカル オブジェクトの拡大表示 |
