OpenRTM-aist
1.2.1
|
Concrete buffer class for dummy. More...
#include <BufferBase.h>
Public Member Functions | |
NullBuffer (long int size=1) | |
Constructer. More... | |
virtual | ~NullBuffer (void) |
Destructor. More... | |
virtual long int | length (void) const |
Get the buffer length (always 1) More... | |
virtual bool | write (const DataType &value) |
Write data into the buffer. More... | |
virtual bool | read (DataType &value) |
Read data from the buffer. More... | |
virtual bool | isFull (void) const |
Check on whether the buffer is full. More... | |
virtual bool | isEmpty (void) const |
Check on whether the buffer is empty. More... | |
Public Member Functions inherited from RTC::BufferBase< DataType > | |
virtual BUFFERSTATUS_ENUM | ~BufferBase (void) |
Virtual destructor. More... | |
virtual void | init (const coil::Properties &prop)=0 |
Set the buffer. More... | |
virtual ReturnCode | length (size_t n)=0 |
Set the buffer length. More... | |
virtual ReturnCode | reset ()=0 |
Reset the buffer status. More... | |
virtual DataType * | wptr (long int n=0)=0 |
Get the writing pointer. More... | |
virtual ReturnCode | advanceWptr (long int n=1, bool unlock_enable=true)=0 |
Forward n writing pointers. More... | |
virtual ReturnCode | write (const DataType &value, long int sec=-1, long int nsec=-1)=0 |
Write data into the buffer. More... | |
virtual size_t | writable () const =0 |
Get a writable number. More... | |
virtual bool | full (void) const =0 |
Check on whether the buffer is full. More... | |
virtual DataType * | rptr (long int n=0)=0 |
Get the reading pointer. More... | |
virtual ReturnCode | advanceRptr (long int n=1, bool unlock_enable=true)=0 |
Forward n reading pointers. More... | |
virtual ReturnCode | get (DataType &value)=0 |
Read data from the buffer. More... | |
virtual ReturnCode | read (DataType &value, long int sec=-1, long int nsec=-1)=0 |
Read data from the buffer. More... | |
virtual size_t | readable () const =0 |
Write data into the buffer. More... | |
virtual bool | empty (void) const =0 |
Check on whether the buffer is empty. More... | |
Protected Member Functions | |
virtual void | put (const DataType &data) |
Store data into the buffer. More... | |
virtual const DataType & | get (void) |
Get data from the buffer. More... | |
virtual DataType & | getRef (void) |
Get the buffer's reference to be written the next. More... | |
Additional Inherited Members | |
Public Types inherited from RTC::BufferStatus | |
enum | Enum { BUFFER_OK = 0, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, NOT_SUPPORTED, TIMEOUT, PRECONDITION_NOT_MET } |
DataPortStatus return codes. More... | |
Static Public Member Functions inherited from RTC::BufferStatus | |
static const char * | toString (Enum status) |
Convert BufferStatus into the string. More... | |
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 <DataType>.
DataType | Data type to hold in a buffer |
|
inline |
Constructer.
Constructer. Initialize buffer length to always 1.
size | Buffer length(Not use) |
|
inlinevirtual |
Destructor.
Destractor
|
inlineprotectedvirtual |
Get data from the buffer.
Get data from the buffer.
Implements RTC::BufferBase< DataType >.
|
inlineprotectedvirtual |
Get the buffer's reference to be written the next.
Get the reference to be written buffer. Return always same position because this buffer's length is always 1.
|
inlinevirtual |
Check on whether the buffer is empty.
Check on whether the buffer is empty. (Always false.)
|
inlinevirtual |
Check on whether the buffer is full.
Check on whether the buffer is full. (Always false.)
|
inlinevirtual |
Get the buffer length (always 1)
Get the buffer length. (Return always 1.)
Implements RTC::BufferBase< DataType >.
|
inlineprotectedvirtual |
Store data into the buffer.
Store data which were given with an argument into the buffer.
data | Target data to store. |
Implements RTC::BufferBase< DataType >.
|
inlinevirtual |
Read data from the buffer.
Read data stored in the buffer.
value | Read data. |
|
inlinevirtual |
Write data into the buffer.
Write data which were given with an argument into the buffer.
value | Target data to write. |