OpenRTM_aist.InPortBase.InPortBase Class Reference

Port for InPort. More...

Inheritance diagram for OpenRTM_aist.InPortBase.InPortBase:

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

Private Attributes
	_connector_mutex
	_connectors
	_consumerTypes
	_listeners
	_properties
	_providerTypes
	_singlebuffer
	_thebuffer
	_value

Additional Inherited Members
Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int	BUFFER_EMPTY = 4
int	BUFFER_ERROR = 2
int	BUFFER_FULL = 3
int	BUFFER_TIMEOUT = 5
int	CONNECTION_LOST = 12
int	INVALID_ARGS = 10
int	PORT_ERROR = 1
int	PORT_OK = 0
	DataPortStatus return codes. More...
int	PRECONDITION_NOT_MET = 11
int	RECV_EMPTY = 8
int	RECV_TIMEOUT = 9
int	SEND_FULL = 6
int	SEND_TIMEOUT = 7
	toString = staticmethod(toString)
int	UNKNOWN_ERROR = 13

Detailed Description

Port for InPort.

This is an implementation class for the data input port.

Since

0.4.0

Definition at line 58 of file InPortBase.py.

Constructor & Destructor Documentation

def OpenRTM_aist.InPortBase.InPortBase.__init__	(		self,
			name,
			data_type
	)

Constructor.

Constructor

Parameters

name	Port name
inport	InPort object that is associated with this data input port. Specify also the data type and the buffer type used in the InPort object.
prop	Property for setting ports

InPortBase(const char* name, const char* data_type);

Definition at line 87 of file InPortBase.py.

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

Destructor.

Destructor

Definition at line 123 of file InPortBase.py.

Member Function Documentation

def OpenRTM_aist.InPortBase.InPortBase.activateInterfaces

(

self

)

Activate all Port interfaces.

This operation activate all interfaces that is registered in the ports.

void activateInterfaces();

Definition at line 516 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.addConnectorDataListener	(		self,
			listener_type,
			listener,
			autoclean = True
	)

Adding BufferDataListener type listener.

This operation adds certain listeners related to buffer writing and reading events. The following listener types are available.

• ON_BUFFER_WRITE: At the time of buffer write
• ON_BUFFER_FULL: At the time of buffer full
• ON_BUFFER_WRITE_TIMEOUT: At the time of buffer write timeout
• ON_BUFFER_OVERWRITE: At the time of buffer overwrite
• ON_BUFFER_READ: At the time of buffer read
• ON_SEND: At the time of sending to InPort
• ON_RECEIVED: At the time of finishing sending to InPort
• ON_SENDER_TIMEOUT: At the time of timeout of OutPort
• ON_SENDER_ERROR: At the time of error of OutPort
• ON_RECEIVER_FULL: At the time of bufferfull of InPort
• ON_RECEIVER_TIMEOUT: At the time of timeout of InPort
• ON_RECEIVER_ERROR: At the time of error of InPort

Listeners should have the following function operator().

ConnectorDataListener:: operator()(const ConnectorProfile&, const cdrStream&)

The ownership of the given listener object is transferred to this OutPort object in default. The given listener object will be destroied automatically in the OutPort's dtor or if the listener is deleted by removeConnectorDataListener() function. If you want to keep ownership of the listener object, give "false" value to 3rd argument to inhibit automatic destruction.

Parameters

listener_type	A listener type
listener	A pointer to a listener object
autoclean	A flag for automatic listener destruction

void addConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener, bool autoclean)

Definition at line 635 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.addConnectorListener	(		self,
			listener_type,
			listener,
			autoclean = True
	)

Adding ConnectorListener type listener.

This operation adds certain listeners related to buffer writing and reading events. The following listener types are available.

• ON_BUFFER_EMPTY: At the time of buffer empty
• ON_BUFFER_READTIMEOUT: At the time of buffer read timeout

Listeners should have the following function operator().

ConnectorListener::operator()(const ConnectorProfile&)

The ownership of the given listener object is transferred to this OutPort object in default. The given listener object will be destroied automatically in the OutPort's dtor or if the listener is deleted by removeConnectorListener() function. If you want to keep ownership of the listener object, give "false" value to 3rd argument to inhibit automatic destruction.

Parameters

listener_type	A listener type
listener	A pointer to a listener object
autoclean	A flag for automatic listener destruction

void addConnectorListener(ConnectorListenerType type, ConnectorListener* listener, bool autoclean)

Definition at line 733 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.connect	(		self,
			connector_profile
	)

[CORBA interface] Connect the Port

This operation establishes connection according to the given ConnectionProfile inforamtion. This function is premised on calling from mainly application program or tools.

Parameters

connector_profile

The ConnectorProfile.

Returns

ReturnCode_t The return code of ReturnCode_t type.

Definition at line 489 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.connectors

(

self

)

Connector list.

This operation returns connector list

Returns

connector list

const std::vector<InPortConnector*>& connectors();

Definition at line 241 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.createConnector	(		self,
			cprof,
			prop,
			provider_ = None,
			consumer_ = None
	)

InPortPushConnector creationInPortConnector* createConnector(ConnectorProfile& cprof, coil::Properties& prop, InPortProvider* provider);.

Definition at line 1178 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.createConsumer	(		self,
			cprof,
			prop
	)

InPort provider creationOutPortConsumer* createConsumer(const ConnectorProfile& cprof, coil::Properties& prop);.

Definition at line 1138 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.createProvider	(		self,
			cprof,
			prop
	)

InPort provider creationInPortProvider* createProvider(ConnectorProfile& cprof, coil::Properties& prop);.

Definition at line 1098 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.deactivateInterfaces

(

self

)

Deactivate all Port interfaces.

This operation deactivate all interfaces that is registered in the ports.

void deactivateInterfaces();

Definition at line 545 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.getConnectorById	(		self,
			id
	)

Getting ConnectorProfile by ID.

This operation returns Connector specified by ID.

Parameters

id	Connector ID

Returns

A pointer to connector

InPortConnector* getConnectorById(const char* id);

Definition at line 353 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.getConnectorByName	(		self,
			name
	)

Getting Connector by name.

This operation returns Connector specified by name.

Parameters

id	Connector ID

Returns

A pointer to connector

InPortConnector* getConnectorByName(const char* name);

Definition at line 384 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.getConnectorIds

(

self

)

ConnectorId list.

This operation returns ConnectorId list

Returns

connector list

coil::vstring getConnectorIds();

Definition at line 294 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.getConnectorNames

(

self

)

Connector name list.

This operation returns Connector name list

Returns

connector name list

coil::vstring getConnectorNames();

Definition at line 323 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfileById	(		self,
			id,
			prof
	)

Getting ConnectorProfile by name.

This operation returns ConnectorProfile specified by name

Parameters

id	Connector ID
prof	ConnectorProfile

Returns

false¡¡specified ID does not exist

bool getConnectorProfileById(const char* id, ConnectorInfo& prof);

Definition at line 418 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfileByName	(		self,
			name,
			prof
	)

Getting ConnectorProfile by name.

This operation returns ConnectorProfile specified by name

Parameters

id	Connector ID
prof	ConnectorProfile

Returns

false specified name does not exist

bool getConnectorProfileByName(const char* name, ConnectorInfo& prof);

Definition at line 453 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfiles

(

self

)

ConnectorProfile list.

This operation returns ConnectorProfile list

Returns

connector list

ConnectorInfoList getConnectorProfiles();

Definition at line 266 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.init	(		self,
			prop
	)

Initializing properties.

This method initializes the port in the specified property.

Parameters

prop	Property for setting ports

void init(coil::Properties& prop);

Definition at line 157 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.initConsumers

(

self

)

OutPort consumer initializationvoid initConsumers();.

Definition at line 1050 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.initProviders

(

self

)

InPort provider initializationvoid initProviders();.

Definition at line 1006 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.properties

(

self

)

Get properties.

Getting properties of this InPort

Returns

InPort's properties

Definition at line 217 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.publishInterfaces	(		self,
			cprof
	)

Publish interface information.

Publish interface information. Assign the Provider information that owned by this port to ConnectorProfile::properties

Parameters

connector_profile

The connector profile

Returns

The return code of ReturnCode_t type

ReturnCode_t publishInterfaces(ConnectorProfile& connector_profile);

Definition at line 805 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.read

(

self

)

It is a virtual method that is called from RTObject_impl::readAll().

This method reads out data from DataPort.

Returns

true:Success,false:Failure

virtual bool read() = 0;

Definition at line 196 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.removeConnectorDataListener	(		self,
			listener_type,
			listener
	)

Removing BufferDataListener type listener.

This operation removes a specified listener.

Parameters

listener_type	A listener type
listener	A pointer to a listener object

void removeConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener)

Definition at line 667 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.removeConnectorListener	(		self,
			listener_type,
			listener
	)

Removing BufferDataListener type listener.

This operation removes a specified listener.

Parameters

listener_type	A listener type
listener	A pointer to a listener object

void removeConnectorListener(ConnectorListenerType type, ConnectorListener* listener)

Definition at line 765 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.subscribeInterfaces	(		self,
			cprof
	)

Subscribe to the interface.

Subscribe to interface. Derive Provider information that matches Consumer owned by the Port from ConnectorProfile::properties and set the Consumer to the reference of the CORBA object.

Parameters

connector_profile

The connector profile

Returns

ReturnCode_t The return code of ReturnCode_t type

ReturnCode_t subscribeInterfaces(const ConnectorProfile& connector_profile);

Definition at line 889 of file InPortBase.py.

def OpenRTM_aist.InPortBase.InPortBase.unsubscribeInterfaces	(		self,
			connector_profile
	)

Disconnect the interface connection.

Disconnect the interface connection. Release all objects set in Consumer associated with given ConnectorProfile and unscribe the interface.

Parameters

connector_profile

The connector profile

void unsubscribeInterfaces(const ConnectorProfile& connector_profile);

Definition at line 976 of file InPortBase.py.

Member Data Documentation

OpenRTM_aist.InPortBase.InPortBase._connector_mutex

private

Definition at line 96 of file InPortBase.py.

OpenRTM_aist.InPortBase.InPortBase._connectors

private

Definition at line 95 of file InPortBase.py.

OpenRTM_aist.InPortBase.InPortBase._consumerTypes

private

Definition at line 94 of file InPortBase.py.

OpenRTM_aist.InPortBase.InPortBase._listeners

private

Definition at line 107 of file InPortBase.py.

OpenRTM_aist.InPortBase.InPortBase._properties

private

Definition at line 92 of file InPortBase.py.

OpenRTM_aist.InPortBase.InPortBase._providerTypes

private

Definition at line 93 of file InPortBase.py.

OpenRTM_aist.InPortBase.InPortBase._singlebuffer

private

Definition at line 90 of file InPortBase.py.

OpenRTM_aist.InPortBase.InPortBase._thebuffer

private

Definition at line 91 of file InPortBase.py.

OpenRTM_aist.InPortBase.InPortBase._value

private

Definition at line 106 of file InPortBase.py.

---

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

• InPortBase.py