OpenRTM-aist-Python 2.0.0
|
Public Member Functions | |
def | __init__ (self, length=RINGBUFFER_DEFAULT_LENGTH) |
def | init (self, prop) |
void init(const coil::Properties& prop) | |
def | length (self, n=None) |
def | reset (self) |
def | wptr (self, n=0) |
def | advanceWptr (self, n=1, unlock_enable=True) |
def | put (self, value) |
def | write (self, value, sec=-1, nsec=0) |
def | writable (self) |
def | full (self) |
def | rptr (self, n=0) |
def | advanceRptr (self, n=1, unlock_enable=True) |
def | get (self) |
def | read (self, sec=-1, nsec=0) |
def | readable (self) |
def | empty (self) |
def | init (self, prop) |
def | length (self) |
def | reset (self) |
def | wptr (self, n=0) |
def | advanceWptr (self, n=1, unlock_enable=True) |
def | put (self, data) |
def | write (self, value, sec=-1, nsec=-1) |
def | writable (self) |
def | full (self) |
def | rptr (self, n=0) |
def | advanceRptr (self, n=1, unlock_enable=True) |
def | get (self) |
def | read (self, sec=-1, nsec=-1) |
def | readable (self) |
def | empty (self) |
def 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.
def 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.
def 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.
def 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.
def 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.
def 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.
def OpenRTM_aist.RingBuffer.RingBuffer.length | ( | self, | |
n = None |
|||
) |
Get the buffer length
size_t length(void) const
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
def 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.
def 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.
def 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.
def 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.
def 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.
def 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.
def 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.
def 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.