Package roshlaunch :: Module config :: Class ROSLaunchConfig

Class ROSLaunchConfig

object --+
         |
        ROSLaunchConfig

ROSLaunchConfig is the container for the loaded roslaunch file state. It also is responsible for validating then executing the desired state.

Instance Methods

__init__(self)
Initialize an empty config object.

source code

add_config_error(self, msg)
Report human-readable error message related to configuration error

source code

set_master(self, m)
Set the master configuration

source code

bool

has_remote_nodes(self)
Returns: True if roslaunch will launch nodes on a remote machine

source code

assign_machines(self)
Assign nodes to machines and determine whether or not there are any remote machines

source code

validate(self)
Perform basic checks on the local ROS environment, master, and core services.

source code

str

summary(self, local=False)
Get a human-readable string summary of the launch

source code

add_executable(self, exe)
Declare an exectuable to be run during the launch

source code

add_clear_param(self, param)
Declare a parameter to be cleared before new parameters are set

source code

add_param(self, p, filename=None, verbose=True)
Declare a parameter to be set on the param server before launching nodes

source code

bool

add_machine(self, m, verbose=True)
Declare a machine and associated parameters so that it can be used for running nodes.

source code

add_test(self, test, verbose=True)
Add test declaration.

source code

add_node(self, node, core=False, verbose=True)
Add node declaration

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)
(Constructor)

source code

Initialize an empty config object. Master defaults to the environment's master.

Overrides: object.__init__

add_config_error(self, msg)

source code

Report human-readable error message related to configuration error

Parameters:

msg (str) - error message

set_master(self, m)

source code

Set the master configuration

Parameters:

m (Master) - Master

has_remote_nodes(self)

source code

Returns: bool: True if roslaunch will launch nodes on a remote machine

validate(self)

source code

Perform basic checks on the local ROS environment, master, and core services. master will be launched if configured to do so. Core services will be launched regardless. if they are not already running.

Raises:

RLException - if validation fails

summary(self, local=False)

source code

Get a human-readable string summary of the launch

Parameters:

local, bool - if True, only print local nodes

Returns: str

summary

add_executable(self, exe)

source code

Declare an exectuable to be run during the launch

Parameters:

exe (Executable) - Executable

add_clear_param(self, param)

source code

Declare a parameter to be cleared before new parameters are set

Parameters:

param (str) - parameter to clear

add_param(self, p, filename=None, verbose=True)

source code

Declare a parameter to be set on the param server before launching nodes

Parameters:

p (Param) - parameter instance

add_machine(self, m, verbose=True)

source code

Declare a machine and associated parameters so that it can be used for running nodes.

Parameters:

m (Machine) - machine instance

Returns: bool

True if new machine added, False if machine already specified.

Raises:

RLException - if cannot add machine as specified

add_test(self, test, verbose=True)

source code

Add test declaration. Used by rostest

Parameters:

test (Test) - test node instance to add to launch

add_node(self, node, core=False, verbose=True)

source code

Add node declaration

Parameters:

node (Node) - node instance to add to launch
core (bool) - if True, node is a ROS core node

Raises:

RLException - if ROS core node is missing required name

Class ROSLaunchConfig

__init__(self) (Constructor)

add_config_error(self, msg)

set_master(self, m)

has_remote_nodes(self)

validate(self)

summary(self, local=False)

add_executable(self, exe)

add_clear_param(self, param)

add_param(self, p, filename=None, verbose=True)

add_machine(self, m, verbose=True)

add_test(self, test, verbose=True)

add_node(self, node, core=False, verbose=True)

init(self)
(Constructor)