OpenRTM_aist.OutPortBase.OutPortBase Class Reference

More...

Inheritance diagram for OpenRTM_aist.OutPortBase.OutPortBase:

Classes
class	connector_cleanup

Public Member Functions
def	__init__ (self, name, data_type)
def	__del__ (self, PortBase=OpenRTM_aist.PortBase)
def	init (self, prop)
def	write (self)
def	connect (self, connector_profile)
def	notify_connect (self, connector_profile)
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	activateInterfaces (self)
def	deactivateInterfaces (self)
def	addConnectorDataListener (self, listener_type, listener)
def	removeConnectorDataListener (self, listener_type, listener)
def	addConnectorListener (self, callback_type, listener)
def	removeConnectorListener (self, callback_type, listener)
def	configure (self)
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	getLocalInPort (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

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__()

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)

Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.

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

__del__()

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

def OpenRTM_aist.OutPortBase.OutPortBase.activateInterfaces

(

self

)

Activate all Port interfaces

void OutPortBase::activateInterfaces()

addConnectorDataListener()

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

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

def OpenRTM_aist.OutPortBase.OutPortBase.configure

(

self

)

Configureing outport

void OutPortBase::configure()

connect()

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.

connectors()

def OpenRTM_aist.OutPortBase.OutPortBase.connectors

(

self

)

Connector list

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

createConnector()

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)

createConsumer()

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

InPort consumer creation

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

createDuplexConnector()

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

InPortDuplexConnector creation

Parameters

cprof
prop
provider_

Returns

createProvider()

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

OutPort provider creation

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

deactivateInterfaces()

def OpenRTM_aist.OutPortBase.OutPortBase.deactivateInterfaces

(

self

)

Deactivate all Port interfaces

void OutPortBase::deactivateInterfaces()

getConnectorById()

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

getConnectorByName()

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

getConnectorIds()

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorIds

(

self

)

ConnectorId list

coil::vstring OutPortBase::getConnectorIds()

getConnectorNames()

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorNames

(

self

)

Connector name list

coil::vstring OutPortBase::getConnectorNames()

getConnectorProfileById()

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

Getting ConnectorProfile by name

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

getConnectorProfileByName()

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

Getting ConnectorProfile by name

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

getConnectorProfiles()

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfiles

(

self

)

ConnectorProfile list

ConnectorBase::ConnectorInfoList OutPortBase::getConnectorProfiles()

getLocalInPort()

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

Getting local peer InPort if available

Parameters

self
profile

Returns

InPortBase* getLocalInPort(const ConnectorInfo& profile)

init()

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

def OpenRTM_aist.OutPortBase.OutPortBase.initConsumers

(

self

)

InPort consumer initialization

void OutPortBase::initConsumers()

initProviders()

def OpenRTM_aist.OutPortBase.OutPortBase.initProviders

(

self

)

OutPort provider initialization

void OutPortBase::initProviders()

notify_connect()

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

def OpenRTM_aist.OutPortBase.OutPortBase.properties

(

self

)

Get properties

Getting properties of this OutPort

Returns

OutPort's properties

coil::Properties& OutPortBase::properties()

publishInterfaces()

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

Publish interface information

ReturnCode_t OutPortBase::publishInterfaces(ConnectorProfile& cprof)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

removeConnectorDataListener()

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

removeConnectorListener()

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

subscribeInterfaces()

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

Subscribe interface

ReturnCode_t OutPortBase::subscribeInterfaces(const ConnectorProfile& cprof)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

unsubscribeInterfaces()

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

Unsubscribe interface

void OutPortBase::unsubscribeInterfaces(const ConnectorProfile& connector_profile)

Reimplemented from OpenRTM_aist.PortBase.PortBase.

write()

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;

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

---

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

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