OpenRTM_aist.OutPortPushConnector.OutPortPushConnector Class Reference

OutPortPushConnector class. More...

Inheritance diagram for OpenRTM_aist.OutPortPushConnector.OutPortPushConnector:

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

Private Attributes
	_buffer
	_consumer
	_endian
	_listeners
	_publisher

Additional Inherited Members
Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int	BUFFER_EMPTY = 4
int	BUFFER_ERROR = 2
int	BUFFER_FULL = 3
int	BUFFER_TIMEOUT = 5
int	CONNECTION_LOST = 12
int	INVALID_ARGS = 10
int	PORT_ERROR = 1
int	PORT_OK = 0
	DataPortStatus return codes. More...
int	PRECONDITION_NOT_MET = 11
int	RECV_EMPTY = 8
int	RECV_TIMEOUT = 9
int	SEND_FULL = 6
int	SEND_TIMEOUT = 7
	toString = staticmethod(toString)
int	UNKNOWN_ERROR = 13

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.

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

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

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

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

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.

Member Data Documentation

OpenRTM_aist.OutPortPushConnector.OutPortPushConnector._buffer

private

Definition at line 131 of file OutPortPushConnector.py.

OpenRTM_aist.OutPortPushConnector.OutPortPushConnector._consumer

private

Definition at line 132 of file OutPortPushConnector.py.

OpenRTM_aist.OutPortPushConnector.OutPortPushConnector._endian

private

Definition at line 156 of file OutPortPushConnector.py.

OpenRTM_aist.OutPortPushConnector.OutPortPushConnector._listeners

private

Definition at line 133 of file OutPortPushConnector.py.

OpenRTM_aist.OutPortPushConnector.OutPortPushConnector._publisher

private

Definition at line 136 of file OutPortPushConnector.py.

---

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

• OutPortPushConnector.py