rtctree.ports.CorbaPort Class Reference

CORBA port objects. More...

Inheritance diagram for rtctree.ports.CorbaPort:

Public Member Functions
def	__init__ (self, port_obj=None, owner=None, args, kwargs)
def	connect (self, dests=None, name=None, id='', props={})
def	get_interface_by_instance_name (self, name)
def	interfaces (self)
Public Member Functions inherited from rtctree.ports.Port
def	__init__ (self, port_obj=None, owner=None, args, kwargs)
def	connect (self, dests=[], name=None, id='', props={})
def	connections (self)
def	disconnect_all (self)
def	get_connection_by_dest (self, dest)
def	get_connection_by_id (self, id)
def	get_connection_by_name (self, name)
def	get_connections_by_dest (self, dest)
def	get_connections_by_dests (self, dests)
def	is_connected (self)
def	name (self)
def	object (self)
def	owner (self)
def	porttype (self)
def	properties (self)
def	reparse (self)
def	reparse_connections (self)

Private Attributes
	_interfaces

Additional Inherited Members
Public Attributes inherited from rtctree.ports.Port
	porttype

Detailed Description

CORBA port objects.

Specialisation of the Port class for service ports.

Do not create CorbaPort objects directly. Call parse_port().

Definition at line 337 of file ports.py.

Constructor & Destructor Documentation

def rtctree.ports.CorbaPort.__init__	(		self,
			port_obj = None,
			owner = None,
			args,
			kwargs
	)

CorbaPort constructor.

@param port_obj The CORBA PortService object to wrap.
@param owner The owner of this port. Should be a Component object or
     None.

Definition at line 343 of file ports.py.

Member Function Documentation

def rtctree.ports.CorbaPort.connect	(		self,
			dests = None,
			name = None,
			id = '',
			props = {}
	)

Connect this port to other CorbaPorts.

After the connection has been made, a delayed reparse of the
connections for this and the destination port will be triggered.

@param dests A list of the destination Port objects. Must be provided.
@param name The name of the connection. If None, a suitable default
    will be created based on the names of the two ports.
@param id The ID of this connection. If None, one will be generated by
       the RTC implementation.
@param props Properties of the connection. Suitable defaults will be
     set for required values if they are not already present.
@raises WrongPortTypeError, MismatchedInterfacesError,
MismatchedPolarityError

Definition at line 355 of file ports.py.

def rtctree.ports.CorbaPort.get_interface_by_instance_name	(		self,
			name
	)

Get an interface of this port by instance name.

Definition at line 403 of file ports.py.

def rtctree.ports.CorbaPort.interfaces

(

self

)

The list of interfaces this port provides or uses.

This list will be created at the first reference to this property.
This means that the first reference may be delayed by CORBA calls,
but others will return quickly (unless a delayed reparse has been
triggered).

Definition at line 412 of file ports.py.

Member Data Documentation

rtctree.ports.CorbaPort._interfaces

private

Definition at line 353 of file ports.py.

---

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

• ports.py