getSampleTimeImpl

クラス: matlab.System

サンプル時間タイプ、オフセット時間およびサンプル時間を指定

構文

sts = getSampleTimeImpl(obj)


説明

sts = getSampleTimeImpl(obj) は、System object™ obj のメソッド本体内で作成されたサンプル時間の指定 sts を返します。getSampleTimeImpl の本体内でサンプル時間の指定を行うには、createSampleTime (Simulink) を呼び出します。System object が MATLAB System ブロックに含まれている場合、サンプル時間の指定はシミュレーション時間に影響します。

実行時の詳細

getSampleTimeImpl は setupImpl によるセットアップ時に呼び出されます。

メソッドのオーサリングのヒント

このメソッドでは Access = protected と設定しなければなりません。

既定の動作

このメソッドを System object 定義に含めない場合、サンプル時間が継承されます。

入力引数

obj — System object

System object

オブジェクト固有のプロパティ、状態、およびメソッドへのアクセスに使用される System object ハンドル。getSampleTimeImpl メソッドがこのオブジェクトを使用しない場合、この入力を ~ に置き換えることができます。

出力引数

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

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

サンプル時間の指定の値を定義するオブジェクト。関数 createSampleTime (Simulink) を使用してこのオブジェクトを作成します。

例

サンプル時間の継承の指定

サンプル時間タイプが制御可能である場合を除き、MATLAB System ブロックが上流ブロックからサンプルを継承することを指定します。

function sts = getSampleTimeImpl(obj)
    sts = createSampleTime(obj,'ErrorOnPropagation','Controllable');
end

離散サンプル時間の指定

MATLAB System ブロックに離散サンプル時間を指定します。

function sts = getSampleTimeImpl(obj)
    sts = createSampleTime(obj,'Type','Discrete',...
      'SampleTime',10.2,'OffsetTime',0.5);
end

バージョン履歴

R2017b で導入

参考

createSampleTime (Simulink) | getCurrentTime (Simulink) | getSampleTime (Simulink)

トピック

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