Functions
rtshell::comp_mgmt Namespace Reference

Functions

def activate
def choose_name
def connect
def deactivate
def delete_comp
def disconnect
def find_comp_in_mgr
def find_port
def get_comp
def make_comp
def shutdown

Function Documentation

Definition at line 178 of file comp_mgmt.py.

def rtshell.comp_mgmt.choose_name (   base,
  tree 
)
Choose a name for the component from a given base.

The name is chosen such that it does not conflict with other possible
instances of the base name by appending an index number.

@param base The base name to append the index to.
@param tree A populated RTCTree to search for other instances of the
            same type of component.

Definition at line 92 of file comp_mgmt.py.

def rtshell.comp_mgmt.connect (   comp,
  port_specs,
  tree 
)

Definition at line 139 of file comp_mgmt.py.

Definition at line 187 of file comp_mgmt.py.

def rtshell.comp_mgmt.delete_comp (   mgr,
  comp 
)
Delete the component from the manager.

Definition at line 128 of file comp_mgmt.py.

Disconnect all connections to @ref comp.

@param comp An RTObject.

Definition at line 167 of file comp_mgmt.py.

def rtshell.comp_mgmt.find_comp_in_mgr (   name,
  mgr 
)
Find a component in a manager.

@param name The type name of the component to search for.
@param mgr The manager to which the component is registered.

Definition at line 33 of file comp_mgmt.py.

def rtshell.comp_mgmt.find_port (   rtc,
  port,
  tree = None,
  orb = None 
)
Get a rtctree.Port object from an rtctree.RTCTree.

Get the port object by searching the RTCTree for the specified RTC, then
looking for the specified port on that component.

@param rtc Path to the component that should have a port. This should be in
           the format used by rtctree, i.e. a list of path entries, with
           the first being a /. e.g. ['/', 'localhost', 'comp0.rtc'].
@param port Name of the port.
@param tree An already-populated rtctree.RTCTree object, or None if one
            should be created.
@param orb An ORB to use if the tree must be created, or None to make one.

Definition at line 70 of file comp_mgmt.py.

def rtshell.comp_mgmt.get_comp (   rtc,
  tree = None,
  orb = None 
)
Get a rtctree.Component object from an rtctree.RTCTree.

Get the component object by searching the RTCTree for the specified RTC.

@param rtc Path to the component. This should be in
           the format used by rtctree, i.e. a list of path entries, with
           the first being a /. e.g. ['/', 'localhost', 'comp0.rtc'].
@param tree An already-populated rtctree.RTCTree object, or None if one
            should be created.
@param orb An ORB to use if the tree must be created, or None to make one.

Definition at line 46 of file comp_mgmt.py.

def rtshell.comp_mgmt.make_comp (   name_base,
  tree,
  cons,
  port_specs,
  event = None,
  rate = 1.0,
  max = -1,
  kwargs 
)

Definition at line 117 of file comp_mgmt.py.

Shut down the manager.

Definition at line 133 of file comp_mgmt.py.



rtshell
Author(s): Geoffrey Biggs
autogenerated on Fri Aug 28 2015 12:55:12