OpenRTM-aist-Python 2.0.2
|
Public Member Functions | |
__init__ (self, length=RINGBUFFER_DEFAULT_LENGTH) | |
init (self, prop) | |
void init(const coil.Properties& prop) | |
length (self, n=None) | |
reset (self) | |
wptr (self, n=0) | |
advanceWptr (self, n=1, unlock_enable=True) | |
put (self, value) | |
write (self, value, sec=-1, nsec=0) | |
writable (self) | |
full (self) | |
rptr (self, n=0) | |
advanceRptr (self, n=1, unlock_enable=True) | |
get (self) | |
read (self, sec=-1, nsec=0) | |
readable (self) | |
empty (self) | |
OpenRTM_aist.RingBuffer.RingBuffer.__init__ | ( | self, | |
length = RINGBUFFER_DEFAULT_LENGTH ) |
Constructor
Constructor. Initialize the buffer by specified buffer length. However, if the specified length is less than two, the buffer should be initialized by two in length.
length | Buffer length |
Reimplemented in OpenRTM_aist.CdrRingBuffer.CdrRingBuffer.
OpenRTM_aist.RingBuffer.RingBuffer.advanceRptr | ( | self, | |
n = 1, | |||
unlock_enable = True ) |
Get the buffer length
Pure virtual function to get the buffer length.
n | |
unlock_enable |
DataType* rptr(long int n = 0)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.advanceWptr | ( | self, | |
n = 1, | |||
unlock_enable = True ) |
Get the buffer length
Pure virtual function to get the buffer length.
n | |
unlock_enable |
ReturnCode advanceWptr(long int n = 1)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.empty | ( | self | ) |
Check on whether the buffer is empty.
Pure virtual function to check on whether the buffer is empty.
bool empty(void) const
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.full | ( | self | ) |
Check on whether the buffer is full.
Pure virtual function to check on whether the buffer is full.
bool full(void) const
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.get | ( | self | ) |
Write data into the buffer
Pure virtual function to write data into the buffer.
value | Target data to write. |
ReturnCode get(DataType& value)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.length | ( | self, | |
n = None ) |
Get the buffer length
size_t length(void) const
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.put | ( | self, | |
value ) |
Write data into the buffer
Pure virtual function to write data into the buffer.
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.read | ( | self, | |
sec = -1, | |||
nsec = 0 ) |
Readout data from the buffer
Readout data stored into the buffer.
value(list) | Readout data |
ReturnCode read(DataType& value, long int sec = -1, long int nsec = 0)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.readable | ( | self | ) |
Write data into the buffer
Pure virtual function to write data into the buffer.
value | Target data to write. |
size_t readable() const
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.reset | ( | self | ) |
Get the buffer length
Pure virtual function to get the buffer length.
ReturnCode reset()
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.rptr | ( | self, | |
n = 0 ) |
Get the buffer length
Pure virtual function to get the buffer length.
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.wptr | ( | self, | |
n = 0 ) |
Get the buffer length
Pure virtual function to get the buffer length.
DataType* wptr(long int n = 0)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.writable | ( | self | ) |
Write data into the buffer
Pure virtual function to write data into the buffer.
value | Target data to write. |
size_t writable() const
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
OpenRTM_aist.RingBuffer.RingBuffer.write | ( | self, | |
value, | |||
sec = -1, | |||
nsec = 0 ) |
Write data into the buffer
Write data which is given argument into the buffer.
value | Target data for writing |
ReturnCode write(const DataType& value, long int sec = -1, long int nsec = 0)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.