Inheritance diagram for OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer:

Public Member Functions
def	__del__
	Destructor.
def	__init__
	Constructor.
def	convertReturn
	Return codes conversionReturnCode convertReturn(::OpenRTM::PortStatus status, const cdrMemoryStream& data)
def	get
	Read data.
def	init
	Initializing configuration.
def	onBufferFull
def	onBufferWrite
	Connector data listener functions.
def	onReceived
def	onReceiverFull
def	onSenderEmpty
	Connector listener functions.
def	onSenderError
def	onSenderTimeout
def	setBuffer
	Setting outside buffer's pointer.
def	setListener
def	subscribeInterface
	Subscribe the data receive notification.
def	unsubscribeInterface
	Unsubscribe the data receive notification.
Private Attributes
	_buffer
	_listeners
	_profile
	_rtcout

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

Definition at line 51 of file OutPortCorbaCdrConsumer.py.

Constructor & Destructor Documentation

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__init__ ( self )

Constructor.

Constructor

Parameters:

buffer Buffer that is attached to this port

Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.

Definition at line 72 of file OutPortCorbaCdrConsumer.py.

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

Destructor.

Destructor

Definition at line 93 of file OutPortCorbaCdrConsumer.py.

Member Function Documentation

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

Return codes conversionReturnCode convertReturn(::OpenRTM::PortStatus status, const cdrMemoryStream& data)

Definition at line 337 of file OutPortCorbaCdrConsumer.py.

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);

Definition at line 195 of file OutPortCorbaCdrConsumer.py.

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);

Definition at line 127 of file OutPortCorbaCdrConsumer.py.

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

Definition at line 382 of file OutPortCorbaCdrConsumer.py.

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

Connector data listener functions.

inline void onBufferWrite(const cdrMemoryStream& data)

Definition at line 374 of file OutPortCorbaCdrConsumer.py.

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

Definition at line 390 of file OutPortCorbaCdrConsumer.py.

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

Definition at line 398 of file OutPortCorbaCdrConsumer.py.

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onSenderEmpty ( self )

Connector listener functions.

inline void onSenderEmpty()

Definition at line 409 of file OutPortCorbaCdrConsumer.py.

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onSenderError ( self )

Definition at line 425 of file OutPortCorbaCdrConsumer.py.

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onSenderTimeout ( self )

Definition at line 417 of file OutPortCorbaCdrConsumer.py.

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);

Definition at line 158 of file OutPortCorbaCdrConsumer.py.