niryo_libraries.roslaunch.loader.Loader

class documentation

class Loader(object):

Known subclasses: niryo_libraries.roslaunch.xmlloader.XmlLoader

View In Hierarchy

Lower-level library for loading ROS launch model. It provides an abstraction between the representation (e.g. XML) and the validation of the property values.

Method add_param Add L{Param} instances to launch config. Dictionary values are unrolled into individual parameters.
Method load_env Load environment variable setting
Method load_rosparam Load rosparam setting
Method param_value Parse text representation of param spec into Python value @param name: param name, for error message use only @type name: str @param verbose: print verbose output @type verbose: bool @param textfile: name of text file to load from, or None @type textfile: str @param binfile: name of binary file to load from, or None @type binfile: str @param command: command to execute for parameter value, or None @type command: str @raise ValueError: if parameters are invalid...
def add_param(self, ros_config, param_name, param_value, verbose=True):

Add L{Param} instances to launch config. Dictionary values are unrolled into individual parameters.

@param ros_config: launch configuration @type ros_config: L{ROSLaunchConfig} @param param_name: name of parameter namespace to load values

into. If param_name is '/', param_value must be a dictionary

@type param_name: str @param param_value: value to assign to param_name. If

param_value is a dictionary, it's values will be unrolled into individual parameters.

@type param_value: str @raise ValueError: if parameters cannot be processed into valid Params

def load_env(self, context, ros_config, name, value):

Load environment variable setting

@param context: Loader context @type context: L{LoaderContext} @param ros_config: launch configuration @type ros_config: L{ROSLaunchConfig} @param name: environment variable name @type name: str @param value: environment variable value @type value: str

def load_rosparam(self, context, ros_config, cmd, param, file_, text, verbose=True, subst_function=None):

Load rosparam setting

@param context: Loader context @type context: L{LoaderContext} @param ros_config: launch configuration @type ros_config: L{ROSLaunchConfig} @param cmd: 'load', 'dump', or 'delete' @type cmd: str @param file_: filename for rosparam to use or None @type file_: str @param text: text for rosparam to load. Ignored if file_ is set. @type text: str @raise ValueError: if parameters cannot be processed into valid rosparam setting

def param_value(self, verbose, name, ptype, value, textfile, binfile, command):

Parse text representation of param spec into Python value @param name: param name, for error message use only @type name: str @param verbose: print verbose output @type verbose: bool @param textfile: name of text file to load from, or None @type textfile: str @param binfile: name of binary file to load from, or None @type binfile: str @param command: command to execute for parameter value, or None @type command: str @raise ValueError: if parameters are invalid