OpenRTM_aist.OutPortBase.OutPortBase Class Reference

More...

Inheritance diagram for OpenRTM_aist.OutPortBase.OutPortBase:

Classes
class	connector_cleanup

Public Member Functions
	__init__ (self, name, data_type)
	__del__ (self, PortBase=OpenRTM_aist.PortBase)
	init (self, prop)
	write (self)
	connect (self, connector_profile)
	notify_connect (self, connector_profile)
	properties (self)
	connectors (self)
	getConnectorProfiles (self)
	getConnectorIds (self)
	getConnectorNames (self)
	getConnectorById (self, id)
	getConnectorByName (self, name)
	getConnectorProfileById (self, id)
	getConnectorProfileByName (self, name)
	activateInterfaces (self)
	deactivateInterfaces (self)
	addConnectorDataListener (self, listener_type, listener)
	removeConnectorDataListener (self, listener_type, listener)
	addConnectorListener (self, callback_type, listener)
	removeConnectorListener (self, callback_type, listener)
	configure (self)
	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_)
	getLocalInPort (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

Output base class.

The base class of OutPort<T> which are implementations of OutPort

Form a kind of Observer pattern with OutPortBase and PublisherBase. attach(), detach(), notify() of OutPortBase and push() of PublisherBase are methods associated with the Observer pattern.

Since

0.2.0

Constructor & Destructor Documentation

__init__()

OpenRTM_aist.OutPortBase.OutPortBase.__init__	(		self,
			name,
			data_type )

A constructor of OutPortBase class.

Constructor of OutPortBase.

OutPortBase.OutPortBase(const char* name, const char* data_type)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

Reimplemented in OpenRTM_aist.CSPOutPort.CSPOutPort, and OpenRTM_aist.OutPort.OutPort.

__del__()

OpenRTM_aist.OutPortBase.OutPortBase.__del__	(		self,
			PortBase = OpenRTM_aist.PortBase )

destructor

Destructor

Reimplemented from OpenRTM_aist.PortBase.PortBase.

Reimplemented in OpenRTM_aist.CSPOutPort.CSPOutPort, and OpenRTM_aist.OutPort.OutPort.

Member Function Documentation

activateInterfaces()

OpenRTM_aist.OutPortBase.OutPortBase.activateInterfaces

(

self

)

Activate all Port interfaces

void OutPortBase.activateInterfaces()

addConnectorDataListener()

OpenRTM_aist.OutPortBase.OutPortBase.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 listener_type, ConnectorDataListener* listener);

addConnectorListener()

OpenRTM_aist.OutPortBase.OutPortBase.addConnectorListener	(		self,
			callback_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 callback_type, ConnectorListener* listener);

configure()

OpenRTM_aist.OutPortBase.OutPortBase.configure

(

self

)

Configureing outport

void OutPortBase.configure()

connect()

OpenRTM_aist.OutPortBase.OutPortBase.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()

OpenRTM_aist.OutPortBase.OutPortBase.connectors

(

self

)

Connector list

const std.vector<OutPortConnector*>& OutPortBase.connectors()

createConnector()

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

OutPortPushConnector creation

OutPortConnector* OutPortBase.createConnector(const ConnectorProfile& cprof, coil.Properties& prop, InPortConsumer* consumer)

createConsumer()

OpenRTM_aist.OutPortBase.OutPortBase.createConsumer	(		self,
			cprof,
			prop )

InPort consumer creation

InPortConsumer* OutPortBase.createConsumer(const ConnectorProfile& cprof, coil.Properties& prop)

createDuplexConnector()

OpenRTM_aist.OutPortBase.OutPortBase.createDuplexConnector	(		self,
			cprof,
			prop,
			provider_ )

InPortDuplexConnector creation

Parameters

cprof
prop
provider_

Returns

createProvider()

OpenRTM_aist.OutPortBase.OutPortBase.createProvider	(		self,
			cprof,
			prop )

OutPort provider creation

OutPortProvider* OutPortBase.createProvider(ConnectorProfile& cprof, coil.Properties& prop)

deactivateInterfaces()

OpenRTM_aist.OutPortBase.OutPortBase.deactivateInterfaces

(

self

)

Deactivate all Port interfaces

void OutPortBase.deactivateInterfaces()

getConnectorById()

OpenRTM_aist.OutPortBase.OutPortBase.getConnectorById	(		self,
			id )

Getting ConnectorProfile by ID

This operation returns Connector specified by ID.

Parameters

id	Connector ID

Returns

A pointer to connector

OutPortConnector* getConnectorById(const char* id);

getConnectorByName()

OpenRTM_aist.OutPortBase.OutPortBase.getConnectorByName	(		self,
			name )

Getting Connector by name

This operation returns Connector specified by name.

Parameters

id	Connector ID

Returns

A pointer to connector

OutPortConnector* getConnectorByName(const char* name);

getConnectorIds()

OpenRTM_aist.OutPortBase.OutPortBase.getConnectorIds

(

self

)

ConnectorId list

coil.vstring OutPortBase.getConnectorIds()

getConnectorNames()

OpenRTM_aist.OutPortBase.OutPortBase.getConnectorNames

(

self

)

Connector name list

coil.vstring OutPortBase.getConnectorNames()

getConnectorProfileById()

OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfileById	(		self,
			id )

Getting ConnectorProfile by name

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

getConnectorProfileByName()

OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfileByName	(		self,
			name )

Getting ConnectorProfile by name

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

getConnectorProfiles()

OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfiles

(

self

)

ConnectorProfile list

ConnectorBase.ConnectorInfoList OutPortBase.getConnectorProfiles()

getLocalInPort()

OpenRTM_aist.OutPortBase.OutPortBase.getLocalInPort	(		self,
			profile )

Getting local peer InPort if available

Parameters

self
profile

Returns

InPortBase* getLocalInPort(const ConnectorInfo& profile)

init()

OpenRTM_aist.OutPortBase.OutPortBase.init	(		self,
			prop )

Initializing properties

This operation initializes outport's properties

void init(coil.Properties& prop);

Reimplemented in OpenRTM_aist.CSPOutPort.CSPOutPort.

initConsumers()

OpenRTM_aist.OutPortBase.OutPortBase.initConsumers

(

self

)

InPort consumer initialization

void OutPortBase.initConsumers()

initProviders()

OpenRTM_aist.OutPortBase.OutPortBase.initProviders

(

self

)

OutPort provider initialization

void OutPortBase.initProviders()

notify_connect()

OpenRTM_aist.OutPortBase.OutPortBase.notify_connect	(		self,
			connector_profile )

Parameters

self
connector_profile

Returns

Reimplemented from OpenRTM_aist.PortBase.PortBase.

Reimplemented in OpenRTM_aist.CSPOutPort.CSPOutPort.

properties()

OpenRTM_aist.OutPortBase.OutPortBase.properties

(

self

)

Get properties

Getting properties of this OutPort

Returns

OutPort's properties

coil.Properties& OutPortBase.properties()

publishInterfaces()

OpenRTM_aist.OutPortBase.OutPortBase.publishInterfaces	(		self,
			cprof )

Publish interface information

ReturnCode_t OutPortBase.publishInterfaces(ConnectorProfile& cprof)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

removeConnectorDataListener()

OpenRTM_aist.OutPortBase.OutPortBase.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 listener_type, ConnectorDataListener* listener);

removeConnectorListener()

OpenRTM_aist.OutPortBase.OutPortBase.removeConnectorListener	(		self,
			callback_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 callback_type, ConnectorListener* listener);

subscribeInterfaces()

OpenRTM_aist.OutPortBase.OutPortBase.subscribeInterfaces	(		self,
			cprof )

Subscribe interface

ReturnCode_t OutPortBase.subscribeInterfaces(const ConnectorProfile& cprof)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

unsubscribeInterfaces()

OpenRTM_aist.OutPortBase.OutPortBase.unsubscribeInterfaces	(		self,
			connector_profile )

Unsubscribe interface

void OutPortBase.unsubscribeInterfaces(const ConnectorProfile& connector_profile)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

write()

OpenRTM_aist.OutPortBase.OutPortBase.write

(

self

)

Write data

Write data to the port. Write the value, which was set to the bound variable, to the port.

Returns

Writing result (Successful:true, Failed:false)

virtual bool write() = 0;

Reimplemented in OpenRTM_aist.CSPOutPort.CSPOutPort, and OpenRTM_aist.OutPort.OutPort.

---

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

• OutPortBase.py