BufferBase abstract class. More...
Public Member Functions | |
| def | advanceRptr (self, n=1) |
| Get the buffer length. More... | |
| def | advanceWptr (self, n=1) |
| Get the buffer length. More... | |
| def | empty (self) |
| Check on whether the buffer is empty. More... | |
| def | full (self) |
| Check on whether the buffer is full. More... | |
| def | get (self) |
| Get data from the buffer. More... | |
| def | init (self, prop) |
| def | length (self) |
| Get the buffer length. More... | |
| def | put (self, data) |
| Write data into the buffer. More... | |
| def | read (self, value, sec=-1, nsec=-1) |
| Read data from the buffer. More... | |
| def | readable (self) |
| Write data into the buffer. More... | |
| def | reset (self) |
| Get the buffer length. More... | |
| def | rptr (self, n=0) |
| Get the buffer length. More... | |
| def | wptr (self, n=0) |
| Get the buffer length. More... | |
| def | writable (self) |
| Write data into the buffer. More... | |
| def | write (self, value, sec=-1, nsec=-1) |
| Write data into the buffer. More... | |
 Public Member Functions inherited from OpenRTM_aist.BufferStatus.BufferStatus | |
| def | toString (self, status) |
Additional Inherited Members | |
| Static Public Attributes inherited from OpenRTM_aist.BufferStatus.BufferStatus | |
| int | BUFFER_EMPTY = 3 |
| int | BUFFER_ERROR = 1 |
| int | BUFFER_FULL = 2 |
| int | BUFFER_OK = 0 |
| int | NOT_SUPPORTED = 4 |
| int | PRECONDITION_NOT_MET = 6 |
| int | TIMEOUT = 5 |
Detailed Description
BufferBase abstract class.
This is the abstract interface class for various Buffer.
- Since
- 0.4.0
Definition at line 51 of file BufferBase.py.
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
Definition at line 326 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.advanceWptr | ( | self, | |
n = 1 |
|||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns
- buffer length
Definition at line 189 of file BufferBase.py.
| 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.
Definition at line 418 of file BufferBase.py.
| 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.
Definition at line 280 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.get | ( | self | ) |
Get data from the buffer.
Definition at line 347 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.init | ( | self, | |
| prop | |||
| ) |
Definition at line 94 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.length | ( | self | ) |
| def OpenRTM_aist.BufferBase.BufferBase.put | ( | self, | |
| data | |||
| ) |
Write data into the buffer.
Definition at line 209 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.read | ( | self, | |
| value, | |||
sec = -1, |
|||
nsec = -1 |
|||
| ) |
Read data from the buffer.
Definition at line 369 of file BufferBase.py.
| 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)
Definition at line 396 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.reset | ( | self | ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns
- buffer length
Definition at line 142 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.rptr | ( | self, | |
n = 0 |
|||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns
- buffer length
Definition at line 303 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.wptr | ( | self, | |
n = 0 |
|||
| ) |
Get the buffer length.
Pure virtual function to get the buffer length.
- Returns
- buffer length
Definition at line 165 of file BufferBase.py.
| 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)
Definition at line 258 of file BufferBase.py.
| def OpenRTM_aist.BufferBase.BufferBase.write | ( | self, | |
| value, | |||
sec = -1, |
|||
nsec = -1 |
|||
| ) |
Write data into the buffer.
Definition at line 231 of file BufferBase.py.
The documentation for this class was generated from the following file: