OpenRTM-aist-Python 1.1.2
Public Member Functions | List of all members
OpenRTM_aist.BufferBase.BufferBase Class Reference

BufferBase abstract class. More...

Inheritance diagram for OpenRTM_aist.BufferBase.BufferBase:
OpenRTM_aist.BufferStatus.BufferStatus OpenRTM_aist.BufferBase.NullBuffer OpenRTM_aist.CdrBufferBase.CdrBufferBase OpenRTM_aist.RingBuffer.RingBuffer OpenRTM_aist.CdrRingBuffer.CdrRingBuffer

Public Member Functions

def length
 Get the buffer length. More...
 
def reset
 Get the buffer length. More...
 
def wptr
 Get the buffer length. More...
 
def advanceWptr
 Get the buffer length. More...
 
def put
 Write data into the buffer. More...
 
def write
 Write data into the buffer. More...
 
def writable
 Write data into the buffer. More...
 
def full
 Check on whether the buffer is full. More...
 
def rptr
 Get the buffer length. More...
 
def advanceRptr
 Get the buffer length. More...
 
def get
 Get data from the buffer. More...
 
def read
 Read data from the buffer. More...
 
def readable
 Write data into the buffer. More...
 
def empty
 Check on whether the buffer is empty. More...
 

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
def OpenRTM_aist.BufferBase.BufferBase.advanceWptr (   self,
  n = 1 
)

Get the buffer length.

Pure virtual function to get the buffer length.

Returns
buffer length
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.
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.
def OpenRTM_aist.BufferBase.BufferBase.get (   self)

Get data from the buffer.

def OpenRTM_aist.BufferBase.BufferBase.length (   self)

Get the buffer length.

Returns
buffer length
def OpenRTM_aist.BufferBase.BufferBase.put (   self,
  data 
)

Write data into the buffer.

def OpenRTM_aist.BufferBase.BufferBase.read (   self,
  value,
  sec = -1,
  nsec = -1 
)

Read data from the buffer.

def OpenRTM_aist.BufferBase.BufferBase.readable (   self)

Write data into the buffer.

Pure virtual function to write data into the buffer.

Parameters
valueTarget data to write.
Returns
Result of having written in data (true:Successful, false:Failed)
def OpenRTM_aist.BufferBase.BufferBase.reset (   self)

Get the buffer length.

Pure virtual function to get the buffer length.

Returns
buffer length
def OpenRTM_aist.BufferBase.BufferBase.rptr (   self,
  n = 0 
)

Get the buffer length.

Pure virtual function to get the buffer length.

Returns
buffer length
def OpenRTM_aist.BufferBase.BufferBase.wptr (   self,
  n = 0 
)

Get the buffer length.

Pure virtual function to get the buffer length.

Returns
buffer length
def OpenRTM_aist.BufferBase.BufferBase.writable (   self)

Write data into the buffer.

Pure virtual function to write data into the buffer.

Parameters
valueTarget data to write.
Returns
Result of having written in data (true:Successful, false:Failed)
def OpenRTM_aist.BufferBase.BufferBase.write (   self,
  value,
  sec = -1,
  nsec = -1 
)

Write data into the buffer.


The documentation for this class was generated from the following file: