Public Member Functions | |
| 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) |
Detailed Description
Member Function Documentation
◆ advanceRptr()
| def OpenRTM_aist.BufferBase.BufferBase.advanceRptr | ( | self, | |
n = 1, |
|||
unlock_enable = True |
|||
| ) |
Get the buffer length
Pure virtual function to get the buffer length.
- Returns
- buffer length
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
◆ advanceWptr()
| def OpenRTM_aist.BufferBase.BufferBase.advanceWptr | ( | self, | |
n = 1, |
|||
unlock_enable = True |
|||
| ) |
Get the buffer length
Pure virtual function to get the buffer length.
- Returns
- buffer length
Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.
◆ empty()
| 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.
◆ full()
| 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.
◆ get()
| def OpenRTM_aist.BufferBase.BufferBase.get | ( | self | ) |
Get data from the buffer
Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.
◆ length()
| def OpenRTM_aist.BufferBase.BufferBase.length | ( | self | ) |
Get the buffer length
- Returns
- buffer length
Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.
◆ put()
| def OpenRTM_aist.BufferBase.BufferBase.put | ( | self, | |
| data | |||
| ) |
Write data into the buffer
Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.
◆ read()
| def OpenRTM_aist.BufferBase.BufferBase.read | ( | self, | |
sec = -1, |
|||
nsec = -1 |
|||
| ) |
Read data from the buffer
Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.
◆ readable()
| 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.
◆ reset()
| 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.
◆ rptr()
| 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.
◆ wptr()
| 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.
◆ writable()
| 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.
◆ write()
| 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:
- C:/docs/OpenRTM-aist-Python/OpenRTM_aist/BufferBase.py
