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

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

Reimplemented in OpenRTM_aist.OutPort.OutPort.

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.

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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 256 of file OutPortBase.py.

OpenRTM_aist::OutPortBase.OutPortBase::_connectors [private]

Definition at line 256 of file OutPortBase.py.

OpenRTM_aist::OutPortBase.OutPortBase::_consumers [private]

Definition at line 256 of file OutPortBase.py.

OpenRTM_aist::OutPortBase.OutPortBase::_consumerTypes [private]

Definition at line 256 of file OutPortBase.py.

OpenRTM_aist::OutPortBase.OutPortBase::_listeners [private]

Definition at line 256 of file OutPortBase.py.

OpenRTM_aist::OutPortBase.OutPortBase::_name [private]

Definition at line 256 of file OutPortBase.py.

OpenRTM_aist::OutPortBase.OutPortBase::_properties [private]

Definition at line 256 of file OutPortBase.py.

OpenRTM_aist::OutPortBase.OutPortBase::_providerTypes [private]

Definition at line 256 of file OutPortBase.py.

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

OutPortBase.py

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation