OpenRTM_aist.InPortConnector.InPortConnector Class Reference

More...

Inheritance diagram for OpenRTM_aist.InPortConnector.InPortConnector:

Public Member Functions
	__init__ (self, info, buffer)
	__del__ (self)
	profile (self)
	id (self)
	name (self)
	disconnect (self)
	getBuffer (self)
	read (self, data=None)
	setConsumer (self, consumer)
	unsubscribeInterface (self, prop)
Public Member Functions inherited from OpenRTM_aist.ConnectorBase.ConnectorBase
	activate (self)
	deactivate (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

IｎPortConnector base class

The base class to derive subclasses for InPort's Push/Pull Connectors

Since

1.0.0

Constructor & Destructor Documentation

__init__()

OpenRTM_aist.InPortConnector.InPortConnector.__init__	(		self,
			info,
			buffer )

Constructor

InPortConnector(ConnectorInfo& info, CdrBufferBase* buffer);

Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.

Reimplemented in OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector, OpenRTM_aist.InPortPullConnector.InPortPullConnector, and OpenRTM_aist.InPortPushConnector.InPortPushConnector.

__del__()

OpenRTM_aist.InPortConnector.InPortConnector.__del__

(

self

)

Destructor

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Reimplemented in OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector, OpenRTM_aist.InPortPullConnector.InPortPullConnector, and OpenRTM_aist.InPortPushConnector.InPortPushConnector.

Member Function Documentation

disconnect()

OpenRTM_aist.InPortConnector.InPortConnector.disconnect

(

self

)

Disconnect connection

This operation disconnect this connection

virtual ReturnCode disconnect() = 0;

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Reimplemented in OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector, OpenRTM_aist.InPortPullConnector.InPortPullConnector, and OpenRTM_aist.InPortPushConnector.InPortPushConnector.

getBuffer()

OpenRTM_aist.InPortConnector.InPortConnector.getBuffer

(

self

)

Getting Buffer

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

id()

OpenRTM_aist.InPortConnector.InPortConnector.id

(

self

)

Getting Connector ID

This operation returns Connector ID

const char* id();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

name()

OpenRTM_aist.InPortConnector.InPortConnector.name

(

self

)

Getting Connector name

This operation returns Connector name

const char* name();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

profile()

OpenRTM_aist.InPortConnector.InPortConnector.profile

(

self

)

Getting ConnectorInfo

This operation returns ConnectorInfo

const ConnectorInfo& profile();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

read()

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

The read function to read data from buffer to InPort

virtual ReturnCode read(cdrMemoryStream& data) = 0;

Reimplemented in OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector, OpenRTM_aist.InPortPullConnector.InPortPullConnector, and OpenRTM_aist.InPortPushConnector.InPortPushConnector.

setConsumer()

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

set Consumer

Reimplemented in OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.

unsubscribeInterface()

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

Parameters

prop

Reimplemented in OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector, and OpenRTM_aist.InPortPullConnector.InPortPullConnector.

---

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

• InPortConnector.py