Package roslaunch :: Module nodeprocess :: Class LocalProcess

[frames] | no frames]

Class LocalProcess

  object --+    
           |    
pmon.Process --+
               |
              LocalProcess

Process launched on local machine

Instance Methods

__init__(self, run_id, package, name, args, env, log_output, respawn=False, respawn_delay=0.0, required=False, cwd=None, is_node=True)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

dict { str: val }

get_info(self)
Get all data about this process in dictionary form

source code

start(self)
Start the process.

source code

bool

is_alive(self)
Returns: True if process is still running

source code

str

get_exit_description(self)
Returns: human-readable description of exit state

source code

stop(self, errors=None)
Stop the process.

source code

__str__(self)
str(x) (Inherited from roslaunch.pmon.Process)

source code

should_respawn(self)
Returns: False if process should not respawn floating point seconds until respawn otherwise (Inherited from roslaunch.pmon.Process)

source code

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

Properties
Inherited from `object`: `__class__`

Method Details

init(self, run_id, package, name, args, env, log_output, respawn=False, respawn_delay=0.0, required=False, cwd=None, is_node=True)
(Constructor)

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

Parameters:

run_id (str) - unique run ID for this roslaunch. Used to generate log directory location. run_id may be None if this feature is not being used.
package (str) - name of package process is part of
name (str) - name of process
args ([str]) - list of arguments to process
env ({str : str}) - environment dictionary for process
log_output (bool) - if True, log output streams of process
respawn (bool) - respawn process if it dies (default is False)
respawn_delay (float) - respawn process after a delay
cwd (str) - working directory of process, or None
is_node (False) - (optional) if True, process is ROS node and accepts ROS node command-line arguments. Default: True

Overrides: object.__init__

get_info(self)

Get all data about this process in dictionary form

Returns: dict { str: val }: dictionary of all relevant process properties
Overrides: pmon.Process.get_info

start(self)

Start the process.

Raises:

FatalProcessLaunch - if process cannot be started and it is not likely to ever succeed

Overrides: pmon.Process.start

is_alive(self)

Returns: bool: True if process is still running
Overrides: pmon.Process.is_alive

get_exit_description(self)

Returns: str: human-readable description of exit state
Overrides: pmon.Process.get_exit_description

stop(self, errors=None)

Stop the process. Record any significant error messages in the errors parameter

Parameters:

errors ([str]) - error messages. stop() will record messages into this list.

Overrides: pmon.Process.stop