rtctree.ports.DataPort Class Reference

Data port objects. More...

Inheritance diagram for rtctree.ports.DataPort:

Public Member Functions
def	__init__ (self, port_obj=None, owner=None, args, kwargs)
def	connect (self, dests=[], name=None, id='', props={})
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)

Public Attributes
	porttype
Public Attributes inherited from rtctree.ports.Port
	porttype

Detailed Description

Data port objects.

Specialisation of the Port class for data ports.

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

Definition at line 260 of file ports.py.

Constructor & Destructor Documentation

__init__()

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

DataPort 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 266 of file ports.py.

Member Function Documentation

connect()

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

Connect this port to other DataPorts.

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

Definition at line 277 of file ports.py.

Member Data Documentation

porttype

rtctree.ports.DataPort.porttype

Definition at line 297 of file ports.py.

---

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

• ports.py