OpenRTM_aist.RingBuffer.RingBuffer Class Reference
Public Member Functions | |
| def | __init__ |
| Constructor. | |
| def | init |
| void init(const coil.Properties& prop) | |
| def | length |
| Get the buffer length. | |
| def | reset |
| Get the buffer length. | |
| def | wptr |
| Get the buffer length. | |
| def | advanceWptr |
| Get the buffer length. | |
| def | put |
| Write data into the buffer. | |
| def | write |
| Write data into the buffer. | |
| def | writable |
| Write data into the buffer. | |
| def | full |
| Check on whether the buffer is full. | |
| def | rptr |
| Get the buffer length. | |
| def | advanceRptr |
| Get the buffer length. | |
| def | get |
| Write data into the buffer. | |
| def | read |
| Readout data from the buffer. | |
| def | readable |
| Write data into the buffer. | |
| def | empty |
| Check on whether the buffer is empty. | |
Detailed Description
Member Function Documentation
| 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.
- Parameters:
-
length Buffer length
| def OpenRTM_aist.RingBuffer.RingBuffer.advanceRptr | ( | self, | ||
n = 1 | ||||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns:
- buffer length
DataType* rptr(long int n = 0)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
| def OpenRTM_aist.RingBuffer.RingBuffer.advanceWptr | ( | self, | ||
n = 1 | ||||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns:
- buffer length
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.
- Returns:
- True if the buffer is empty, else false.
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.
- Returns:
- True if the buffer is full, else false.
bool full(void) const
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
| def OpenRTM_aist.RingBuffer.RingBuffer.get | ( | self, | ||
value = None | ||||
| ) |
Write data into the buffer.
Pure virtual function to write data into the buffer.
- Parameters:
-
value Target data to write.
- Returns:
- Result of having written in data (true:Successful, false:Failed)
ReturnCode get(DataType& value)
| def OpenRTM_aist.RingBuffer.RingBuffer.length | ( | self, | ||
n = None | ||||
| ) |
Get the buffer length.
size_t length(void) const
| 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, | ||
| value, | ||||
sec = -1, |
||||
nsec = 0 | ||||
| ) |
Readout data from the buffer.
Readout data stored into the buffer.
- Parameters:
-
value(list) Readout data
- Returns:
- Readout result (Always true: readout success is returned)
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.
- Parameters:
-
value Target data to write.
- Returns:
- Result of having written in data (true:Successful, false:Failed)
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.
- Returns:
- 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.
- Returns:
- 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.
- Returns:
- 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.
- Parameters:
-
value Target data to write.
- Returns:
- Result of having written in data (true:Successful, false:Failed)
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.
- Parameters:
-
value Target data for writing
- Returns:
- Writing result (Always true: writing success is returned)
ReturnCode write(const DataType& value, long int sec = -1, long int nsec = 0)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/RingBuffer.py
