OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer Class Reference

OutPortCorbaCdrConsumer class. More...

Inheritance diagram for OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer:

Public Member Functions
def	__init__ (self)
	Constructor. More...
def	__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
	Destructor. More...
def	init (self, prop)
	Initializing configuration. More...
def	setBuffer (self, buffer)
	Setting outside buffer's pointer. More...
def	get (self, data)
	Read data. More...
def	subscribeInterface (self, properties)
	Subscribe the data receive notification. More...
def	unsubscribeInterface (self, properties)
	Unsubscribe the data receive notification. More...
def	convertReturn (self, status, data)
	Return codes conversionReturnCode convertReturn(::OpenRTM::PortStatus status, const cdrMemoryStream& 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)
	Convert DataPortStatus into the string. More...
Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumer
def	__init__ (self, interfaceType=None, consumer=None)
	Consructor. More...
def	equal (self, consumer)
	Assignment operator. More...
def	setObject (self, obj)
	Set Object. More...
Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumerBase
def	__init__ (self, consumer=None)
	Consructor. More...
def	equal (self, consumer)
	Assignment operator. More...
def	setObject (self, obj)
	Set CORBA Object. More...
def	getObject (self)
	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

DataType

Data type for this port

Since

1.0.0

Constructor & Destructor Documentation

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__init__

(

self

)

Constructor.

Constructor

Parameters

buffer

Buffer 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

data	Object 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

prop	Configuration 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

buffer

A 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

properties

Subscription 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

properties

Unsubscription information

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

---

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

• /home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/OutPortCorbaCdrConsumer.py