OpenRTM_aist.OutPortBase.OutPortBase Class Reference

Output base class. More...

Inheritance diagram for OpenRTM_aist.OutPortBase.OutPortBase:

List of all members.

Classes
class	connector_cleanup
	Functor to delete Connectors. More...
class	provider_cleanup
	Functor to delete Providers. More...
Public Member Functions
def	__init__
	A constructor of OutPortBase class.
def	__del__
	destructor
def	init
	Initializing properties.
def	write
	Write data.
def	connect
	[CORBA interface] Connect the Port
def	properties
	Get properties.
def	connectors
	Connector list.
def	getConnectorProfiles
	ConnectorProfile list.
def	getConnectorIds
	ConnectorId list.
def	getConnectorNames
	Connector name list.
def	getConnectorById
	Getting ConnectorProfile by ID.
def	getConnectorByName
	Getting Connector by name.
def	getConnectorProfileById
	Getting ConnectorProfile by name.
def	getConnectorProfileByName
	Getting ConnectorProfile by name.
def	activateInterfaces
	Activate all Port interfaces.
def	deactivateInterfaces
	Deactivate all Port interfaces.
def	addConnectorDataListener
	Adding BufferDataListener type listener.
def	removeConnectorDataListener
	Removing BufferDataListener type listener.
def	addConnectorListener
	Adding ConnectorListener type listener.
def	removeConnectorListener
	Removing BufferDataListener type listener.
def	configure
	Configureing outport.
def	publishInterfaces
	Publish interface information.
def	subscribeInterfaces
	Subscribe interface.
def	unsubscribeInterfaces
	Unsubscribe interface.
def	initProviders
	OutPort provider initialization.
def	initConsumers
	InPort consumer initialization.
def	createProvider
	OutPort provider creation.
def	createConsumer
	InPort consumer creation.
def	createConnector
	OutPortPushConnector creation.

---

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

---

Member Function Documentation

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

destructor

Destructor

Reimplemented in OpenRTM_aist.OutPort.OutPort.

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)

def OpenRTM_aist.OutPortBase.OutPortBase.activateInterfaces

(

self

)

Activate all Port interfaces.

void OutPortBase.activateInterfaces()

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

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

def OpenRTM_aist.OutPortBase.OutPortBase.configure

(

self

)

Configureing outport.

void OutPortBase.configure()

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.

def OpenRTM_aist.OutPortBase.OutPortBase.connectors

(

self

)

Connector list.

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

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

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

InPort consumer creation.

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

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

OutPort provider creation.

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

def OpenRTM_aist.OutPortBase.OutPortBase.deactivateInterfaces

(

self

)

Deactivate all Port interfaces.

void OutPortBase.deactivateInterfaces()

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

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

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorIds

(

self

)

ConnectorId list.

coil.vstring OutPortBase.getConnectorIds()

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorNames

(

self

)

Connector name list.

coil.vstring OutPortBase.getConnectorNames()

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

Getting ConnectorProfile by name.

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

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

Getting ConnectorProfile by name.

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

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfiles

(

self

)

ConnectorProfile list.

ConnectorBase.ConnectorInfoList OutPortBase.getConnectorProfiles()

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

Initializing properties.

This operation initializes outport's properties

void init(coil.Properties& prop);

def OpenRTM_aist.OutPortBase.OutPortBase.initConsumers

(

self

)

InPort consumer initialization.

void OutPortBase.initConsumers()

def OpenRTM_aist.OutPortBase.OutPortBase.initProviders

(

self

)

OutPort provider initialization.

void OutPortBase.initProviders()

def OpenRTM_aist.OutPortBase.OutPortBase.properties

(

self

)

Get properties.

Getting properties of this OutPort

Returns:

OutPort's properties

coil.Properties& OutPortBase.properties()

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

Publish interface information.

ReturnCode_t OutPortBase.publishInterfaces(ConnectorProfile& cprof)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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

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

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

Subscribe interface.

ReturnCode_t OutPortBase.subscribeInterfaces(const ConnectorProfile& cprof)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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

Unsubscribe interface.

void OutPortBase.unsubscribeInterfaces(const ConnectorProfile& connector_profile)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

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;

---

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

• /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/OutPortBase.py