OpenRTM_aist.OutPortBase.OutPortBase Class Reference

Output base class. More...

Inheritance diagram for OpenRTM_aist.OutPortBase.OutPortBase:

Classes
class	connector_cleanup
	Functor to delete Connectors. More...
class	provider_cleanup
	Functor to delete Providers. More...

Public Member Functions
def	__del__ (self, PortBase=OpenRTM_aist.PortBase)
	destructor More...
def	__init__ (self, name, data_type)
	A constructor of OutPortBase class. More...
def	activateInterfaces (self)
	Activate all Port interfacesvoid OutPortBase::activateInterfaces() More...
def	addConnectorDataListener (self, listener_type, listener, autoclean=True)
	Adding BufferDataListener type listener. More...
def	addConnectorListener (self, callback_type, listener, autoclean=True)
	Adding ConnectorListener type listener. More...
def	configure (self)
	Configureing outportvoid OutPortBase::configure() More...
def	connect (self, connector_profile)
	[CORBA interface] Connect the Port More...
def	connectors (self)
	Connector listconst std::vector<OutPortConnector*>& OutPortBase::connectors() More...
def	createConnector (self, cprof, prop, provider_=None, consumer_=None)
	OutPortPushConnector creationOutPortConnector* OutPortBase::createConnector(const ConnectorProfile& cprof, coil::Properties& prop, InPortConsumer* consumer) More...
def	createConsumer (self, cprof, prop)
	InPort consumer creationInPortConsumer* OutPortBase::createConsumer(const ConnectorProfile& cprof, coil::Properties& prop) More...
def	createProvider (self, cprof, prop)
	OutPort provider creationOutPortProvider* OutPortBase::createProvider(ConnectorProfile& cprof, coil::Properties& prop) More...
def	deactivateInterfaces (self)
	Deactivate all Port interfacesvoid OutPortBase::deactivateInterfaces() More...
def	getConnectorById (self, id)
	Getting ConnectorProfile by ID. More...
def	getConnectorByName (self, name)
	Getting Connector by name. More...
def	getConnectorIds (self)
	ConnectorId listcoil::vstring OutPortBase::getConnectorIds() More...
def	getConnectorNames (self)
	Connector name listcoil::vstring OutPortBase::getConnectorNames() More...
def	getConnectorProfileById (self, id, prof)
	Getting ConnectorProfile by namebool OutPortBase::getConnectorProfileById(const char* id, ConnectorInfo& prof) More...
def	getConnectorProfileByName (self, name, prof)
	Getting ConnectorProfile by namebool OutPortBase::getConnectorProfileByName(const char* name, ConnectorInfo& prof) More...
def	getConnectorProfiles (self)
	ConnectorProfile listConnectorBase::ConnectorInfoList OutPortBase::getConnectorProfiles() More...
def	init (self, prop)
	Initializing properties. More...
def	initConsumers (self)
	InPort consumer initializationvoid OutPortBase::initConsumers() More...
def	initProviders (self)
	OutPort provider initializationvoid OutPortBase::initProviders() More...
def	properties (self)
	Get properties. More...
def	publishInterfaces (self, cprof)
	Publish interface informationReturnCode_t OutPortBase::publishInterfaces(ConnectorProfile& cprof) More...
def	removeConnectorDataListener (self, listener_type, listener)
	Removing BufferDataListener type listener. More...
def	removeConnectorListener (self, callback_type, listener)
	Removing BufferDataListener type listener. More...
def	subscribeInterfaces (self, cprof)
	Subscribe interfaceReturnCode_t OutPortBase::subscribeInterfaces(const ConnectorProfile& cprof) More...
def	unsubscribeInterfaces (self, connector_profile)
	Unsubscribe interfacevoid OutPortBase::unsubscribeInterfaces(const ConnectorProfile& connector_profile) More...
def	write (self)
	Write data. 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
	_consumers
	_consumerTypes
	_listeners
	_name
	_properties
	_providerTypes

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

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

Definition at line 206 of file OutPortBase.py.

Constructor & Destructor Documentation

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

Definition at line 256 of file OutPortBase.py.

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

destructor

Destructor

Definition at line 304 of file OutPortBase.py.

Member Function Documentation

def OpenRTM_aist.OutPortBase.OutPortBase.activateInterfaces

(

self

)

Activate all Port interfacesvoid OutPortBase::activateInterfaces()

Definition at line 610 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.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 listener_type, ConnectorDataListener* listener, bool autoclean = true);

Definition at line 708 of file OutPortBase.py.

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

Definition at line 809 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.configure

(

self

)

Configureing outportvoid OutPortBase::configure()

Definition at line 862 of file OutPortBase.py.

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

Definition at line 397 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.connectors

(

self

)

Connector listconst std::vector<OutPortConnector*>& OutPortBase::connectors()

Definition at line 440 of file OutPortBase.py.

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

OutPortPushConnector creationOutPortConnector* OutPortBase::createConnector(const ConnectorProfile& cprof, coil::Properties& prop, InPortConsumer* consumer)

Definition at line 1207 of file OutPortBase.py.

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

InPort consumer creationInPortConsumer* OutPortBase::createConsumer(const ConnectorProfile& cprof, coil::Properties& prop)

Definition at line 1169 of file OutPortBase.py.

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

OutPort provider creationOutPortProvider* OutPortBase::createProvider(ConnectorProfile& cprof, coil::Properties& prop)

Definition at line 1133 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.deactivateInterfaces

(

self

)

Deactivate all Port interfacesvoid OutPortBase::deactivateInterfaces()

Definition at line 624 of file OutPortBase.py.

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

Definition at line 518 of file OutPortBase.py.

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

Definition at line 549 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorIds

(

self

)

ConnectorId listcoil::vstring OutPortBase::getConnectorIds()

Definition at line 470 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorNames

(

self

)

Connector name listcoil::vstring OutPortBase::getConnectorNames()

Definition at line 488 of file OutPortBase.py.

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

Getting ConnectorProfile by namebool OutPortBase::getConnectorProfileById(const char* id, ConnectorInfo& prof)

Definition at line 569 of file OutPortBase.py.

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

Getting ConnectorProfile by namebool OutPortBase::getConnectorProfileByName(const char* name, ConnectorInfo& prof)

Definition at line 590 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfiles

(

self

)

ConnectorProfile listConnectorBase::ConnectorInfoList OutPortBase::getConnectorProfiles()

Definition at line 453 of file OutPortBase.py.

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

Initializing properties.

This operation initializes outport's properties

void init(coil::Properties& prop);

Definition at line 328 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.initConsumers

(

self

)

InPort consumer initializationvoid OutPortBase::initConsumers()

Definition at line 1090 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.initProviders

(

self

)

OutPort provider initializationvoid OutPortBase::initProviders()

Definition at line 1048 of file OutPortBase.py.

def OpenRTM_aist.OutPortBase.OutPortBase.properties

(

self

)

Get properties.

Getting properties of this OutPort

Returns

OutPort's properties

coil::Properties& OutPortBase::properties()

Definition at line 427 of file OutPortBase.py.

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

Publish interface informationReturnCode_t OutPortBase::publishInterfaces(ConnectorProfile& cprof)

Definition at line 874 of file OutPortBase.py.

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

Definition at line 741 of file OutPortBase.py.

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

Definition at line 842 of file OutPortBase.py.

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

Subscribe interfaceReturnCode_t OutPortBase::subscribeInterfaces(const ConnectorProfile& cprof)

Definition at line 941 of file OutPortBase.py.

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

Unsubscribe interfacevoid OutPortBase::unsubscribeInterfaces(const ConnectorProfile& connector_profile)

Definition at line 1019 of file OutPortBase.py.

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

Definition at line 368 of file OutPortBase.py.

Member Data Documentation

OpenRTM_aist.OutPortBase.OutPortBase._connector_mutex

private

Definition at line 282 of file OutPortBase.py.

OpenRTM_aist.OutPortBase.OutPortBase._connectors

private

Definition at line 278 of file OutPortBase.py.

OpenRTM_aist.OutPortBase.OutPortBase._consumers

private

Definition at line 279 of file OutPortBase.py.

OpenRTM_aist.OutPortBase.OutPortBase._consumerTypes

private

Definition at line 281 of file OutPortBase.py.

OpenRTM_aist.OutPortBase.OutPortBase._listeners

private

Definition at line 284 of file OutPortBase.py.

OpenRTM_aist.OutPortBase.OutPortBase._name

private

Definition at line 277 of file OutPortBase.py.

OpenRTM_aist.OutPortBase.OutPortBase._properties

private

Definition at line 276 of file OutPortBase.py.

OpenRTM_aist.OutPortBase.OutPortBase._providerTypes

private

Definition at line 280 of file OutPortBase.py.

---

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

• OutPortBase.py