Inheritance diagram for OpenRTM_aist.InPortPullConnector.InPortPullConnector:

Public Member Functions
def	__del__
	Destructor.
def	__init__
	Constructor.
def	activate
	Connector activation.
def	createBuffer
	create buffer
def	deactivate
	Connector deactivation.
def	disconnect
	Disconnect connection.
def	onConnect
	Invoke callback when connection is established void onConnect()
def	onDisconnect
	Invoke callback when connection is destroied void onDisconnect()
def	read
	Destructor.
Private Attributes
	_buffer
	_consumer
	_listeners

Detailed Description

InPortPullConnector class.

Connector class of InPort 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 InPort. 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.

InPortPullConnector owns and manages the following objects.

InPortConsumer
Buffer

Data written into the OutPort is passed to the OutPortPullConnector::write(), and is written into the buffer. Consequently, InPort::read() and InPortPullConnector::read() call OutPortConsumer::get(), and it reads data from the buffer of OutPortPullConnector. Finally data would be written into the InPortPullConnector's buffer.

Since:: 1.0.0

Definition at line 79 of file InPortPullConnector.py.

Constructor & Destructor Documentation

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.__init__	(	self,
		info,
		consumer,
		listeners,
		buffer = `0`
	)

Constructor.

InPortPullConnector'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 consumer object for the OutPort interface. The owner-ship of the pointer is owned by this OutPortPullConnector, it has responsibility to destruct the OutPortConsumer. 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
consumer	OutPortConsumer
listeners	ConnectorListeners type lsitener object list
buffer	CdrBufferBase type buffer

InPortPullConnector(ConnectorInfo info, OutPortConsumer* consumer, ConnectorListeners& listeners, CdrBufferBase* buffer = 0);

Definition at line 127 of file InPortPullConnector.py.

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.__del__ ( self )

Destructor.

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

Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.

Definition at line 159 of file InPortPullConnector.py.

Member Function Documentation

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.activate ( self )

Connector activation.

This operation activates this connector

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

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 254 of file InPortPullConnector.py.

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.createBuffer	(	self,
		profile
	)

create buffer

This function creates a buffer based on given information.

Parameters:

info	Connector information

Returns:: The poitner to the buffer

CdrBufferBase* createBuffer(Profile& profile);

Definition at line 295 of file InPortPullConnector.py.

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.deactivate ( self )

Connector deactivation.

This operation deactivates this connector

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

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 272 of file InPortPullConnector.py.

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.disconnect ( self )

Disconnect connection.

This operation disconnect this connection

virtual ReturnCode disconnect();

Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.

Definition at line 229 of file InPortPullConnector.py.

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.onConnect ( self )

Invoke callback when connection is established void onConnect()

Definition at line 306 of file InPortPullConnector.py.

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.onDisconnect ( self )

Invoke callback when connection is destroied void onDisconnect()

Definition at line 318 of file InPortPullConnector.py.

def OpenRTM_aist.InPortPullConnector.InPortPullConnector.read	(	self,
		data
	)

Destructor.

This function get data from OutPortConsumer. If data is read properly, this function will return PORT_OK return code. Except normal return, BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET and PORT_ERROR will be returned as error codes.