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

Base port object. More...

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

Public Member Functions

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
 

Private Member Functions

def _parse (self)
 

Private Attributes

 _connections
 
 _mutex
 
 _name
 
 _obj
 
 _owner
 
 _properties
 

Detailed Description

Base port object.

Base class representing a port of a component.

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

Definition at line 62 of file ports.py.

Constructor & Destructor Documentation

def rtctree.ports.Port.__init__ (   self,
  port_obj = None,
  owner = None,
  args,
  kwargs 
)
Base port 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 68 of file ports.py.

Member Function Documentation

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

Definition at line 245 of file ports.py.

def rtctree.ports.Port.connect (   self,
  dests = [],
  name = None,
  id = '',
  props = {} 
)
Connect this port to other ports.

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. Required values depend on
     the type of the two ports being connected.
@raises IncompatibleDataPortConnectionPropsError, FailedToConnectError

Definition at line 83 of file ports.py.

def rtctree.ports.Port.connections (   self)
A list of connections to or from this port.

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

def rtctree.ports.Port.disconnect_all (   self)
Disconnect all connections to this port.

Definition at line 125 of file ports.py.

def rtctree.ports.Port.get_connection_by_dest (   self,
  dest 
)
DEPRECATED. Search for a connection between this and another port.

Definition at line 132 of file ports.py.

def rtctree.ports.Port.get_connection_by_id (   self,
  id 
)
Search for a connection on this port by its ID.

Definition at line 162 of file ports.py.

def rtctree.ports.Port.get_connection_by_name (   self,
  name 
)
Search for a connection to or from this port by name.

Definition at line 170 of file ports.py.

def rtctree.ports.Port.get_connections_by_dest (   self,
  dest 
)
Search for all connections between this and another port.

Definition at line 140 of file ports.py.

def rtctree.ports.Port.get_connections_by_dests (   self,
  dests 
)
Search for all connections involving this and all other ports.

Definition at line 149 of file ports.py.

def rtctree.ports.Port.is_connected (   self)
Check if this port is connected to any other ports.

Definition at line 205 of file ports.py.

def rtctree.ports.Port.name (   self)
The name of this port.

Definition at line 213 of file ports.py.

def rtctree.ports.Port.object (   self)
The PortService object that represents the port.

Definition at line 219 of file ports.py.

def rtctree.ports.Port.owner (   self)
This port's owner (usually a Component object).

Definition at line 225 of file ports.py.

def rtctree.ports.Port.porttype (   self)
The type of port this is.

Valid values are any class that @ref parse_port can create.

Definition at line 231 of file ports.py.

def rtctree.ports.Port.properties (   self)
Properties of the port.

Definition at line 240 of file ports.py.

def rtctree.ports.Port.reparse (   self)
Reparse the port.

Definition at line 178 of file ports.py.

def rtctree.ports.Port.reparse_connections (   self)
Reparse the connections this port is involved in.

Definition at line 183 of file ports.py.

Member Data Documentation

rtctree.ports.Port._connections
private

Definition at line 78 of file ports.py.

rtctree.ports.Port._mutex
private

Definition at line 80 of file ports.py.

rtctree.ports.Port._name
private

Definition at line 249 of file ports.py.

rtctree.ports.Port._obj
private

Definition at line 77 of file ports.py.

rtctree.ports.Port._owner
private

Definition at line 79 of file ports.py.

rtctree.ports.Port._properties
private

Definition at line 250 of file ports.py.

rtctree.ports.Port.porttype

Definition at line 100 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