niryo_libraries.rosunit.baretest.LocalProcess

class documentation

class LocalProcess(pmon.Process):

Constructor: LocalProcess(run_id, package, name, args, ...)

Process launched on local machine

Method	`__init__`	generate log directory location. run_id may be None if this feature is not being used.
Method	`get_exit_description`	@return: human-readable description of exit state @rtype: str
Method	`get_info`	Get all data about this process in dictionary form
Method	`is_alive`	@return: True if process is still running @rtype: bool
Method	`start`	Start the process.
Method	`stop`	Stop the process. Record any significant error messages in the errors parameter
Instance Variable	`args`	Undocumented
Instance Variable	`cwd`	Undocumented
Instance Variable	`exit_code`	Undocumented
Instance Variable	`is_node`	Undocumented
Instance Variable	`log_dir`	Undocumented
Instance Variable	`log_output`	Undocumented
Instance Variable	`pid`	Undocumented
Instance Variable	`popen`	Undocumented
Instance Variable	`run_id`	Undocumented
Instance Variable	`started`	Undocumented
Instance Variable	`stopped`	Undocumented
Method	`_configure_logging`	Configure logging of node's log file and stdout/stderr @return: stdout log file name, stderr log file name. Values are None if stdout/stderr are not logged. @rtype: str, str
Method	`_stop_unix`	UNIX implementation of process killing

Inherited from Process:

Method	`__str__`	Undocumented
Instance Variable	`env`	Undocumented
Instance Variable	`lock`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`package`	Undocumented
Instance Variable	`required`	Undocumented
Instance Variable	`respawn`	Undocumented
Instance Variable	`spawn_count`	Undocumented

def __init__(self, run_id, package, name, args, env, log_output, respawn=False, required=False, cwd=None, is_node=True): ¶

overrides niryo_libraries.rosunit.pmon.Process.__init__

@param run_id: unique run ID for this roslaunch. Used to: generate log directory location. run_id may be None if this feature is not being used.

@type run_id: str @param package: name of package process is part of @type package: str @param name: name of process @type name: str @param args: list of arguments to process @type args: [str] @param env: environment dictionary for process @type env: {str : str} @param log_output: if True, log output streams of process @type log_output: bool @param respawn: respawn process if it dies (default is False) @type respawn: bool @param cwd: working directory of process, or None @type cwd: str @param is_node: (optional) if True, process is ROS node and accepts ROS node command-line arguments. Default: True @type is_node: False

def get_exit_description(self): ¶

overrides niryo_libraries.rosunit.pmon.Process.get_exit_description

@return: human-readable description of exit state @rtype: str

def get_info(self): ¶

overrides niryo_libraries.rosunit.pmon.Process.get_info

Get all data about this process in dictionary form

def is_alive(self): ¶

overrides niryo_libraries.rosunit.pmon.Process.is_alive

@return: True if process is still running @rtype: bool

def start(self): ¶

overrides niryo_libraries.rosunit.pmon.Process.start

Start the process.

@raise pmon.FatalProcessLaunch: if process cannot be started and it is not likely to ever succeed

def stop(self, errors=[]): ¶

overrides niryo_libraries.rosunit.pmon.Process.stop

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

@param errors: error messages. stop() will record messages into this list. @type errors: [str]

args = ¶

overrides niryo_libraries.rosunit.pmon.Process.args

Undocumented

cwd = ¶

Undocumented

exit_code = ¶

overrides niryo_libraries.rosunit.pmon.Process.exit_code

Undocumented

is_node = ¶

Undocumented

log_dir = ¶

Undocumented

log_output = ¶

Undocumented

pid = ¶

Undocumented

popen = ¶

Undocumented

run_id = ¶

Undocumented

started: bool = ¶

Undocumented

stopped: bool = ¶

Undocumented

def _configure_logging(self): ¶

Configure logging of node's log file and stdout/stderr @return: stdout log file name, stderr log file name. Values are None if stdout/stderr are not logged. @rtype: str, str

def _stop_unix(self, errors): ¶

UNIX implementation of process killing

@param errors: error messages. stop() will record messages into this list. @type errors: [str]