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

More...

Inheritance diagram for OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer:
OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer OpenRTM_aist.OutPortConsumer.OutPortConsumer OpenRTM_aist.CorbaConsumer.CorbaConsumer OpenRTM_aist.DataPortStatus.DataPortStatus OpenRTM_aist.CorbaConsumer.CorbaConsumerBase

Public Member Functions

def __init__ (self)
 
def __del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
 
def init (self, prop)
 
def setBuffer (self, buffer)
 
def get (self)
 
def isReadable (self, retry=False)
 
- Public Member Functions inherited from OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer
def __init__ (self)
 
def __del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
 
def init (self, prop)
 
def setBuffer (self, buffer)
 
def get (self)
 
def subscribeInterface (self, properties)
 
def unsubscribeInterface (self, properties)
 
def convertReturn (self, status, data)
 
def onBufferWrite (self, data)
 Connector data listener functions. More...
 
def onSenderEmpty (self)
 Connector listener functions. More...
 
- Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def toString (status)
 
- Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumer
def __init__ (self, interfaceType=None, consumer=None)
 
def equal (self, consumer)
 
def setObject (self, obj)
 
def releaseObject (self)
 
- Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumerBase
def __init__ (self, consumer=None)
 
def equal (self, consumer)
 
def setObject (self, obj)
 
def getObject (self)
 
def releaseObject (self)
 

Additional Inherited Members

- Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int PORT_OK = 0
 

Detailed Description

OutPortCSPConsumer class

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.__init__ (   self)

Constructor

Constructor

self

Reimplemented from OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.

◆ __del__()

def OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.__del__ (   self,
  CorbaConsumer = OpenRTM_aist.CorbaConsumer 
)

Destructor

Destructor

Parameters
self

Reimplemented from OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.

Member Function Documentation

◆ get()

def OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.get (   self)

Parameters
data
Returns

::OpenRTM::PortStatus put() throw (CORBA::SystemException);

Reimplemented from OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.

◆ init()

def OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.init (   self,
  prop 
)

Initializing configuration

This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.

Parameters
propConfiguration information

virtual void init(coil::Properties& prop);

Reimplemented from OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.

◆ isReadable()

def OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.isReadable (   self,
  retry = False 
)

Parameters
self
retry
Returns

Reimplemented from OpenRTM_aist.OutPortConsumer.OutPortConsumer.

◆ setBuffer()

def OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.setBuffer (   self,
  buffer 
)

Setting outside buffer's pointer

Parameters
bufferA pointer to a data buffer to be used by OutPortProvider

virtual void setBuffer(CdrBufferBase* buffer);

Reimplemented from OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.


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