getSampleTime

クラス: matlab.System

サンプル時間のクエリ

構文

sts = getSampleTime(obj)


説明

sts = getSampleTime(obj) は、System object™ が MATLAB System ブロックに含まれている場合、System object obj のサンプル時間の指定を返します。stepImpl メソッドで getSampleTime を呼び出して、サンプル時間に基づいてアルゴリズムを変更できます。

サンプル時間が MATLAB System ブロック モデル全体に伝播する前に、getSampleTime は getSampleTimeImpl (Simulink) サンプル時間の指定を返します。System object が getSampleTimeImpl をオーバーライドしない場合、既定のサンプル時間の指定 Inherited が返されます。

サンプル時間が伝播した後、getSampleTime は、実際の MATLAB System ブロックのサンプル時間タイプ、サンプル時間、およびオフセット時間が設定されたサンプル時間の指定を返します。

入力引数

obj — System object

System object

クエリする MATLAB System ブロックに含まれる System object。

出力引数

sts — サンプル時間指定オブジェクト

サンプル時間指定オブジェクト

System object のサンプル時間の指定。サンプル時間指定オブジェクトの詳細については、createSampleTime を参照してください。

例

サンプル時間を返す

この stepImpl の例は、カウント値 y、現在のシミュレーション時間 ct およびサンプル時間 st を返します。サンプル時間は、getSampleTime を呼び出すことで得られます。

function [y,ct,st] = stepImpl(obj,u)
      y = obj.Count + u;
      obj.Count = y;
      ct = getCurrentTime(obj);
      sts = getSampleTime(obj);
      st = sts.SampleTime;
    end

完全なクラス定義については、MATLAB System ブロックの System object のサンプル時間の指定 (Simulink)を参照してください。

バージョン履歴

R2017b で導入

参考

createSampleTime (Simulink) | getCurrentTime (Simulink) | getSampleTimeImpl (Simulink)

トピック

• MATLAB System ブロックの System object のサンプル時間の指定 (Simulink)