OpenRTM_aist.InPort.InPort Class Reference

InPort template class. More...

Inheritance diagram for OpenRTM_aist.InPort.InPort:

Public Member Functions
def	__init__ (self, name, value, buffer=None, read_block=False, write_block=False, read_timeout=0, write_timeout=0)
	A constructor. More...
def	name (self)
	const char* name()
def	isNew (self)
	bool isNew()
def	isEmpty (self)
	Check whether the data is newest. More...
def	read (self)
	Readout the value from DataPort. More...
def	update (self)
	Read into bound T-type data from current InPort. More...
def	write (self, data)
Public Member Functions inherited from OpenRTM_aist.InPortBase.InPortBase
def	__init__ (self, name, data_type)
	Constructor. More...
def	__del__ (self, PortBase=OpenRTM_aist.PortBase)
	Destructor. More...
def	init (self, prop)
	Initializing properties. More...
def	read (self)
	It is a virtual method that is called from RTObject_impl::readAll(). More...
def	properties (self)
	Get properties. More...
def	connectors (self)
	Connector list. More...
def	getConnectorProfiles (self)
	ConnectorProfile list. More...
def	getConnectorIds (self)
	ConnectorId list. More...
def	getConnectorNames (self)
	Connector name list. More...
def	getConnectorById (self, id)
	Getting ConnectorProfile by ID. More...
def	getConnectorByName (self, name)
	Getting Connector by name. More...
def	getConnectorProfileById (self, id, prof)
	Getting ConnectorProfile by name. More...
def	getConnectorProfileByName (self, name, prof)
	Getting ConnectorProfile by name. More...
def	connect (self, connector_profile)
	[CORBA interface] Connect the Port More...
def	notify_connect (self, connector_profile)
def	activateInterfaces (self)
	Activate all Port interfaces. More...
def	deactivateInterfaces (self)
	Deactivate all Port interfaces. More...
def	addConnectorDataListener (self, listener_type, listener, autoclean=True)
	Adding BufferDataListener type listener. More...
def	removeConnectorDataListener (self, listener_type, listener)
	Removing BufferDataListener type listener. More...
def	addConnectorListener (self, listener_type, listener, autoclean=True)
	Adding ConnectorListener type listener. More...
def	removeConnectorListener (self, listener_type, listener)
	Removing BufferDataListener type listener. More...
def	publishInterfaces (self, cprof)
	Publish interface information. More...
def	subscribeInterfaces (self, cprof)
	Subscribe to the interface. More...
def	unsubscribeInterfaces (self, connector_profile)
	Disconnect the interface connection. More...
def	initProviders (self)
	InPort provider initializationvoid initProviders();.
def	initConsumers (self)
	OutPort consumer initializationvoid initConsumers();.
def	createProvider (self, cprof, prop)
	InPort provider creationInPortProvider* createProvider(ConnectorProfile& cprof, coil::Properties& prop);.
def	createConsumer (self, cprof, prop)
	InPort provider creationOutPortConsumer* createConsumer(const ConnectorProfile& cprof, coil::Properties& prop);.
def	createConnector (self, cprof, prop, provider_=None, consumer_=None)
	InPortPushConnector creationInPortConnector* createConnector(ConnectorProfile& cprof, coil::Properties& prop, InPortProvider* provider);.
def	getLocalOutPort (self, profile)
	Getting local peer OutPort if available. More...
Public Member Functions inherited from OpenRTM_aist.PortBase.PortBase
def	__init__ (self, name=None)
	Constructor. More...
def	__del__ (self)
	Destructor. More...
def	exit (self)
def	get_port_profile (self)
	[CORBA interface] Get the PortProfile of the Port More...
def	getPortProfile (self)
	Get the PortProfile of the Port. More...
def	get_connector_profiles (self)
	[CORBA interface] Get the ConnectorProfileList of the Port More...
def	get_connector_profile (self, connector_id)
	[CORBA interface] Get the ConnectorProfile More...
def	connect (self, connector_profile)
	[CORBA interface] Connect the Port More...
def	notify_connect (self, connector_profile)
	[CORBA interface] Notify the Ports connection More...
def	disconnect (self, connector_id)
	[CORBA interface] Disconnect the Port More...
def	notify_disconnect (self, connector_id)
	[CORBA interface] Notify the Ports disconnection More...
def	disconnect_all (self)
	[CORBA interface] Connect the Port More...
def	setName (self, name)
	Set the name of this Port. More...
def	getName (self)
	Get the name of this Port. More...
def	getProfile (self)
	Get the PortProfile of the Port. More...
def	setPortRef (self, port_ref)
	Set the object reference of this Port. More...
def	getPortRef (self)
	Get the object reference of this Port. More...
def	setOwner (self, owner)
	Set the owner RTObject of the Port. More...
def	setOnPublishInterfaces (self, on_publish)
	Setting callback called on publish interfaces. More...
def	setOnSubscribeInterfaces (self, on_subscribe)
	Setting callback called on publish interfaces. More...
def	setOnConnected (self, on_connected)
	Setting callback called on connection established. More...
def	setOnUnsubscribeInterfaces (self, on_subscribe)
	Setting callback called on unsubscribe interfaces. More...
def	setOnDisconnected (self, on_disconnected)
	Setting callback called on disconnected. More...
def	setPortConnectListenerHolder (self, portconnListeners)
	Setting PortConnectListener holder. More...
def	publishInterfaces (self, connector_profile)
	Publish interface information. More...
def	connectNext (self, connector_profile)
	Call notify_connect() of the next Port. More...
def	disconnectNext (self, connector_profile)
	Call notify_disconnect() of the next Port. More...
def	subscribeInterfaces (self, connector_profile)
	Publish interface information. More...
def	unsubscribeInterfaces (self, connector_profile)
	Disconnect interface connection. More...
def	setConnectionLimit (self, limit_value)
	Set the maximum number of connections. More...
def	isEmptyId (self, connector_profile)
	Whether connector_id of ConnectorProfile is empty. More...
def	getUUID (self)
	Get the UUID. More...
def	setUUID (self, connector_profile)
	Create and set the UUID to the ConnectorProfile. More...
def	isExistingConnId (self, id_)
	Whether the given id exists in stored ConnectorProfiles. More...
def	findConnProfile (self, id_)
	Find ConnectorProfile with id. More...
def	findConnProfileIndex (self, id_)
	Find ConnectorProfile with id. More...
def	updateConnectorProfile (self, connector_profile)
	Append or update the ConnectorProfile list. More...
def	eraseConnectorProfile (self, id_)
	Delete the ConnectorProfile. More...
def	appendInterface (self, instance_name, type_name, pol)
	Append an interface to the PortInterfaceProfile. More...
def	deleteInterface (self, name, pol)
	Delete an interface from the PortInterfaceProfile. More...
def	addProperty (self, key, value)
	Add NameValue data to PortProfile's properties. More...
def	appendProperty (self, key, value)
	Append NameValue data to PortProfile's properties. More...
def	updateConnectors (self)
	Disconnect ports that doesn't exist. More...
def	checkPorts (self, ports)
	Existence of ports. More...
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def	toString (status)
	Convert DataPortStatus into the string. More...

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

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

def OpenRTM_aist.InPort.InPort.__init__	(		self,
			name,
			value,
			buffer = None,
			read_block = False,
			write_block = False,
			read_timeout = 0,
			write_timeout = 0
	)

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.
read_block
write_block
read_timeout
write_timeout

Member Function Documentation

def OpenRTM_aist.InPort.InPort.isEmpty

(

self

)

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

def OpenRTM_aist.InPort.InPort.read

(

self

)

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

def OpenRTM_aist.InPort.InPort.update

(

self

)

Read into bound T-type data from current InPort.

def 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:

• /home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/InPort.py