Package roslaunch :: Module node_args

Module node_args

Utility module of roslaunch that computes the command-line arguments for a node.

Classes
	NodeParamsException Exception to indicate that node parameters were invalid

Functions

[str]

get_node_list(config)
Returns: list of node names in config

source code

print_node_list(roslaunch_files)
Print list of nodes to screen.

source code

print_node_args(node_name, roslaunch_files)
Print arguments of node to screen.

source code

print_node_filename(node_name, roslaunch_files)

source code

[str]

get_node_args(node_name, roslaunch_files)
Get the node arguments for a node in roslaunch_files.

source code

create_local_process_args(node, machine, env=None)
Subroutine for creating node arguments.

source code

Variables
	__package__ = `'roslaunch'`

Function Details

get_node_list(config)

source code

Parameters:

config (ROSLaunchConfig) - roslaunch config

Returns: [str]

list of node names in config

print_node_list(roslaunch_files)

source code

Print list of nodes to screen. Will cause system exit if exception occurs. This is a subroutine for the roslaunch main handler.

Parameters:

roslaunch_files (str) - list of launch files to load

print_node_args(node_name, roslaunch_files)

source code

Print arguments of node to screen. Will cause system exit if exception occurs. This is a subroutine for the roslaunch main handler.

Parameters:

node_name (str) - node name
roslaunch_files (str) - list of launch files to load

get_node_args(node_name, roslaunch_files)

source code

Get the node arguments for a node in roslaunch_files.

Parameters:

node_name (str) - name of node in roslaunch_files.
roslaunch_files ([str]) - roslaunch file names

Returns: [str]

list of command-line arguments used to launch node_name

Raises:

RLException - if node args cannot be retrieved

create_local_process_args(node, machine, env=None)

source code


Subroutine for creating node arguments.

:param env: override os.environ.  Warning, this does not override
  substitution args in node configuration (for now), ``dict``
:returns: arguments for node process, ``[str]``
:raises: :exc:`NodeParamsException` If args cannot be constructed for Node
  as specified (e.g. the node type does not exist)