OpenRTM_aist.BufferBase.BufferBase Class Reference
BufferBase abstract class. More...
Public Member Functions | |
| 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 |
| Get data from the buffer. | |
| def | read |
| Read data from the buffer. | |
| def | readable |
| Write data into the buffer. | |
| def | empty |
| Check on whether the buffer is empty. | |
Detailed Description
BufferBase abstract class.
This is the abstract interface class for various Buffer.
- Since:
- 0.4.0
Member Function Documentation
| def OpenRTM_aist.BufferBase.BufferBase.advanceRptr | ( | self, | ||
n = 1 | ||||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns:
- buffer length
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.advanceWptr | ( | self, | ||
n = 1 | ||||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns:
- buffer length
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.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.
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.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.
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.get | ( | self | ) |
Get data from the buffer.
Reimplemented in OpenRTM_aist.BufferBase.NullBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.length | ( | self | ) |
| def OpenRTM_aist.BufferBase.BufferBase.put | ( | self, | ||
| data | ||||
| ) |
Write data into the buffer.
Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.read | ( | self, | ||
| value, | ||||
sec = -1, |
||||
nsec = -1 | ||||
| ) |
Read data from the buffer.
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.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)
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.reset | ( | self | ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns:
- buffer length
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.rptr | ( | self, | ||
n = 0 | ||||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns:
- buffer length
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.wptr | ( | self, | ||
n = 0 | ||||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns:
- buffer length
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.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)
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
| def OpenRTM_aist.BufferBase.BufferBase.write | ( | self, | ||
| value, | ||||
sec = -1, |
||||
nsec = -1 | ||||
| ) |
Write data into the buffer.
Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/BufferBase.py
