OpenRTM_aist.InPort.InPort Class Reference

More...

Inheritance diagram for OpenRTM_aist.InPort.InPort:

Public Member Functions
	__init__ (self, name, value)
	__del__ (self, InPortBase=OpenRTM_aist.InPortBase)
	name (self)
	const char* name()
	isNew (self, names=None)
	bool isNew()
	isEmpty (self, names=None)
	read (self, name=None)
	update (self)
	setOnRead (self, on_read)
	setOnReadConvert (self, on_rconvert)
	write (self, data)
Public Member Functions inherited from OpenRTM_aist.InPortBase.InPortBase
	init (self, prop)
	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)
	notify_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

InPort template class

This class template provides interfaces to input port. Component developer can define input value, which act as input port from other components, using this template. This is class template. This class have to be incarnated class as port value types. This value types are previously define RtComponent IDL. ex. type T: TimedFload, TimedLong etc...

Since

0.2.0

Constructor & Destructor Documentation

__init__()

OpenRTM_aist.InPort.InPort.__init__	(		self,
			name,
			value )

A constructor.

Setting channel name and registering channel value.

Parameters

self
name	A name of the InPort. This name is referred by InPortBase.name().
value	A channel value related with the channel.

Reimplemented from OpenRTM_aist.InPortBase.InPortBase.

__del__()

OpenRTM_aist.InPort.InPort.__del__	(		self,
			PortBase = OpenRTM_aist.InPortBase )

Destructor

Destructor

Reimplemented from OpenRTM_aist.InPortBase.InPortBase.

Member Function Documentation

isEmpty()

OpenRTM_aist.InPort.InPort.isEmpty	(		self,
			names = None )

Check whether the data is newest

Check whether the data stored at a current buffer position is newest.

Returns

Newest data check result ( true:Newest data. Data has not been readout yet. false:Past data．Data has already been readout.)

bool isEmpty()

read()

OpenRTM_aist.InPort.InPort.read	(		self,
			name = None )

Readout the value from DataPort

Readout the value from DataPort

• When Callback functor OnRead is already set, OnRead will be invoked before reading from the buffer held by DataPort.
• When the buffer held by DataPort can detect the underflow, and when it detected the underflow at reading, callback functor OnUnderflow will be invoked.
• When callback functor OnReadConvert is already set, the return value of operator() of OnReadConvert will be the return value of read().
• When timeout of reading is already set by setReadTimeout(), it waits for only timeout time until the state of the buffer underflow is reset, and if OnUnderflow is already set, this will be invoked to return.

Returns

Readout data

DataType read()

Reimplemented from OpenRTM_aist.InPortBase.InPortBase.

update()

OpenRTM_aist.InPort.InPort.update

(

self

)

Read into bound T-type data from current InPort

write()

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

Parameters

self
data	void write(const DataType& data)

---

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

• InPort.py