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) |
Detailed Description
Constructor & Destructor Documentation
◆ __init__()
| 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
Reimplemented in OpenRTM_aist.CdrRingBuffer.CdrRingBuffer.
Member Function Documentation
◆ advanceRptr()
| def OpenRTM_aist.RingBuffer.RingBuffer.advanceRptr | ( | self, | |
n = 1, |
|||
unlock_enable = True |
|||
| ) |
Get the buffer length
Pure virtual function to get the buffer length.
- Parameters
-
n unlock_enable
- Returns
- buffer length
DataType* rptr(long int n = 0)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
◆ advanceWptr()
| def OpenRTM_aist.RingBuffer.RingBuffer.advanceWptr | ( | self, | |
n = 1, |
|||
unlock_enable = True |
|||
| ) |
Get the buffer length
Pure virtual function to get the buffer length.
- Parameters
-
n unlock_enable
- Returns
- buffer length
ReturnCode advanceWptr(long int n = 1)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
◆ empty()
| 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.
◆ full()
| 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.
◆ get()
| def OpenRTM_aist.RingBuffer.RingBuffer.get | ( | 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)
ReturnCode get(DataType& value)
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
◆ length()
| def OpenRTM_aist.RingBuffer.RingBuffer.length | ( | self, | |
n = None |
|||
| ) |
Get the buffer length
size_t length(void) const
Reimplemented from OpenRTM_aist.BufferBase.BufferBase.
◆ put()
| 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.
◆ read()
| def OpenRTM_aist.RingBuffer.RingBuffer.read | ( | self, | |
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.
◆ readable()
| 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.
◆ reset()
| 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.
◆ rptr()
| 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.
◆ wptr()
| 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.
◆ writable()
| 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.
◆ write()
| 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:
- C:/docs/OpenRTM-aist-Python/OpenRTM_aist/RingBuffer.py
