Home       Trees       Indices       Help   
Package roslaunch :: Module parent :: Class ROSLaunchParent
[frames] | no frames]

Class ROSLaunchParent

source code

object --+
         |
        ROSLaunchParent

ROSLaunchParent represents the main 'parent' roslaunch process. It is responsible for loading the launch files, assigning machines, and then starting up any remote processes. The __main__ method delegates most of runtime to ROSLaunchParent.

This must be called from the Python Main thread due to signal registration.

Instance Methods
 
__init__(self, run_id, roslaunch_files, is_core=False, port=None, local_only=False, process_listeners=None, verbose=False, force_screen=False, is_rostest=False, roslaunch_strs=None, num_workers=3, timeout=None)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
start(self, auto_terminate=True)
Run the parent roslaunch.		 source code
 
spin_once(self)
Run the parent roslaunch event loop once		 source code
 
spin(self)
Run the parent roslaunch until exit		 source code
 
shutdown(self)
Stop the parent roslaunch.		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

__init__(self, run_id, roslaunch_files, is_core=False, port=None, local_only=False, process_listeners=None, verbose=False, force_screen=False, is_rostest=False, roslaunch_strs=None, num_workers=3, timeout=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • run_id (str) - UUID of roslaunch session
  • roslaunch_files ([str]) - list of launch configuration files to load
  • is_core (bool), bool - if True, this launch is a roscore instance. This affects the error behavior if a master is already running (i.e. it fails).
  • process_listeners ([roslaunch.pmon.ProcessListener]) - (optional) list of process listeners to register with process monitor once launch is running
  • port (int) - (optional) override master port number from what is specified in the master URI.
  • verbose (boolean) - (optional) print verbose output
  • force_screen (boolean) - (optional) force output of all nodes to screen
  • is_rostest (bool), bool - if True, this launch is a rostest instance. This affects validation checks.
  • num_workers (int) - If this is the core, the number of worker-threads to use.
  • timeout (Float or None @throws RLException) - If this is the core, the socket-timeout to use.
Overrides: object.__init__

start(self, auto_terminate=True)

source code 

Run the parent roslaunch.

Parameters:
  • auto_terminate - stop process monitor once there are no more processes to monitor (default True). This defaults to True, which is the command-line behavior of roslaunch. Scripts may wish to set this to False if they wish to keep the roslauch infrastructure up regardless of processes being monitored.

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Mon Nov 2 03:52:37 2020 http://epydoc.sourceforge.net