OpenRTM_aist.InPortBase.InPortBase Class Reference

More...

Inheritance diagram for OpenRTM_aist.InPortBase.InPortBase:

Public Member Functions
def	__init__ (self, name, data_type)
def	__del__ (self, PortBase=OpenRTM_aist.PortBase)
def	init (self, prop)
def	read (self)
def	properties (self)
def	connectors (self)
def	getConnectorProfiles (self)
def	getConnectorIds (self)
def	getConnectorNames (self)
def	getConnectorById (self, id)
def	getConnectorByName (self, name)
def	getConnectorProfileById (self, id)
def	getConnectorProfileByName (self, name)
def	connect (self, connector_profile)
def	notify_connect (self, connector_profile)
def	activateInterfaces (self)
def	deactivateInterfaces (self)
def	addConnectorDataListener (self, listener_type, listener)
def	removeConnectorDataListener (self, listener_type, listener)
def	addConnectorListener (self, listener_type, listener)
def	removeConnectorListener (self, listener_type, listener)
def	publishInterfaces (self, cprof)
def	subscribeInterfaces (self, cprof)
def	unsubscribeInterfaces (self, connector_profile)
def	initProviders (self)
def	initConsumers (self)
def	createProvider (self, cprof, prop)
def	createConsumer (self, cprof, prop)
def	createConnector (self, cprof, prop, provider_=None, consumer_=None)
def	createDuplexConnector (self, cprof, prop, provider_)
def	getLocalOutPort (self, profile)
Public Member Functions inherited from OpenRTM_aist.PortBase.PortBase
def	__init__ (self, name=None)
def	__del__ (self)
def	exit (self)
def	get_port_profile (self)
def	getPortProfile (self)
def	get_connector_profiles (self)
def	get_connector_profile (self, connector_id)
def	connect (self, connector_profile)
def	notify_connect (self, connector_profile)
def	disconnect (self, connector_id)
def	notify_disconnect (self, connector_id)
def	disconnect_all (self)
def	setName (self, name)
def	getName (self)
def	getProfile (self)
def	setPortRef (self, port_ref)
def	getPortRef (self)
def	setOwner (self, owner)
def	setOnPublishInterfaces (self, on_publish)
def	setOnSubscribeInterfaces (self, on_subscribe)
def	setOnConnected (self, on_connected)
def	setOnUnsubscribeInterfaces (self, on_subscribe)
def	setOnDisconnected (self, on_disconnected)
def	setPortConnectListenerHolder (self, portconnListeners)
def	publishInterfaces (self, connector_profile)
def	connectNext (self, connector_profile)
def	disconnectNext (self, connector_profile)
def	subscribeInterfaces (self, connector_profile)
def	unsubscribeInterfaces (self, connector_profile)
def	setConnectionLimit (self, limit_value)
def	isEmptyId (self, connector_profile)
def	getUUID (self)
def	setUUID (self, connector_profile)
def	isExistingConnId (self, id_)
def	findConnProfile (self, id_)
def	findConnProfileIndex (self, id_)
def	updateConnectorProfile (self, connector_profile)
def	eraseConnectorProfile (self, id_)
def	appendInterface (self, instance_name, type_name, pol)
def	deleteInterface (self, name, pol)
def	addProperty (self, key, value)
def	appendProperty (self, key, value)
def	updateConnectors (self)
def	checkPorts (self, ports)
def	isExistingMarshalingType (self, con_prop)
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def	toString (status)

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

Detailed Description

Port for InPort

This is an implementation class for the data input port.

Since

0.4.0

Constructor & Destructor Documentation

__init__()

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

Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.

Reimplemented in OpenRTM_aist.EventPort.EventInPort, OpenRTM_aist.EventPort_pyfsm.EventInPort, OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.InPort.InPort, and OpenRTM_aist.CSPInPort.CSPInPort.

__del__()

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

Destructor

Destructor

Reimplemented from OpenRTM_aist.PortBase.PortBase.

Reimplemented in OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, OpenRTM_aist.EventPort.EventInPort, OpenRTM_aist.EventPort_pyfsm.EventInPort, and OpenRTM_aist.InPort.InPort.

Member Function Documentation

activateInterfaces()

def OpenRTM_aist.InPortBase.InPortBase.activateInterfaces

(

self

)

Activate all Port interfaces

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

void activateInterfaces();

addConnectorDataListener()

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

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

void addConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener)

addConnectorListener()

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

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

void addConnectorListener(ConnectorListenerType type, ConnectorListener* listener)

connect()

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.

connectors()

def OpenRTM_aist.InPortBase.InPortBase.connectors

(

self

)

Connector list

This operation returns connector list

Returns

connector list

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

createConnector()

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

InPortPushConnector creation

InPortConnector* createConnector(ConnectorProfile& cprof, coil::Properties& prop, InPortProvider* provider);

createConsumer()

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

InPort provider creation

OutPortConsumer* createConsumer(const ConnectorProfile& cprof, coil::Properties& prop);

createDuplexConnector()

def OpenRTM_aist.InPortBase.InPortBase.createDuplexConnector	(		self,
			cprof,
			prop,
			provider_
	)

InPortDuplexConnector creation

Parameters

cprof
prop
provider_

Returns

createProvider()

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

InPort provider creation

InPortProvider* createProvider(ConnectorProfile& cprof, coil::Properties& prop);

deactivateInterfaces()

def OpenRTM_aist.InPortBase.InPortBase.deactivateInterfaces

(

self

)

Deactivate all Port interfaces

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

void deactivateInterfaces();

getConnectorById()

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

getConnectorByName()

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

getConnectorIds()

def OpenRTM_aist.InPortBase.InPortBase.getConnectorIds

(

self

)

ConnectorId list

This operation returns ConnectorId list

Returns

connector list

coil::vstring getConnectorIds();

getConnectorNames()

def OpenRTM_aist.InPortBase.InPortBase.getConnectorNames

(

self

)

Connector name list

This operation returns Connector name list

Returns

connector name list

coil::vstring getConnectorNames();

getConnectorProfileById()

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

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

getConnectorProfileByName()

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

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

getConnectorProfiles()

def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfiles

(

self

)

ConnectorProfile list

This operation returns ConnectorProfile list

Returns

connector list

ConnectorInfoList getConnectorProfiles();

getLocalOutPort()

def OpenRTM_aist.InPortBase.InPortBase.getLocalOutPort	(		self,
			profile
	)

Getting local peer OutPort if available

Parameters

self
profile

Returns

OutPortBase* getLocalOutPort(const ConnectorInfo& profile)

init()

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

Reimplemented in OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, OpenRTM_aist.EventPort.EventInPort, and OpenRTM_aist.EventPort_pyfsm.EventInPort.

initConsumers()

def OpenRTM_aist.InPortBase.InPortBase.initConsumers

(

self

)

OutPort consumer initialization

void initConsumers();

initProviders()

def OpenRTM_aist.InPortBase.InPortBase.initProviders

(

self

)

InPort provider initialization

void initProviders();

notify_connect()

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

Parameters

self
connector_profile

Returns

Reimplemented from OpenRTM_aist.PortBase.PortBase.

Reimplemented in OpenRTM_aist.CSPEventPort.CSPEventPort, and OpenRTM_aist.CSPInPort.CSPInPort.

properties()

def OpenRTM_aist.InPortBase.InPortBase.properties

(

self

)

Get properties

Getting properties of this InPort

Returns

InPort's properties

publishInterfaces()

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.

read()

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.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, and OpenRTM_aist.InPort.InPort.

removeConnectorDataListener()

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)

removeConnectorListener()

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)

subscribeInterfaces()

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

Reimplemented from OpenRTM_aist.PortBase.PortBase.

unsubscribeInterfaces()

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

Reimplemented from OpenRTM_aist.PortBase.PortBase.

---

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

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/InPortBase.py