Package roslaunch :: Module core

Module core

Core roslaunch model and lower-level utility routines.

Classes
	unicode str(object) -> string
	basestring str(object) -> string
	RLException Base roslaunch exception type
	Master Data structure for representing and querying state of master
	Machine Data structure for storing information about a machine in the ROS system.
	Param Data structure for storing information about a desired parameter in the ROS system Corresponds to the 'param' tag in the launch specification.
	Node Data structure for storing information about a desired node in the ROS system Corresponds to the 'node' tag in the launch specification.
	Test A Test is a Node with special semantics that it performs a unit/integration test.
	Executable Executable is a generic container for exectuable commands.
	RosbinExecutable RosbinExecutables are exectuables stored in ROS_ROOT/bin.

Functions

is_child_mode()
:returns: ``True`` if roslaunch is running in remote child mode, ``bool``

source code

set_child_mode(child_mode)
:param child_mode: True if roslaunch is running in remote...

source code

is_machine_local(machine)
Check to see if machine is local.

source code

printlog(msg)
Core utility for printing message to stdout as well as printlog handlers :param msg: message to print, ``str``

source code

printlog_bold(msg)
Similar to printlog(), but the message printed to screen is bolded for greater clarity :param msg: message to print, ``str``

source code

printerrlog(msg)
Core utility for printing message to stderr as well as printerrlog handlers :param msg: message to print, ``str``

source code

add_printlog_handler(h)
Register additional handler for printlog()

source code

add_printerrlog_handler(h)
Register additional handler for printerrlog()

source code

clear_printlog_handlers()
Delete all printlog handlers.

source code

clear_printerrlog_handlers()
Delete all printerrlog handlers.

source code

setup_env(node, machine, master_uri, env=None)
Create dictionary of environment variables to set for launched process.

source code

rle_wrapper(fn)
Wrap lower-level exceptions in RLException class...

source code

get_master_uri_env(*args)

source code

remap_localhost_uri(uri, force_localhost=False)
Resolve localhost addresses to an IP address so that :param uri: XML-RPC URI, ``str`` :param force_localhost: if True, URI is mapped onto the local machine no matter what, ``bool``

source code

local_machine()
:returns:: Machine instance representing the local machine, ``Machine``

source code

generate_run_id()
Utility routine for generating run IDs (UUIDs) :returns: guid, ``str``

source code

Variables
	PHASE_SETUP = `'setup'`
	PHASE_RUN = `'run'`
	PHASE_TEARDOWN = `'teardown'`
	TEST_TIME_LIMIT_DEFAULT = `60`
	__package__ = `'roslaunch'`

Function Details

set_child_mode(child_mode)

source code


:param child_mode: True if roslaunch is running in remote
  child mode, ``bool``

is_machine_local(machine)

source code

Check to see if machine is local. NOTE: a machine is not local if its user credentials do not match the current user. :param machine: Machine, ``Machine`` :returns: True if machine is local and doesn't require remote login, ``bool``

clear_printlog_handlers()

source code

Delete all printlog handlers. required for testing

clear_printerrlog_handlers()

source code

Delete all printerrlog handlers. required for testing

setup_env(node, machine, master_uri, env=None)

source code

Create dictionary of environment variables to set for launched process.

setup_env() will only set ROS_*, PYTHONPATH, and user-specified environment variables.

:param machine: machine being launched on, ``Machine`` :param node: node that is being launched or None, ``Node`` :param master_uri: ROS master URI, ``str`` :param env: base environment configuration, defaults to ``os.environ`` :returns: process env dictionary, ``dict``

rle_wrapper(fn)

source code


Wrap lower-level exceptions in RLException class
:returns:: function wrapper that throws an RLException if the
    wrapped function throws an Exception, ``fn``