Inheritance diagram for OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider:

Public Member Functions
def	__del__
	Destructor.
def	__init__
	Constructor.
def	convertReturn
	Return codes conversion::OpenRTM::PortStatus convertReturn(BufferStatus::Enum status, const cdrMemoryStream& data);.
def	get
	[CORBA interface] Get data from the buffer
def	init
	Initializing configuration.
def	onBufferEmpty
	Notify an ON_BUFFER_EMPTY event to listenersinline void onBufferEmpty()
def	onBufferRead
	Notify an ON_BUFFER_READ event to listeners.
def	onBufferReadTimeout
	Notify an ON_BUFFER_READ_TIMEOUT event to listenersinline void onBufferReadTimeout()
def	onSend
	Notify an ON_SEND event to listeners.
def	onSenderEmpty
	Notify an ON_SENDER_EMPTY event to listenersinline void onSenderEmpty()
def	onSenderError
	Notify an ON_SENDER_ERROR event to listenersinline void onSenderError()
def	onSenderTimeout
	Notify an ON_SENDER_TIMEOUT event to listenersinline void onSenderTimeout()
def	setBuffer
	Setting outside buffer's pointer.
def	setConnector
	set Connector
def	setListener
	Set the listener.
Private Attributes
	_buffer
	_connector
	_listeners
	_objref
	_profile

Detailed Description

OutPortCorbaCdrProvider class.

The OutPort provider class which uses the OpenRTM::OutPortCdr interface in CORBA for data transfer and realizes a pull-type dataflow.

Since:: 0.4.0

Definition at line 50 of file OutPortCorbaCdrProvider.py.

Constructor & Destructor Documentation

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__init__ ( self )

Constructor.

Constructor

Parameters:

buffer Buffer object that is assigned to this provider

Reimplemented from OpenRTM_aist.OutPortProvider.OutPortProvider.

Definition at line 69 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__del__ ( self )

Destructor.

Destructor

Definition at line 105 of file OutPortCorbaCdrProvider.py.

Member Function Documentation

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

Return codes conversion::OpenRTM::PortStatus convertReturn(BufferStatus::Enum status, const cdrMemoryStream& data);.

Definition at line 404 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.get ( self )

[CORBA interface] Get data from the buffer

Get data from the internal buffer.

Returns:: Data got from the buffer.

virtual ::OpenRTM::PortStatus get(::OpenRTM::CdrData_out data);

Definition at line 274 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.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 139 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferEmpty ( self )

Notify an ON_BUFFER_EMPTY event to listenersinline void onBufferEmpty()

Definition at line 337 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferRead	(	self,
		data
	)

Notify an ON_BUFFER_READ event to listeners.

Parameters:

data	cdrMemoryStream

inline void onBufferRead(const cdrMemoryStream& data)

Definition at line 309 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferReadTimeout ( self )

Notify an ON_BUFFER_READ_TIMEOUT event to listenersinline void onBufferReadTimeout()

Definition at line 350 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSend	(	self,
		data
	)

Notify an ON_SEND event to listeners.

Parameters:

data	cdrMemoryStream

inline void onSend(const cdrMemoryStream& data)

Definition at line 324 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderEmpty ( self )

Notify an ON_SENDER_EMPTY event to listenersinline void onSenderEmpty()

Definition at line 363 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderError ( self )

Notify an ON_SENDER_ERROR event to listenersinline void onSenderError()

Definition at line 389 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderTimeout ( self )

Notify an ON_SENDER_TIMEOUT event to listenersinline void onSenderTimeout()

Definition at line 376 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.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(BufferBase<cdrMemoryStream>* buffer);

Definition at line 169 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setConnector	(	self,
		connector
	)

set Connector

OutPort creates OutPortConnector object when it establishes connection between OutPort and InPort, and it calls this function with a pointer to the connector object. Since the OutPort has the ownership of this connector, OutPortProvider should not delete it.

Parameters:

connector OutPortConnector

virtual void setConnector(OutPortConnector* connector);

Definition at line 251 of file OutPortCorbaCdrProvider.py.

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setListener	(	self,
		info,
		listeners
	)

Set the listener.

OutPort provides callback functionality that calls specific listener objects according to the events in the data publishing process. For details, see documentation of ConnectorDataListener class and ConnectorListener class in ConnectorListener.h. In this OutPortCorbaCdrProvider provides the following callbacks.