jp.go.aist.rtm.RTC.buffer
インタフェース BufferBase<DataType>

型パラメータ:
DataType - バッファ内のデータ型を指定します。
既知の実装クラスの一覧:
InPort, NullBuffer, OutPort, RingBuffer

public interface BufferBase<DataType>

バッファのインタフェースです。


メソッドの概要
 DataType get()
          バッファからデータを読み込みます。
 boolean isEmpty()
          バッファが空かどうか判定します。
 boolean isFull()
          バッファがフルかどうか判定します。
 boolean isNew()
          バッファ中に、まだ読み取られていないデータがあるかどうか判定します。
 int length()
          バッファ長を取得します。
 void put(DataType data)
          バッファにデータを書き込みます。
 boolean read(DataRef<DataType> valueRef)
          バッファからデータを読み込みます。
 boolean write(DataType value)
          バッファにデータを書き込みます。
 

メソッドの詳細

length

int length()

バッファ長を取得します。

戻り値:
バッファ長

write

boolean write(DataType value)

バッファにデータを書き込みます。

パラメータ:
value - 書き込むデータ
戻り値:
書き込みに成功した場合はtrueを、さもなくばfalseを返します。

read

boolean read(DataRef<DataType> valueRef)

バッファからデータを読み込みます。

パラメータ:
valueRef - 読み込んだデータを受け取るためのDataRefオブジェクト
戻り値:
読み込みに成功した場合はtrueを、さもなくばfalseを返します。

isFull

boolean isFull()

バッファがフルかどうか判定します。

戻り値:
バッファがフルならばtrue、さもなくばfalseを返します。

isEmpty

boolean isEmpty()

バッファが空かどうか判定します。

戻り値:
バッファが空ならばtrue、さもなくばfalseを返します。

put

void put(DataType data)

バッファにデータを書き込みます。

パラメータ:
data - 書き込むデータ

get

DataType get()

バッファからデータを読み込みます。

戻り値:
読み込んだデータ

isNew

boolean isNew()

バッファ中に、まだ読み取られていないデータがあるかどうか判定します。

戻り値:
読み取られていないデータがあればtrueを、さもなくばfalseを返します。