Inheritance diagram for OpenRTM_aist.OutPortPushConnector.OutPortPushConnector:

Public Member Functions
def	__del__
	Destructor.
def	__init__
	Constructor.
def	activate
	Connector activation.
def	createBuffer
	create buffer
def	createPublisher
	create buffer
def	deactivate
	Connector deactivation.
def	disconnect
	disconnect
def	getBuffer
	Getting Buffer.
def	onConnect
	Invoke callback when connection is established void onConnect()
def	onDisconnect
	Invoke callback when connection is destroied void onDisconnect()
def	write
	Writing data.
Private Attributes
	_buffer
	_consumer
	_endian
	_listeners
	_publisher

Detailed Description

OutPortPushConnector class.

Connector class of OutPort for push type dataflow. When "push" is specified as dataflow_type at the time of establishing connection, this object is generated and owned by the OutPort. This connector and InPortPushConnector make a pair and realize push 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.

OutPortPushConnector owns and manages the following objects.

InPortConsumer
Buffer
Publisher

Since:: 1.0.0

Data written into the OutPort is passed to OutPortPushConnector::write(), and the connector writes into the publisher. The publisher gets data from the buffer based on the policy and it is transferred to InPort by pushing it into the InPortConsumer.

Definition at line 80 of file OutPortPushConnector.py.

Constructor & Destructor Documentation

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

Constructor.

OutPortPushConnector's constructor is given the following arguments. According to ConnectorInfo which includes connection information, a publisher and a buffer are created. It is also given a pointer to the consumer object for the InPort interface. The owner-ship of the pointer is owned by this OutPortPushConnector, it has responsibility to destruct the InPortConsumer. OutPortPushConnector 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	InPortConsumer
listeners	ConnectorListeners type lsitener object list
buffer	CdrBufferBase type buffer

OutPortPushConnector(ConnectorInfo info, InPortConsumer* consumer, ConnectorListeners& listeners, CdrBufferBase* buffer = 0);

Definition at line 128 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.__del__ ( self )

Destructor.

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

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

Definition at line 190 of file OutPortPushConnector.py.

Member Function Documentation

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.activate ( self )

Connector activation.

This operation activates this connector

virtual void activate();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 310 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.createBuffer	(	self,
		info
	)

create buffer

This function creates a buffer based on given information.

Parameters:

info	Connector information

Returns:: The poitner to the buffer

virtual CdrBufferBase* createBuffer(ConnectorInfo& info);

Definition at line 399 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.createPublisher	(	self,
		info
	)

create buffer

This function creates a publisher based on given information.

Parameters:

info	Connector information

Returns:: The poitner to the publisher

virtual PublisherBase* createPublisher(ConnectorInfo& info);

Definition at line 373 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.deactivate ( self )

Connector deactivation.

This operation deactivates this connector

virtual void deactivate();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 330 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.disconnect ( self )

disconnect

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

virtual ReturnCode disconnect();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 264 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.getBuffer ( self )

Getting Buffer.

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 349 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.onConnect ( self )

Invoke callback when connection is established void onConnect()

Definition at line 413 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.onDisconnect ( self )

Invoke callback when connection is destroied void onDisconnect()

Definition at line 425 of file OutPortPushConnector.py.

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.write	(	self,
		data
	)

Writing data.

This operation writes data into publisher and then the data will be transferred to correspondent InPort. If data is written properly, this function will return PORT_OK return code. Except normal return, CONNECTION_LOST, BUFFER_FULL, BUFFER_ERROR, PORT_ERROR, BUFFER_TIMEOUT and PRECONDITION_NO_MET will be returned as error codes.

Returns:: PORT_OK Normal return CONNECTION_LOST Connectin lost BUFFER_FULL Buffer full BUFFER_ERROR Buffer error BUFFER_TIMEOUT Timeout PRECONDITION_NOT_MET Precondition not met PORT_ERROR Other error

template<class DataType> virtual ReturnCode write(const DataType& data);

Definition at line 234 of file OutPortPushConnector.py.