Inheritance diagram for OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer:

[legend]

Public Member Functions
def	__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
	Destructor. More...

def	__init__ (self)
	Constructor. More...

def	convertReturn (self, status, data)
	Return codes conversionReturnCode convertReturn(::OpenRTM::PortStatus status, const cdrMemoryStream& data) More...

def	get (self, data)
	Read data. More...

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

def	onBufferFull (self, data)

def	onBufferWrite (self, data)
	Connector data listener functions. More...

def	onReceived (self, data)

def	onReceiverFull (self, data)

def	onSenderEmpty (self)
	Connector listener functions. More...

def	onSenderError (self)

def	onSenderTimeout (self)

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

def	setListener (self, info, listeners)

def	subscribeInterface (self, properties)
	Subscribe the data receive notification. More...

def	unsubscribeInterface (self, properties)
	Unsubscribe the data receive notification. More...

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

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

Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumer
def	__del__ (self)

def	__init__ (self, interfaceType=None, consumer=None)
	Consructor. More...

def	equal (self, consumer)
	Assignment operator. More...

def	releaseObject (self)

def	setObject (self, obj)
	Set Object. More...

Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumerBase
def	__init__ (self, consumer=None)
	Consructor. More...

def	equal (self, consumer)
	Assignment operator. More...

def	getObject (self)
	Get CORBA Object. More...

def	releaseObject (self)

def	setObject (self, obj)
	Set CORBA Object. More...

Private Attributes
	_buffer

	_listeners

	_profile

	_rtcout

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

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

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.

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

Definition at line 166 of file OutPortCorbaCdrConsumer.py.

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

Definition at line 252 of file OutPortCorbaCdrConsumer.py.

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.unsubscribeInterface	(	self,
		properties
	)

Unsubscribe the data receive notification.

Parameters

properties Unsubscription information

virtual void unsubscribeInterface(const SDOPackage::NVList& properties);

Definition at line 299 of file OutPortCorbaCdrConsumer.py.

Member Data Documentation

OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer._buffer

private

Definition at line 75 of file OutPortCorbaCdrConsumer.py.

OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer._listeners

private

Definition at line 77 of file OutPortCorbaCdrConsumer.py.

OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer._profile

private

Definition at line 76 of file OutPortCorbaCdrConsumer.py.

OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer._rtcout

private

Definition at line 74 of file OutPortCorbaCdrConsumer.py.

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

OutPortCorbaCdrConsumer.py

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation