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

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

public interface BufferBase<DataType>

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


メソッドの概要
 ReturnCode advanceRptr()
           advanceRptr
 ReturnCode advanceRptr(int n)
           advanceRptr
 ReturnCode advanceWptr()
           advanceWptr
 ReturnCode advanceWptr(int n)
           advanceWptr
 boolean empty()
           empty
 boolean full()
           full
 DataType get()
          バッファからデータを読み込みます。
 ReturnCode get(DataRef<DataType> value)
           
 void init(Properties prop)
           init
 int length()
          バッファ長を取得します。
 ReturnCode length(int n)
           
 ReturnCode put(DataType data)
          バッファにデータを書き込みます。
 ReturnCode read(DataRef<DataType> valueRef)
          バッファからデータを読み込みます。
 ReturnCode read(DataRef<DataType> valueRef, int sec, int nsec)
           
 int readable()
           readable
 ReturnCode reset()
           reset
 DataType rptr()
           rptr
 DataType rptr(int n)
           rptr
 DataType wptr()
           wptr
 DataType wptr(int n)
           wptr
 int writable()
           writable
 ReturnCode write(DataType value)
          バッファにデータを書き込みます。
 ReturnCode write(DataType value, int sec, int nsec)
           
 

メソッドの詳細

init

void init(Properties prop)

init

パラメータ:
prop -

reset

ReturnCode reset()

reset

戻り値:
ReturnCode

wptr

DataType wptr(int n)

wptr

パラメータ:
n -
戻り値:
DataType

wptr

DataType wptr()

wptr

戻り値:
DataType

advanceWptr

ReturnCode advanceWptr(int n)

advanceWptr

パラメータ:
n -
戻り値:
ReturnCode

advanceWptr

ReturnCode advanceWptr()

advanceWptr

戻り値:
ReturnCode

writable

int writable()

writable

戻り値:
size_t

full

boolean full()

full

Check on whether the buffer is full

戻り値:
boolean

rptr

DataType rptr(int n)

rptr

パラメータ:
n -
戻り値:
DataType

rptr

DataType rptr()

rptr

戻り値:
DataType

advanceRptr

ReturnCode advanceRptr()

advanceRptr

戻り値:
ReturnCode

advanceRptr

ReturnCode advanceRptr(int n)

advanceRptr

パラメータ:
n -
戻り値:
ReturnCode

readable

int readable()

readable

戻り値:
size_t

empty

boolean empty()

empty

Check on whether the buffer is empty.

戻り値:
boolean

length

int length()

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

戻り値:
バッファ長

length

ReturnCode length(int n)

write

ReturnCode write(DataType value)

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

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

write

ReturnCode write(DataType value,
                 int sec,
                 int nsec)

read

ReturnCode read(DataRef<DataType> valueRef)

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

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

read

ReturnCode read(DataRef<DataType> valueRef,
                int sec,
                int nsec)

put

ReturnCode put(DataType data)

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

パラメータ:
data - 書き込むデータ
戻り値:
ReturnCode

get

DataType get()

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

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

get

ReturnCode get(DataRef<DataType> value)