Inheritance diagram for OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider:

Public Member Functions
def	__del__ (self)
	Destructor. More...

def	__init__ (self)
	Constructor. More...

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

def	get (self)
	[CORBA interface] Get data from the buffer More...

def	init (self, prop)
	Initializing configuration. More...

def	onBufferEmpty (self)
	Notify an ON_BUFFER_EMPTY event to listenersinline void onBufferEmpty() More...

def	onBufferRead (self, data)
	Notify an ON_BUFFER_READ event to listeners. More...

def	onBufferReadTimeout (self)
	Notify an ON_BUFFER_READ_TIMEOUT event to listenersinline void onBufferReadTimeout() More...

def	onSend (self, data)
	Notify an ON_SEND event to listeners. More...

def	onSenderEmpty (self)
	Notify an ON_SENDER_EMPTY event to listenersinline void onSenderEmpty() More...

def	onSenderError (self)
	Notify an ON_SENDER_ERROR event to listenersinline void onSenderError() More...

def	onSenderTimeout (self)
	Notify an ON_SENDER_TIMEOUT event to listenersinline void onSenderTimeout() More...

def	setBuffer (self, buffer)
	Setting outside buffer's pointer. More...

def	setConnector (self, connector)
	set Connector More...

def	setListener (self, info, listeners)
	Set the listener. More...

Public Member Functions inherited from OpenRTM_aist.OutPortProvider.OutPortProvider
def	__init__ (self)
	Constructor. More...

def	publishInterface (self, prop)
	virtual bool publishInterface(SDOPackage::NVList& properties); More...

def	publishInterfaceProfile (self, prop)
	virtual void publishInterfaceProfile(SDOPackage::NVList& properties); More...

def	setDataFlowType (self, dataflow_type)

def	setDataType (self, data_type)

def	setInterfaceType (self, interface_type)

def	setPortType (self, port_type)

def	setSubscriptionType (self, subs_type)

Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def	__init__ (self)

def	toString (status)
	Convert DataPortStatus into the string. More...

Private Attributes
	_buffer

	_connector

	_listeners

	_objref

	_profile

Additional Inherited Members
Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int	BUFFER_EMPTY = 4

int	BUFFER_ERROR = 2

int	BUFFER_FULL = 3

int	BUFFER_TIMEOUT = 5

int	CONNECTION_LOST = 12

int	INVALID_ARGS = 10

int	PORT_ERROR = 1

int	PORT_OK = 0
	DataPortStatus return codes. More...

int	PRECONDITION_NOT_MET = 11

int	RECV_EMPTY = 8

int	RECV_TIMEOUT = 9

int	SEND_FULL = 6

int	SEND_TIMEOUT = 7

	toString = staticmethod(toString)

int	UNKNOWN_ERROR = 13

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 51 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

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.

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

Definition at line 220 of file OutPortCorbaCdrProvider.py.

Member Data Documentation

OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider._buffer

private

Definition at line 76 of file OutPortCorbaCdrProvider.py.

OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider._connector

private

Definition at line 87 of file OutPortCorbaCdrProvider.py.

OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider._listeners

private

Definition at line 86 of file OutPortCorbaCdrProvider.py.

OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider._objref

private

Definition at line 74 of file OutPortCorbaCdrProvider.py.

OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider._profile

private

Definition at line 88 of file OutPortCorbaCdrProvider.py.

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

OutPortCorbaCdrProvider.py

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation