Inheritance diagram for OpenRTM_aist.InPortBase.InPortBase:

Public Member Functions
def	__del__
	Destructor.
def	__init__
	Constructor.
def	activateInterfaces
	Activate all Port interfaces.
def	addConnectorDataListener
	Adding BufferDataListener type listener.
def	addConnectorListener
	Adding ConnectorListener type listener.
def	connect
	[CORBA interface] Connect the Port
def	connectors
	Connector list.
def	createConnector
	InPortPushConnector creationInPortConnector* createConnector(ConnectorProfile& cprof, coil::Properties& prop, InPortProvider* provider);.
def	createConsumer
	InPort provider creationOutPortConsumer* createConsumer(const ConnectorProfile& cprof, coil::Properties& prop);.
def	createProvider
	InPort provider creationInPortProvider* createProvider(ConnectorProfile& cprof, coil::Properties& prop);.
def	deactivateInterfaces
	Deactivate all Port interfaces.
def	getConnectorById
	Getting ConnectorProfile by ID.
def	getConnectorByName
	Getting Connector by name.
def	getConnectorIds
	ConnectorId list.
def	getConnectorNames
	Connector name list.
def	getConnectorProfileById
	Getting ConnectorProfile by name.
def	getConnectorProfileByName
	Getting ConnectorProfile by name.
def	getConnectorProfiles
	ConnectorProfile list.
def	init
	Initializing properties.
def	initConsumers
	OutPort consumer initializationvoid initConsumers();.
def	initProviders
	InPort provider initializationvoid initProviders();.
def	properties
	Get properties.
def	publishInterfaces
	Publish interface information.
def	read
	It is a virtual method that is called from RTObject_impl::readAll().
def	removeConnectorDataListener
	Removing BufferDataListener type listener.
def	removeConnectorListener
	Removing BufferDataListener type listener.
def	subscribeInterfaces
	Subscribe to the interface.
def	unsubscribeInterfaces
	Disconnect the interface connection.
Private Attributes
	_connector_mutex
	_connectors
	_consumerTypes
	_listeners
	_properties
	_providerTypes
	_singlebuffer
	_thebuffer
	_value

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

Reimplemented in OpenRTM_aist.InPort.InPort.

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.

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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;

Reimplemented in OpenRTM_aist.InPort.InPort.

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