Public Member Functions | Private Member Functions | Private Attributes | List of all members
rtctree.ports.Connection Class Reference

Connection object. More...

Inheritance diagram for rtctree.ports.Connection:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, conn_profile_obj=None, owner=None, args, kwargs)
 
def __str__ (self)
 
def disconnect (self)
 
def has_port (self, port)
 
def id (self)
 
def name (self)
 
def owner (self)
 
def ports (self)
 
def properties (self)
 
def reparse (self)
 

Private Member Functions

def _parse (self)
 

Private Attributes

 _id
 
 _mutex
 
 _name
 
 _obj
 
 _owner
 
 _ports
 
 _properties
 

Detailed Description

Connection object.

An object representing a connection between two or more ports.

Definition at line 512 of file ports.py.

Constructor & Destructor Documentation

def rtctree.ports.Connection.__init__ (   self,
  conn_profile_obj = None,
  owner = None,
  args,
  kwargs 
)
Constructor.

@param conn_profile_obj The CORBA ConnectorProfile object to wrap.
@param owner The owner of this connection. If the creator of this
     object is not a Port object (or derivative thereof), this
     value should be set to None.

Definition at line 514 of file ports.py.

Member Function Documentation

def rtctree.ports.Connection.__str__ (   self)

Definition at line 529 of file ports.py.

def rtctree.ports.Connection._parse (   self)
private

Definition at line 646 of file ports.py.

def rtctree.ports.Connection.disconnect (   self)
Disconnect this connection.

Definition at line 533 of file ports.py.

def rtctree.ports.Connection.has_port (   self,
  port 
)
Return True if this connection involves the given Port object.

@param port The Port object to search for in this connection's ports.

Definition at line 551 of file ports.py.

def rtctree.ports.Connection.id (   self)
The ID of the connection.

Definition at line 571 of file ports.py.

def rtctree.ports.Connection.name (   self)
The name of the connection.

Definition at line 577 of file ports.py.

def rtctree.ports.Connection.owner (   self)
This connection's owner, if created by a Port object.

Definition at line 583 of file ports.py.

def rtctree.ports.Connection.ports (   self)
The list of ports involved in this connection.

The result is a list of tuples, (port name, port object). Each port
name is a full path to the port (e.g. /localhost/Comp0.rtc:in) if
this Connection object is owned by a Port, which is in turn owned by
a Component in the tree. Otherwise, only the port's name will be used
(in which case it will be the full port name, which will include the
component name, e.g. 'ConsoleIn0.in'). The full path can be used to
find ports in the tree.

If, for some reason, the owner node of a port cannot be found, that
entry in the list will contain ('Unknown', None). This typically means
that a component's name has been clobbered on the name server.

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

def rtctree.ports.Connection.properties (   self)
The connection's properties dictionary.

Definition at line 641 of file ports.py.

def rtctree.ports.Connection.reparse (   self)
Reparse the connection.

Definition at line 566 of file ports.py.

Member Data Documentation

rtctree.ports.Connection._id
private

Definition at line 650 of file ports.py.

rtctree.ports.Connection._mutex
private

Definition at line 526 of file ports.py.

rtctree.ports.Connection._name
private

Definition at line 649 of file ports.py.

rtctree.ports.Connection._obj
private

Definition at line 524 of file ports.py.

rtctree.ports.Connection._owner
private

Definition at line 525 of file ports.py.

rtctree.ports.Connection._ports
private

Definition at line 617 of file ports.py.

rtctree.ports.Connection._properties
private

Definition at line 652 of file ports.py.


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


rtctree
Author(s): Geoffrey Biggs
autogenerated on Fri Jun 7 2019 21:56:24