OpenRTM_aist.OutPortPushConnector.OutPortPushConnector Class Reference

OutPortPushConnector class. More...

Inheritance diagram for OpenRTM_aist.OutPortPushConnector.OutPortPushConnector:

Public Member Functions
def	__init__ (self, info, consumer, listeners, buffer=None)
	Constructor. More...
def	__del__ (self)
	Destructor. More...
def	write (self, data)
	Writing data. More...
def	disconnect (self)
	disconnect More...
def	activate (self)
	Connector activation. More...
def	deactivate (self)
	Connector deactivation. More...
def	getBuffer (self)
	Getting Buffer. More...
def	createPublisher (self, info)
	create buffer More...
def	createBuffer (self, info)
	create buffer More...
def	onConnect (self)
	Invoke callback when connection is established void onConnect()
def	onDisconnect (self)
	Invoke callback when connection is destroied void onDisconnect()
def	setInPort (self, directInPort)
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

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.

Constructor & Destructor Documentation

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

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

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.__del__

(

self

)

Destructor.

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

Member Function Documentation

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.activate

(

self

)

Connector activation.

This operation activates this connector

virtual void activate();

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

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

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.deactivate

(

self

)

Connector deactivation.

This operation deactivates this connector

virtual void deactivate();

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.disconnect

(

self

)

disconnect

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

virtual ReturnCode disconnect();

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.getBuffer

(

self

)

Getting Buffer.

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

def OpenRTM_aist.OutPortPushConnector.OutPortPushConnector.setInPort	(		self,
			directInPort
	)

Parameters

self
directInPort

Returns

bool setInPort(InPortBase* directInPort);

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

---

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

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