OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider Class Reference

More...

Inheritance diagram for OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider:

Public Member Functions
def	__init__ (self)
def	__del__ (self)
def	exit (self)
def	init (self, prop)
def	setBuffer (self, buffer)
def	setListener (self, info, listeners)
def	setConnector (self, connector)
def	get (self)
def	onBufferRead (self, data)
def	onSend (self, data)
def	onBufferEmpty (self)
def	onBufferReadTimeout (self)
def	onSenderEmpty (self)
def	onSenderTimeout (self)
def	onSenderError (self)
def	convertReturn (self, status, data)
Public Member Functions inherited from OpenRTM_aist.OutPortProvider.OutPortProvider
def	__init__ (self)
def	exit (self)
def	publishInterfaceProfile (self, prop)
	virtual void publishInterfaceProfile(SDOPackage::NVList& properties);
def	publishInterface (self, prop)
	virtual bool publishInterface(SDOPackage::NVList& properties);
def	setPortType (self, port_type)
def	setDataType (self, data_type)
def	setInterfaceType (self, interface_type)
def	setDataFlowType (self, dataflow_type)
def	setSubscriptionType (self, subs_type)
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def	toString (status)

Additional Inherited Members
Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int	PORT_OK = 0

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

Constructor & Destructor Documentation

__init__()

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.

__del__()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__del__

(

self

)

Destructor

Destructor

Member Function Documentation

convertReturn()

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

Return codes conversion

::OpenRTM::PortStatus convertReturn(BufferStatus::Enum status, const cdrMemoryStream& data);

exit()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.exit

(

self

)

Reimplemented from OpenRTM_aist.OutPortProvider.OutPortProvider.

get()

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

init()

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

onBufferEmpty()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferEmpty

(

self

)

Notify an ON_BUFFER_EMPTY event to listeners

inline void onBufferEmpty()

onBufferRead()

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)

onBufferReadTimeout()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferReadTimeout

(

self

)

Notify an ON_BUFFER_READ_TIMEOUT event to listeners

inline void onBufferReadTimeout()

onSend()

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

Notify an ON_SEND event to listeners

Parameters

data	cdrMemoryStream

inline void onSend(const cdrMemoryStream& data)

onSenderEmpty()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderEmpty

(

self

)

Notify an ON_SENDER_EMPTY event to listeners

inline void onSenderEmpty()

onSenderError()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderError

(

self

)

Notify an ON_SENDER_ERROR event to listeners

inline void onSenderError()

onSenderTimeout()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderTimeout

(

self

)

Notify an ON_SENDER_TIMEOUT event to listeners

inline void onSenderTimeout()

setBuffer()

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

setConnector()

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

setListener()

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.

• ON_BUFFER_READ
• ON_SEND
• ON_BUFFER_EMPTY
• ON_BUFFER_READ_TIMEOUT
• ON_SENDER_EMPTY
• ON_SENDER_TIMEOUT
• ON_SENDER_ERROR

Parameters

info	Connector information
listeners	Listener objects

virtual void setListener(ConnectorInfo& info, ConnectorListeners* listeners);

---

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

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/OutPortCorbaCdrProvider.py