最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Simulink.RunTimeBlock

シミュレーションの実行中における、Level-2 MATLAB S-Function やその他の MATLAB プログラムによるブロックに関する情報の取得

説明

Level-2 MATLAB® S-Function あるいは他の MATLAB プログラムが、ブロックについての情報を得ることを可能にします。Simulink® ソフトウェアは、モデルの各ブロックに対して、このクラスのインスタンスまたは派生クラスを作成します。Simulink ソフトウェアは、モデルの更新やシミュレーションを実行するときに、Level-2 MATLAB S-Function のコールバック メソッドにこのオブジェクトを渡します。これにより、コールバック メソッドは、Simulink ソフトウェアとブロックに関連する情報のやり取りをすることができます。詳細は、『Writing S-Functions』のWrite Level-2 MATLAB S-Functionsを参照してください。MATLAB プログラムにこのクラスのインスタンスを使用して、シミュレーション実行中にブロックに関する情報を得ることもできます。詳細については、シミュレーション中のブロック データへのアクセスを参照してください。

メモ:

Simulink.RunTimeBlock オブジェクトは、MATLAB スパース行列をサポートしません。たとえば、以下のコードは、スパース単位行列をランタイム オブジェクトの出力端子データに割り当てます。Level-2 MATLAB S-Function ではこのコードはエラーを出力します。

  block.Outport(1).Data = speye(10);

親クラス

なし

プロパティのまとめ

名前

説明

BlockHandle

ブロックのハンドル。

CurrentTime

現在のシミュレーション時間。

NumDworks

ブロックにより使用される離散作業ベクトルの数。

NumOutputPorts

ブロック出力端子の数。

NumContStates

ブロックの連続状態の数。

NumDworkDiscStates

ブロックの離散状態の数。

NumDialogPrms

S-Function ブロックのダイアログ ボックスで入力可能なパラメーターの数。

NumInputPorts

ブロックの入力端子の数。

NumRuntimePrms

ブロックにより使用されるランタイム パラメーターの数。

SampleTime

ブロックが出力を生成するサンプル時間。

メソッドのまとめ

名前

説明

ContStates

ブロックの連続状態を取得します。

DataTypeIsFixedPoint

データ型が固定小数点かどうかを判定します。

DatatypeName

このブロックによりサポートされるデータ型名を取得します。

DatatypeSize

このブロックによりサポートされるデータ型のサイズを取得します。

Derivatives

ブロックの連続状態の微分係数を取得します。

DialogPrm

S-Function ブロックのダイアログ ボックスに入力されたパラメーターを取得します。

Dwork

ブロックの Dwork ベクトルの 1 つを取得します。

FixedPointNumericType

固定小数点データ型のプロパティを判定します。

InputPort

ブロックの入力端子の 1 つを取得します。

OutputPort

ブロックの出力端子の 1 つを取得します。

RuntimePrm

ブロックにより使用されるランタイム パラメーターの 1 つを取得します。

プロパティ

BlockHandle

説明

ブロックのハンドル。

アクセス

RO

CurrentTime

説明

現在のシミュレーション時間。

アクセス

RO

NumDworks

説明

データ作業ベクトルの数。

アクセス

RW

NumOutputPorts

説明

出力端子の数。

アクセス

RW

NumContStates

説明

連続状態の数。

アクセス

RW

NumDworkDiscStates

説明

離散状態の数。MATLAB S-Function では、離散状態を設定するために DWork を使用しなければなりません。

アクセス

RW

NumDialogPrms

説明

ブロックのダイアログで宣言されるパラメーターの数。S-Function の場合、[S-Function parameters] ダイアログ フィールドのコンマで区切られたリストとして、リストされたパラメーターの数を返します。

アクセス

RW

NumInputPorts

説明

入力端子の数。

アクセス

RW

NumRuntimePrms

説明

ブロックにより使用されるランタイム パラメーターの数。詳細については、Create and Update S-Function Run-Time Parametersを参照してください。

アクセス

RW

SampleTime

説明

ブロックのサンプル時間。

アクセス

MATLAB の S-Function に対して RW、他のすべてのブロックに対して RO

メソッド

ContStates

目的

ブロックの連続状態を取得します。

構文

states = ContStates();

説明

連続状態のベクトルを取得します。

DataTypeIsFixedPoint

目的

データ型が固定小数点かどうかを判定します。

構文

bVal = DataTypeIsFixedPoint(dtID);

引数

dtID

データ型の ID を指定する整数値。

説明

データ型が固定小数点である場合 true を返します。

DatatypeName

目的

データ型名を取得します。

構文

name = DatatypeName(dtID);

引数

dtID

データ型の ID を指定する整数値。

説明

dtID により指定されるデータ型の名前を返します。

DatatypeSize

目的

データ型のサイズを取得します。

構文

size = DatatypeSize(dtID);

引数

dtID

データ型の ID を指定する整数値。

説明

dtID により指定されるデータ型のサイズを返します。

Derivatives

目的

ブロックの連続状態の微係数を取得します。

構文

derivs = Derivatives();

説明

状態の微係数のベクトルを取得します。

参考

ssGetdX

DialogPrm

目的

S-Function のダイアログ パラメーターを取得します。

構文

param = DialogPrm(pIdx);

引数

pIdx

返されるパラメーターのインデックスを示す整数値。

説明

指定したダイアログ パラメーターを取得します。S-Function の場合、各 DialogPrm は、[S-Function parameters] ダイアログ フィールドのコンマで区切られたパラメーター リスト内の要素の 1 つに対応します。

Dwork

目的

ブロックの Dwork ベクトルの 1 つを取得します。

構文

dworkObj = Dwork(dwIdx);

引数

dwIdx

作業ベクトルのインデックスを示す整数値。

説明

dwIdx により指定される Dwork ベクトルの情報を取得します。ここで、dwIdx は、作業ベクトルのインデックス番号です。このメソッドは、タイプ Simulink.BlockCompDworkData のオブジェクトを返します。

FixedPointNumericType

目的

固定小数点データ型のプロパティを取得します。

構文

eno = FixedPointNumericType(dtID);

引数

dtID

固定小数点データ型の ID を指定する整数値。

説明

指定した固定小数点データ型の属性を含んでいる embedded.Numeric クラスのオブジェクトを返します。

メモ:

embedded.Numeric は、Fixed-Point Designer™ ソフトウェアで作成された numerictype オブジェクトのクラスでもあります。embedded.Numeric クラスで定義されるプロパティの詳細については、numerictype オブジェクト プロパティ (Fixed-Point Designer)を参照してください。

InputPort

目的

ブロックの入力端子を取得します。

構文

port = InputPort(pIdx);

引数

pIdx

入力端子のインデックスを指定する整数値。

説明

pIdx で指定される入力端子を取得します。ここで、pIdx は入力端子のインデックス番号です。たとえば、

port = rto.InputPort(1)

は、ランタイム オブジェクト rto によって表されるブロックの最初の入力端子を返します。

このメソッドは、この端子を含むモデルがコンパイル済みか未コンパイルかに依存して、Simulink.BlockPreCompInputPortData または Simulink.BlockCompInputPortData タイプのオブジェクトを返します。このオブジェクトを使って、それぞれ、入力端子の未コンパイルまたはコンパイル済みのプロパティを取得または設定できます。

OutputPort

目的

ブロックの出力端子を取得します。

構文

port = OutputPort(pIdx);

引数

pIdx

出力端子のインデックスを指定する整数値。

説明

pIdx で指定される出力端子を取得します。ここで、pIdx は、出力端子のインデックス番号です。たとえば、次のコマンドを実行します。

port = rto.OutputPort(1)

は、ランタイム オブジェクト rto によって表されるブロックの 1 番目の出力端子を返します。

このメソッドは、この端子を含むモデルがコンパイル済みか未コンパイルかに依存して、Simulink.BlockPreCompOutputPortData または Simulink.BlockCompOutputPortData タイプのオブジェクトを返します。このオブジェクトを使って、それぞれ、出力端子の未コンパイルまたはコンパイル済みのプロパティを取得または設定できます。

RuntimePrm

目的

S-Function のランタイム パラメーターを取得します。

構文

param = RuntimePrm(pIdx);

引数

pIdx

ランタイム パラメーターのインデックスを示す整数値。

説明

インデックスが pIdx であるランタイム パラメーターを取得します。このランタイム パラメーターは、タイプ Simulink.BlockRunTimePrmData の Simulink.BlockData オブジェクトです。

R2006a より前に導入