Base port object. More...
Inheritance diagram for rtctree.ports.Port:
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().
Constructor & Destructor Documentation
| def rtctree.ports.Port.__init__ | ( | self, | |
port_obj = None, |
|||
owner = None, |
|||
| args, | |||
| kwargs | |||
| ) |
Member Function Documentation
| 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
| def rtctree.ports.Port.connections | ( | self | ) |
| def rtctree.ports.Port.disconnect_all | ( | self | ) |
| def rtctree.ports.Port.get_connection_by_dest | ( | self, | |
| dest | |||
| ) |
| def rtctree.ports.Port.get_connection_by_id | ( | self, | |
| id | |||
| ) |
| def rtctree.ports.Port.get_connection_by_name | ( | self, | |
| name | |||
| ) |
| def rtctree.ports.Port.get_connections_by_dest | ( | self, | |
| dest | |||
| ) |
| def rtctree.ports.Port.get_connections_by_dests | ( | self, | |
| dests | |||
| ) |
| def rtctree.ports.Port.is_connected | ( | self | ) |
| def rtctree.ports.Port.object | ( | self | ) |
| def rtctree.ports.Port.owner | ( | self | ) |
| def rtctree.ports.Port.porttype | ( | self | ) |
| def rtctree.ports.Port.properties | ( | self | ) |
| def rtctree.ports.Port.reparse_connections | ( | self | ) |
Member Data Documentation
The documentation for this class was generated from the following file: