OpenRTM_aist.CSPEventPort.CSPEventPort Class Reference

More...

Inheritance diagram for OpenRTM_aist.CSPEventPort.CSPEventPort:

Classes
class	IsWritableListener
class	IsWritableZeroModeListener
class	WorkerThreadCtrl
class	WriteListener
class	WriteZeroModeListener

Public Member Functions
	__init__ (self, name, fsm=None, manager=None)
	__del__ (self)
	name (self)
	bindEvent0 (self, name, handler)
	bindEvent1 (self, name, handler, data_type)
	init (self, prop)
	setManager (self, manager)
	releaseManager (self)
	setWritingConnector (self, con)
	notify (self)
	notify_connect (self, connector_profile)
	getDataBufferMode (self, con, retry)
	dataPullBufferMode (self)
	dataPullBufferModeRetry (self)
	getDataZeroMode (self, con, retry)
	dataPullZeroMode (self)
	dataPullZeroModeRetry (self)
	select (self)
	reselect (self)
	setSyncMode (self, mode)
	getSyncMode (self)
	readData (self)
	read (self)
	readBufferMode (self)
	readZeroMode (self)
Public Member Functions inherited from OpenRTM_aist.InPortBase.InPortBase
	properties (self)
	connectors (self)
	getConnectorProfiles (self)
	getConnectorIds (self)
	getConnectorNames (self)
	getConnectorById (self, id)
	getConnectorByName (self, name)
	getConnectorProfileById (self, id)
	getConnectorProfileByName (self, name)
	connect (self, connector_profile)
	activateInterfaces (self)
	deactivateInterfaces (self)
	addConnectorDataListener (self, listener_type, listener)
	removeConnectorDataListener (self, listener_type, listener)
	addConnectorListener (self, listener_type, listener)
	removeConnectorListener (self, listener_type, listener)
	publishInterfaces (self, cprof)
	subscribeInterfaces (self, cprof)
	unsubscribeInterfaces (self, connector_profile)
	initProviders (self)
	initConsumers (self)
	createProvider (self, cprof, prop)
	createConsumer (self, cprof, prop)
	createConnector (self, cprof, prop, provider_=None, consumer_=None)
	createDuplexConnector (self, cprof, prop, provider_)
	getLocalOutPort (self, profile)
Public Member Functions inherited from OpenRTM_aist.PortBase.PortBase
	exit (self)
	get_port_profile (self)
	getPortProfile (self)
	get_connector_profiles (self)
	get_connector_profile (self, connector_id)
	disconnect (self, connector_id)
	notify_disconnect (self, connector_id)
	disconnect_all (self)
	setName (self, name)
	getName (self)
	getProfile (self)
	setPortRef (self, port_ref)
	getPortRef (self)
	setOwner (self, owner)
	setOnPublishInterfaces (self, on_publish)
	setOnSubscribeInterfaces (self, on_subscribe)
	setOnConnected (self, on_connected)
	setOnUnsubscribeInterfaces (self, on_subscribe)
	setOnDisconnected (self, on_disconnected)
	setPortConnectListenerHolder (self, portconnListeners)
	connectNext (self, connector_profile)
	disconnectNext (self, connector_profile)
	setConnectionLimit (self, limit_value)
	isEmptyId (self, connector_profile)
	getUUID (self)
	setUUID (self, connector_profile)
	isExistingConnId (self, id_)
	findConnProfile (self, id_)
	findConnProfileIndex (self, id_)
	updateConnectorProfile (self, connector_profile)
	eraseConnectorProfile (self, id_)
	appendInterface (self, instance_name, type_name, pol)
	deleteInterface (self, name, pol)
	addProperty (self, key, value)
	appendProperty (self, key, value)
	updateConnectors (self)
	checkPorts (self, ports)
	isExistingMarshalingType (self, con_prop)
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
Protected Member Functions inherited from OpenRTM_aist.PortBase.PortBase
	_publishInterfaces (self)

Detailed Description

CSPEventPort template class

Since

2.0.0

Constructor & Destructor Documentation

__init__()

OpenRTM_aist.CSPEventPort.CSPEventPort.__init__	(		self,
			name,
			fsm = None,
			manager = None )

A constructor.

constructor. This is bound to type-T variable given as a parameter.

Parameters

self
name	A name of the EventInPort. This name is referred by EventInPortBase.name().
value	type-T variable that is bound to this EventInPort.
fsm

Reimplemented from OpenRTM_aist.InPortBase.InPortBase.

__del__()

OpenRTM_aist.CSPEventPort.CSPEventPort.__del__

(

self

)

Destructor

Destructor

Parameters

self

Reimplemented from OpenRTM_aist.InPortBase.InPortBase.

Member Function Documentation

bindEvent0()

OpenRTM_aist.CSPEventPort.CSPEventPort.bindEvent0	(		self,
			name,
			handler )

Parameters

self
name
handler

bindEvent1()

OpenRTM_aist.CSPEventPort.CSPEventPort.bindEvent1	(		self,
			name,
			handler,
			data_type )

Parameters

self
name
handler
data_type

dataPullBufferMode()

OpenRTM_aist.CSPEventPort.CSPEventPort.dataPullBufferMode

(

self

)

Parameters

self

Returns

ret, data

dataPullBufferModeRetry()

OpenRTM_aist.CSPEventPort.CSPEventPort.dataPullBufferModeRetry

(

self

)

Parameters

self

Returns

ret, data

dataPullZeroMode()

OpenRTM_aist.CSPEventPort.CSPEventPort.dataPullZeroMode

(

self

)

Parameters

self

Returns

ret, data

dataPullZeroModeRetry()

OpenRTM_aist.CSPEventPort.CSPEventPort.dataPullZeroModeRetry

(

self

)

Parameters

self

Returns

ret, data

getDataBufferMode()

OpenRTM_aist.CSPEventPort.CSPEventPort.getDataBufferMode	(		self,
			con,
			retry )

Parameters

self
con
retry

Returns

ret, data

getDataZeroMode()

OpenRTM_aist.CSPEventPort.CSPEventPort.getDataZeroMode	(		self,
			con,
			retry )

Parameters

self
con
retry

Returns

ret, data

getSyncMode()

OpenRTM_aist.CSPEventPort.CSPEventPort.getSyncMode

(

self

)

Parameters

self

Returns

init()

OpenRTM_aist.CSPEventPort.CSPEventPort.init	(		self,
			prop )

Get port name

Parameters

self
prop

Reimplemented from OpenRTM_aist.InPortBase.InPortBase.

name()

OpenRTM_aist.CSPEventPort.CSPEventPort.name

(

self

)

Get port name

Get port name.

Parameters

self

Returns

The port name

notify()

OpenRTM_aist.CSPEventPort.CSPEventPort.notify

(

self

)

Parameters

self

notify_connect()

OpenRTM_aist.CSPEventPort.CSPEventPort.notify_connect	(		self,
			connector_profile )

Get port name

Parameters

self
connector_profile

Returns

ret, prof

Reimplemented from OpenRTM_aist.InPortBase.InPortBase.

read()

OpenRTM_aist.CSPEventPort.CSPEventPort.read

(

self

)

Parameters

self

Returns

Reimplemented from OpenRTM_aist.InPortBase.InPortBase.

readBufferMode()

OpenRTM_aist.CSPEventPort.CSPEventPort.readBufferMode

(

self

)

Parameters

self

Returns

readData()

OpenRTM_aist.CSPEventPort.CSPEventPort.readData

(

self

)

Parameters

self

Returns

readZeroMode()

OpenRTM_aist.CSPEventPort.CSPEventPort.readZeroMode

(

self

)

Parameters

self

Returns

releaseManager()

OpenRTM_aist.CSPEventPort.CSPEventPort.releaseManager

(

self

)

Parameters

self

reselect()

OpenRTM_aist.CSPEventPort.CSPEventPort.reselect

(

self

)

Parameters

self

Returns

select()

OpenRTM_aist.CSPEventPort.CSPEventPort.select

(

self

)

Parameters

self

Returns

setManager()

OpenRTM_aist.CSPEventPort.CSPEventPort.setManager	(		self,
			manager )

Parameters

self
manager

setSyncMode()

OpenRTM_aist.CSPEventPort.CSPEventPort.setSyncMode	(		self,
			mode )

Parameters

self
mode

setWritingConnector()

OpenRTM_aist.CSPEventPort.CSPEventPort.setWritingConnector	(		self,
			con )

Parameters

self
con

---

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

• CSPEventPort.py