OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer Class Reference

OutPortCorbaCdrConsumer class. More...

Inheritance diagram for OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer:

List of all members.

Public Member Functions
def	__init__
	Constructor.
def	__del__
	Destructor.
def	init
	Initializing configuration.
def	setBuffer
	Setting outside buffer's pointer.
def	get
	Read data.
def	subscribeInterface
	Subscribe the data receive notification.
def	unsubscribeInterface
	Unsubscribe the data receive notification.
def	convertReturn
	Return codes conversion.
def	onBufferWrite
	Connector data listener functions.
def	onSenderEmpty
	Connector listener functions.

---

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

---

Member Function Documentation

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

Destructor.

Destructor

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__init__

(

self

)

Constructor.

Constructor

Parameters:

buffer

Buffer that is attached to this port

Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.convertReturn	(		self,
			status,
			data
	)

Return codes conversion.

ReturnCode convertReturn(OpenRTM.PortStatus status, const cdrMemoryStream& data)

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:

• /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/OutPortCorbaCdrConsumer.py