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

OutPortCorbaCdrConsumer class. More...

Inheritance diagram for 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__
 Constructor. More...
 
def __del__
 Destructor. More...
 
def init
 Initializing configuration. More...
 
def setBuffer
 Setting outside buffer's pointer. More...
 
def get
 Read data. More...
 
def subscribeInterface
 Subscribe the data receive notification. More...
 
def unsubscribeInterface
 Unsubscribe the data receive notification. More...
 
def convertReturn
 Return codes conversionReturnCode convertReturn(::OpenRTM::PortStatus status, const cdrMemoryStream& data)
 
def onBufferWrite
 Connector data listener functions. More...
 
def onSenderEmpty
 Connector listener functions. More...
 
- Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def toString
 Convert DataPortStatus into the string. More...
 
- Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumer
def __init__
 Consructor. More...
 
def equal
 Assignment operator. More...
 
def setObject
 Set Object. More...
 
- Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumerBase
def __init__
 Consructor. More...
 
def equal
 Assignment operator. More...
 
def setObject
 Set CORBA Object. More...
 
def getObject
 Get CORBA Object. More...
 

Additional Inherited Members

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

Detailed Description

OutPortCorbaCdrConsumer class.

This is an implementation class of the output Consumer that uses CORBA for means of communication.

Parameters
DataTypeData type for this port
Since
1.0.0

Constructor & Destructor Documentation

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__init__ (   self)

Constructor.

Constructor

Parameters
bufferBuffer that is attached to this port
def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__del__ (   self,
  CorbaConsumer = OpenRTM_aist.CorbaConsumer 
)

Destructor.

Destructor

Member Function Documentation

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.get (   self,
  data 
)

Read data.

Read set data

Parameters
dataObject to receive the read data
Returns
Read result (Successful:true, Failed:false)

virtual ReturnCode get(cdrMemoryStream& data);

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.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);

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onBufferWrite (   self,
  data 
)

Connector data listener functions.

inline void onBufferWrite(const cdrMemoryStream& data)

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onSenderEmpty (   self)

Connector listener functions.

inline void onSenderEmpty()

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

Setting outside buffer's pointer.

A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.

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

virtual void setBuffer(CdrBufferBase* buffer);

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.subscribeInterface (   self,
  properties 
)

Subscribe the data receive notification.

Subscribe the data receive notification based on specified property information

Parameters
propertiesSubscription information
Returns
Subscription result (Successful:true, Failed:false)

virtual bool subscribeInterface(const SDOPackage::NVList& properties);

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.unsubscribeInterface (   self,
  properties 
)

Unsubscribe the data receive notification.

Unsubscribe the data receive notification.

Parameters
propertiesUnsubscription information

virtual void unsubscribeInterface(const SDOPackage::NVList& properties);


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