このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

Stateflow.SLFunction

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

説明

Stateflow.SLFunction オブジェクトは、ステートと遷移のアクションにおいて Simulink^® サブシステムの呼び出しを可能にする Simulink 関数を作成するために使用します。代表的な使用例は、以下のとおりです。

• Simulink ブロックを必要とする関数の定義

• 複数コントローラーの実行のスケジュール

詳細については、Stateflow チャートでの Simulink 関数の再利用を参照してください。

作成

構文

function = Stateflow.SLFunction(parent)

説明

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

入力引数

parent — 新しい Simulink 関数の親

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

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

• Stateflow.Box

• Stateflow.Chart

• Stateflow.Function

• Stateflow.State

プロパティ

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

内容

Name — Simulink 関数の名前

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

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

LabelString — 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 ボックスに含まれている場合、明示的にコメント化されたオブジェクトもその 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) として指定します。

FontSize — Simulink 関数ラベルのフォント サイズ

スカラー

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

階層

Chart — Simulink 関数を含むチャート

Stateflow.Chart オブジェクト

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

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

Subviewer — Simulink 関数のサブビューアー

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

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

Simulink 関数のサブビューアー。Stateflow.Chart、Stateflow.State、Stateflow.Box、Stateflow.Function のいずれかのオブジェクトとして指定します。サブビューアーは、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^® セッションを開始するたびに再割り当てされ、オブジェクトが削除されるとリサイクルされる場合があります。

オブジェクト関数

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

例

チャートへの Simulink 関数の追加

チャート ch に Simulink 関数を追加します。ラベルは "[y1,y2] = f(x1,x2,x3)" に設定します。

function = Stateflow.SLFunction(ch);
function.LabelString = "[y1,y2] = f(x1,x2,x3)";

バージョン履歴

R2008b で導入

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

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

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

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

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

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

参考

Stateflow.Box | Stateflow.Chart | Stateflow.Function | Stateflow.State

トピック

• Stateflow API の概要
• Stateflow チャートでの Simulink 関数の再利用
• Stateflow API のオブジェクトとプロパティの概要