OpenRTM_aist.OutPortPullConnector.OutPortPullConnector Class Reference

OutPortPullConnector class. More...

Inheritance diagram for OpenRTM_aist.OutPortPullConnector.OutPortPullConnector:

Public Member Functions
def	__init__ (self, info, provider, listeners, buffer=None)
	Constructor. More...
def	__del__ (self)
	Destructor. More...
def	write (self, data)
	Writing data. More...
def	disconnect (self)
	disconnect More...
def	getBuffer (self)
	Getting Buffer. More...
def	activate (self)
	Connector activation. More...
def	deactivate (self)
	Connector deactivation. More...
def	createBuffer (self, info)
	create bufferCdrBufferBase* createBuffer(ConnectorInfo& info);
def	onConnect (self)
	Invoke callback when connection is established void onConnect()
def	onDisconnect (self)
	Invoke callback when connection is destroied void onDisconnect()
def	setDirectMode (self)
	void onDisconnect()
Public Member Functions inherited from OpenRTM_aist.OutPortConnector.OutPortConnector
def	__init__ (self, info)
	ConstructorOutPortConnector(ConnectorInfo& info);.
def	__del__ (self)
	Destructor.
def	profile (self)
	Getting ConnectorInfo. More...
def	id (self)
	Getting Connector ID. More...
def	name (self)
	Getting Connector name. More...
def	setDirectMode (self)
	This. More...
def	directMode (self)
Public Member Functions inherited from OpenRTM_aist.ConnectorBase.ConnectorBase
def	__del__ (self)
	Destructor.
def	profile (self)
	Getting Profile. More...
def	id (self)
	Getting Connector ID. More...
def	name (self)
	Getting Connector name. More...
def	disconnect (self)
	Disconnect connection. More...
def	getBuffer (self)
	Getting Buffer. More...
def	activate (self)
	Connector activation. More...
def	deactivate (self)
	Connector deactivation. More...
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def	toString (status)
	Convert DataPortStatus into the string. More...

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

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

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

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.__del__

(

self

)

Destructor.

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

Member Function Documentation

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.activate

(

self

)

Connector activation.

This operation activates this connector

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

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.deactivate

(

self

)

Connector deactivation.

This operation deactivates this connector

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

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.disconnect

(

self

)

disconnect

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

virtual ReturnCode disconnect();

def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.getBuffer

(

self

)

Getting Buffer.

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

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

---

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

• /home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/OutPortPullConnector.py