Public Member Functions | Private Attributes | List of all members
OpenRTM_aist.BufferBase.NullBuffer Class Reference
Inheritance diagram for OpenRTM_aist.BufferBase.NullBuffer:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, size=None)
 
def get (self)
 Get data from the buffer. More...
 
def getRef (self)
 Get the buffer's reference to be written the next. More...
 
def isEmpty (self)
 Always false. More...
 
def isFull (self)
 Always false. More...
 
def isNew (self)
 
def length (self)
 Get the buffer length. More...
 
def put (self, data)
 Write data into the buffer. More...
 
def read (self, value)
 Read data from the buffer. More...
 
def write (self, value, sec=-1, nsec=-1)
 Write data into the buffer. More...
 
- Public Member Functions inherited from OpenRTM_aist.BufferBase.BufferBase
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)
 

Private Attributes

 _data
 
 _inited
 
 _is_new
 
 _length
 

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

 

Definition at line 437 of file BufferBase.py.

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.BufferBase.NullBuffer.__init__ (   self,
  size = None 
)

Definition at line 457 of file BufferBase.py.

Member Function Documentation

◆ get()

def OpenRTM_aist.BufferBase.NullBuffer.get (   self)

Get data from the buffer.

Definition at line 630 of file BufferBase.py.

◆ getRef()

def OpenRTM_aist.BufferBase.NullBuffer.getRef (   self)

Get the buffer's reference to be written the next.

Definition at line 653 of file BufferBase.py.

◆ isEmpty()

def OpenRTM_aist.BufferBase.NullBuffer.isEmpty (   self)

Always false.

Definition at line 569 of file BufferBase.py.

◆ isFull()

def OpenRTM_aist.BufferBase.NullBuffer.isFull (   self)

Always false.

Definition at line 548 of file BufferBase.py.

◆ isNew()

def OpenRTM_aist.BufferBase.NullBuffer.isNew (   self)

Definition at line 589 of file BufferBase.py.

◆ length()

def OpenRTM_aist.BufferBase.NullBuffer.length (   self)

Get the buffer length.

Returns
buffer length(always 1)

Definition at line 482 of file BufferBase.py.

◆ put()

def OpenRTM_aist.BufferBase.NullBuffer.put (   self,
  data 
)

Write data into the buffer.

Definition at line 608 of file BufferBase.py.

◆ read()

def OpenRTM_aist.BufferBase.NullBuffer.read (   self,
  value 
)

Read data from the buffer.

Definition at line 525 of file BufferBase.py.

◆ write()

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

Write data into the buffer.

Definition at line 503 of file BufferBase.py.

Member Data Documentation

◆ _data

OpenRTM_aist.BufferBase.NullBuffer._data
private

Definition at line 459 of file BufferBase.py.

◆ _inited

OpenRTM_aist.BufferBase.NullBuffer._inited
private

Definition at line 461 of file BufferBase.py.

◆ _is_new

OpenRTM_aist.BufferBase.NullBuffer._is_new
private

Definition at line 460 of file BufferBase.py.

◆ _length

OpenRTM_aist.BufferBase.NullBuffer._length
private

Definition at line 458 of file BufferBase.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:07