OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector Class Reference

Inheritance diagram for OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector:

Public Member Functions
	__init__ (self, info, provider, listeners, buffer=None)
	__del__ (self)
	readBuff (self)
	read (self, data=None)
	disconnect (self)
	activate (self)
	deactivate (self)
	createBuffer (self, profile)
	write (self, data)
	onConnect (self)
	onDisconnect (self)
	setConsumer (self, consumer)
	deserializeData (self, cdr)
	unsubscribeInterface (self, prop)
Public Member Functions inherited from OpenRTM_aist.InPortConnector.InPortConnector
	profile (self)
	id (self)
	name (self)
	getBuffer (self)
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
	toString (status)

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

Detailed Description

Constructor & Destructor Documentation

__del__()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.__del__

(

self

)

Destructor

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

Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.

Member Function Documentation

activate()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.activate

(

self

)

Connector activation

This operation activates this connector

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

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

createBuffer()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.createBuffer	(		self,
			profile )

create buffer

This function creates a buffer based on given information.

Parameters

info	Connector information

Returns

The poitner to the buffer

virtual CdrBufferBase* createBuffer(Profile& profile);

deactivate()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.deactivate

(

self

)

Connector deactivation

This operation deactivates this connector

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

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

deserializeData()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.deserializeData	(		self,
			cdr )

Parameters

self
cdr

Returns

disconnect()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.disconnect

(

self

)

disconnect

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

Returns

PORT_OK

virtual ReturnCode disconnect();

Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.

onConnect()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.onConnect

(

self

)

Invoke callback when connection is established void onConnect()

onDisconnect()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.onDisconnect

(

self

)

Invoke callback when connection is destroied void onDisconnect()

read()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.read	(		self,
			data = None )

Reading data

This function reads data from the buffer. 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.

Returns

PORT_OK Normal return BUFFER_EMPTY Buffer empty TIMEOUT Timeout PRECONDITION_NOT_MET Preconditin not met PORT_ERROR Other error

virtual ReturnCode read(cdrMemoryStream& data);

Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.

setConsumer()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.setConsumer	(		self,
			consumer )

set Consumer

Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.

unsubscribeInterface()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.unsubscribeInterface	(		self,
			prop )

Parameters

prop

Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.

write()

OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.write	(		self,
			data )

Reading data

This function write data to the buffer. If data is write properly, this function will return BUFFER_OK return code. Except normal return, BUFFER_FULL, TIMEOUT, PRECONDITION_NOT_MET and BUFFER_ERROR will be returned as error codes.

Returns

BUFFER_OK Normal return BUFFER_FULL Buffer full TIMEOUT Timeout PRECONDITION_NOT_MET Preconditin not met BUFFER_ERROR Other error

ReturnCode write(const OpenRTM.CdrData& data);

Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.

---

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

• InPortDuplexConnector.py