NullBuffer

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jp.go.aist.rtm.RTC.buffer
Class NullBuffer<DataType>

java.lang.Object
  jp.go.aist.rtm.RTC.buffer.NullBuffer<DataType>


Type Parameters:: DataType - Data type to hold in a buffer

public class NullBuffer<DataType>
extends java.lang.Object
extends java.lang.Object

Concrete buffer class for dummy.

Concrete buffer class for dummy. Buffer length is fixed to 1. The users specify data type to hold it in a buffer as \.

Constructor Summary
`NullBuffer()` Default Constructer.
`NullBuffer(long size)` Constructer.

Method Summary
`ReturnCode`	`advanceRptr()` This function is not implemented.
`ReturnCode`	`advanceRptr(int n)` This function is not implemented.
`ReturnCode`	`advanceWptr()` This function is not implemented.
`ReturnCode`	`advanceWptr(int n)` This function is not implemented.
`boolean`	`empty()` This function is not implemented.
`boolean`	`full()` This function is not implemented.
`DataType`	`get()` Get data from the buffer
`ReturnCode`	`get(DataType value)` This function is not implemented.
`void`	`init(Properties prop)` This function is not implemented.
`boolean`	`isEmpty()` Check on whether the buffer is empty.
`boolean`	`isFull()` Check on whether the buffer is full.
`boolean`	`isNew()` Check whether the data is newest
`int`	`length()` Get the buffer length (always 1)
`ReturnCode`	`length(int n)` This function is not implemented.
`ReturnCode`	`put(DataType data)` Store data into the buffer
`boolean`	`read(DataRef<DataType> valueRef)` Read data from the buffer
`int`	`readable()` This function is not implemented.
`ReturnCode`	`reset()` This function is not implemented.
`DataType`	`rptr()` This function is not implemented.
`DataType`	`rptr(int n)` This function is not implemented.
`DataType`	`wptr()` This function is not implemented.
`DataType`	`wptr(int n)` This function is not implemented.
`int`	`writable()` This function is not implemented.
`ReturnCode`	`write(DataType value)` Write data into the buffer

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

NullBuffer

public NullBuffer(long size)

Constructer.

Initialize buffer length to always 1.

Parameters:: size - Buffer length

NullBuffer

public NullBuffer()

Default Constructer.

Method Detail

length

public int length()

Get the buffer length (always 1)

Get the buffer length. (Return always 1.)

Returns:: buffer length(always 1)

write

public ReturnCode write(DataType value)

Write data into the buffer

Write data which were given with an argument into the buffer.

Parameters:: value - Target data to write.
Returns:: Result of having written in data (true:Successful, false:Failed)

read

public boolean read(DataRef<DataType> valueRef)

Read data from the buffer

Read data stored in the buffer.

Parameters:: valueRef - Object of DataRef type to receive read data
Returns:: Result of having read (true:Successful, false:Failed)

isFull

public boolean isFull()

Check on whether the buffer is full.

Check on whether the buffer is full. (Always false.)

Returns:: Always false.

isEmpty

public boolean isEmpty()

Check on whether the buffer is empty.

Check on whether the buffer is empty. (Always false.)

Returns:: Always false.

put

public ReturnCode put(DataType data)

Store data into the buffer

Store data which were given with an argument into the buffer.

Parameters:: data - Target data to store.

get

public DataType get()

Get data from the buffer

Get data from the buffer.

Returns:: Data got from buffer.

isNew

public boolean isNew()

Check whether the data is newest

Check whether the data stored at a current buffer position is newest.

Returns:: Newest data check result ( true:Newest data. Data has not been readout yet. false:Past data．Data has already been readout.)