OpenRTM_aist.OutPortPullConnector.OutPortPullConnector Class Reference

More...

Inheritance diagram for OpenRTM_aist.OutPortPullConnector.OutPortPullConnector:

Classes
class	WorkerThreadCtrl

Public Member Functions
	__init__ (self, info, provider, listeners, buffer=None)
	__del__ (self)
	write (self, data)
	disconnect (self)
	getBuffer (self)
	activate (self)
	deactivate (self)
	createBuffer (self, info)
	onConnect (self)
	onDisconnect (self)
	setDirectMode (self)
Public Member Functions inherited from OpenRTM_aist.OutPortConnector.OutPortConnector
	profile (self)
	id (self)
	name (self)
	directMode (self)
	setConsumer (self, consumer)
	unsubscribeInterface (self, prop)
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
	toString (status)

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

Detailed Description

OutPortPullConnector class

Connector class of OutPort for pull type dataflow. When "pull" is specified as dataflow_type at the time of establishing connection, this object is generated and owned by the OutPort. This connector and InPortPullConnector make a pair and realize pull type dataflow of data ports. One connector corresponds to one connection which provides a data stream. Connector is distinguished by ID of the UUID that is generated at establishing connection.

OutPortPullConnector owns and manages the following objects.

• InPortConsumer
• Buffer

Data written into the OutPort is passed to OutPortPullConnector.write(), and it is written into the buffer. By reading data from OutPortPullConnector to InPortPullConnector, data transfer is realized.

Since

1.0.0

Constructor & Destructor Documentation

__init__()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.__init__	(		self,
			info,
			provider,
			listeners,
			buffer = None )

Constructor

OutPortPullConnector's constructor is given the following arguments. According to ConnectorInfo which includes connection information, a buffer is created. It is also given a pointer to the provider object for the OutPort interface. The owner-ship of the pointer is owned by this OutPortPullConnector, it has responsibility to destruct the OutPortProvider. OutPortPullConnector also has ConnectorListeners to provide event callback mechanisms, and they would be called at the proper timing. If data buffer is given by OutPortBase, the pointer to the buffer is also given as arguments.

Parameters

info	ConnectorInfo
provider	OutPortProvider
listeners	ConnectorListeners type lsitener object list
buffer	CdrBufferBase type buffer

OutPortPullConnector(ConnectorInfo info, OutPortProvider* provider, ConnectorListeners& listeners, CdrBufferBase* buffer = 0);

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

__del__()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.__del__

(

self

)

Destructor

This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

Member Function Documentation

activate()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.activate

(

self

)

Connector activation

This operation activates this connector

virtual void activate(){}; // do nothing

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

createBuffer()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.createBuffer	(		self,
			info )

create buffer

CdrBufferBase* createBuffer(ConnectorInfo& info);

deactivate()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.deactivate

(

self

)

Connector deactivation

This operation deactivates this connector

virtual void deactivate(){}; // do nothing

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

disconnect()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.disconnect

(

self

)

disconnect

This operation destruct and delete the consumer, the publisher and the buffer.

virtual ReturnCode disconnect();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

getBuffer()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.getBuffer

(

self

)

Getting Buffer

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

onConnect()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.onConnect

(

self

)

Invoke callback when connection is established void onConnect()

onDisconnect()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.onDisconnect

(

self

)

Invoke callback when connection is destroied void onDisconnect()

setDirectMode()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.setDirectMode

(

self

)

void onDisconnect()

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

write()

OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.write	(		self,
			data )

Writing data

This operation writes data into publisher and then the data will be transferred to correspondent InPort.

virtual ReturnCode write(const cdrMemoryStream& data);

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

---

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

• OutPortPullConnector.py