Main Content

Stateflow.Message

チャート、ステート、またはボックス内のメッセージ

    説明

    Stateflow.Message オブジェクトは、ローカルで、または Simulink® モデルの Stateflow® チャート間でデータをやり取りするために使用します。詳細については、メッセージ送信による Stateflow チャートとの通信を参照してください。

    作成

    説明

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

    入力引数

    すべて展開する

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

    プロパティ

    すべて展開する

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

    インターフェイス

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

    メッセージのスコープ。"Local""Input"、または "Output" として指定します。詳細については、スコープを参照してください。

    メッセージの端子インデックス。整数スカラーとして指定します。このプロパティは、入出力メッセージに対してのみ適用されます。詳細については、端子を参照してください。

    メッセージ データの値を初期化する方法。メッセージのスコープに依存する string スカラーまたは文字ベクトルとして指定します。

    • ローカル メッセージおよび出力メッセージの場合は、"Expression" または "Parameter" を使用。

    • 入力メッセージの場合は、"Not Needed" を使用。

    メッセージ データの初期値を指定するには、Props.InitialValue プロパティを使用します。

    詳細については、初期値を参照してください。

    メッセージの優先順位。string スカラーまたは文字ベクトルとして指定します。2 つの異なるメッセージが同時に発生した場合、このプロパティによって、どちらのメッセージを先に処理するかが決定されます。数値が小さいほど、高い優先順位を示します。このプロパティは、離散イベント チャートのローカル メッセージおよび出力メッセージに対してのみ適用されます。詳細については、Create Custom Queuing Systems Using Discrete-Event Stateflow Charts (SimEvents)を参照してください。

    キュー

    Stateflow チャートが入力メッセージ用に内部の受信側キューを保持するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。このプロパティは、入力メッセージに対してのみ適用されます。詳細については、内部キューの使用を参照してください。

    メッセージが受信側キューから削除される順序。次のいずれかの値として指定します。

    • "FIFO" — 先入れ先出し法。

    • "LIFO" — 後入れ先出し法。

    • "Priority" — データ フィールド内の値に従ってメッセージを削除します。順序を指定するには、メッセージの MessagePriorityOrder プロパティを使用します。

    このプロパティは、ローカル メッセージ、および UseInternalQueuetrue に設定されている入力メッセージに対してのみ適用されます。詳細については、キュー タイプを参照してください。

    メッセージの優先順位キューのタイプ。次のいずれかの値として指定します。

    • "Ascending" — メッセージはメッセージ データ値の昇順で受信されます。

    • "Descending" — メッセージはメッセージ データ値の降順で受信されます。

    このプロパティは、メッセージの QueueType プロパティが "Priority" である場合にのみ適用されます。詳細については、キュー タイプを参照してください。

    メッセージの内部キューの長さ。整数スカラーとして指定します。このプロパティは、ローカル メッセージ、および UseInternalQueuetrue に設定されている入力メッセージに対してのみ適用されます。詳細については、キューの容量を参照してください。

    受信メッセージの数がメッセージのキューの容量を超えたときの診断アクションのレベル。"Error""Warning"、または "None" として指定します。このプロパティは、ローカル メッセージ、および UseInternalQueuetrue に設定されている入力メッセージに対してのみ適用されます。詳細については、キュー オーバーフローの診断を参照してください。

    データ仕様

    メッセージのデータ型。メッセージの Props.Type.Method プロパティに依存する string スカラーまたは文字ベクトルとして指定します。

    • メッセージの Props.Type.Method プロパティが "Inherit" である場合、このプロパティの値は "Inherit: Same as Simulink" です。

    • メッセージの Props.Type.Method プロパティが "Built-in" である場合、このプロパティは次のいずれかのオプションを使って指定できます。

      • "double"

      • "single"

      • "int8"

      • "int16"

      • "int32"

      • "int64"

      • "uint8"

      • "uint16"

      • "uint32"

      • "uint64"

      • "boolean"

      • "string"

      • "ml" (C をアクション言語として使用するチャートでのみサポート)

    • それ以外の場合は、メッセージの Props.Type プロパティがこのプロパティの値を決定します。

    詳細については、Stateflow API を使用したチャートの作成データの追加セクションを参照してください。

    データ仕様のプロパティ。以下のプロパティをもつ Stateflow.DataProps オブジェクトとして指定します。

    • Type.Method — メッセージのデータ型を設定する方法。"Inherited""Built-in""Bus Object""Enumerated""Expression"、または "Fixed point" として指定します。このプロパティは、モデル エクスプローラーのデータ型アシスタントおよび [データ プロパティ] ダイアログ ボックスにおける [モード] フィールドと等価です。詳細については、Stateflow データの型の指定を参照してください。

    • Type.BusObject — メッセージのデータを定義する Simulink.Bus オブジェクトの名前。string スカラーまたは文字ベクトルとして指定します。このプロパティは、データ オブジェクトの Type.Method プロパティが "Bus Object" である場合にのみ適用されます。詳細については、Stateflow 構造体を介したバス信号へのアクセスを参照してください。

    • Type.EnumType — メッセージのデータを定義する列挙型の名前。string スカラーまたは文字ベクトルとして指定します。このプロパティは、データ オブジェクトの Type.Method プロパティが "Enumerated" である場合にのみ適用されます。詳細については、列挙データを使用した名前による値の参照を参照してください。

    • Type.Expression — メッセージのデータのデータ型として評価される式。string スカラーまたは文字ベクトルとして指定します。このプロパティは、データ オブジェクトの Type.Method プロパティが "Expression" である場合にのみ適用されます。詳細については、MATLAB 式を使用したデータ プロパティの指定を参照してください。

    • Type.Signed — 符号属性。数値あるいは logical の 1 (true) または 0 (false) として指定します。このプロパティは、データ オブジェクトの Type.Method プロパティが "Fixed point" である場合にのみ適用されます。詳細については、Stateflow チャートの固定小数点データを参照してください。

    • Type.WordLength — 語長 (ビット単位)。string スカラーまたは文字ベクトルとして指定します。このプロパティは、データ オブジェクトの Type.Method プロパティが "Fixed point" である場合にのみ適用されます。詳細については、Stateflow チャートの固定小数点データを参照してください。

    • Type.Fixpt.ScalingMode — メッセージの固定小数点データのスケーリング方法。"Binary point""Slope and bias"、または "None" として指定します。このプロパティは、データ オブジェクトの Type.Method プロパティが "Fixed point" である場合にのみ適用されます。詳細については、Stateflow チャートの固定小数点データを参照してください。

    • Type.Fixpt.FractionLength — 小数部の長さ (ビット単位)。string スカラーまたは文字ベクトルとして指定します。このプロパティは、Type.Method プロパティが "Fixed point" であり、Type.Fixpt.ScalingMode プロパティが "Binary point" である場合にのみ適用されます。

    • Type.Fixpt.Slope — 勾配。string スカラーまたは文字ベクトルとして指定します。このプロパティは、Type.Method プロパティが "Fixed point" であり、Type.Fixpt.ScalingMode プロパティが "Slope and bias" である場合にのみ適用されます。

    • Type.Fixpt.Bias — バイアス。string スカラーまたは文字ベクトルとして指定します。このプロパティは、Type.Method プロパティが "Fixed point" であり、Type.Fixpt.ScalingMode プロパティが "Slope and bias" である場合にのみ適用されます。

    • Type.Fixpt.Lock固定小数点ツール (Fixed-Point Designer)で選択されているオートスケールされた型によって固定小数点型が置き換えられるのを防止するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。このプロパティは、データ オブジェクトの Type.Method プロパティが "Fixed point" である場合にのみ適用されます。

    • Array.Size — メッセージのデータのサイズ。string スカラーまたは文字ベクトルとして指定します。詳細については、Stateflow データのサイズの指定を参照してください。

    • Complexity — メッセージが複素数値を受け入れるかどうか。"On" または "Off" として指定します。詳細については、Stateflow チャートの複素数データを参照してください。

    • InitialValue — 初期値。string スカラーまたは文字ベクトルとして指定します。

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

    コンパイラによって決定されるメッセージ データ サイズ。文字ベクトルとして指定します。

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

    コンパイラによって決定されるデータ型。文字ベクトルとして指定します。

    階層

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

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

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

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

    識別

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

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

    メッセージのユーザー定義のタグ。任意の型のデータとして指定します。

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

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

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

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

    オブジェクト関数

    getParentオブジェクトの親の特定
    dialogプロパティ ダイアログ ボックスを開く
    view編集環境でオブジェクトを表示

    すべて折りたたむ

    チャート ch にメッセージを追加します。名前、スコープ、データ型を指定します。

    message = Stateflow.Message(ch);
    message.Name = "M";
    message.Scope = "Input";
    message.Props.Type.Method = "Built-in";
    message.DataType = "int32";

    バージョン履歴

    R2015b で導入