Home | Trees | Indices | Help |
|
---|
|
Implementation of the rosparam as well as a library for modifying the state of the ROS Parameter Server using YAML files.
Classes | |
RosParamException rosparam base exception type |
|
RosParamIOException Exception for communication-based (i/o) errors. |
Functions | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Variables | |
NAME =
|
|
NS =
|
|
pattern = re.compile(r'^rad\(
|
|
__package__ =
|
Function Details |
Overrides pyaml's constructor for binary data. Wraps binary data in xmlrpclib.Binary container instead of straight string representation. |
Load the YAML document from the specified file :param filename: name of filename, ``str`` :param default_namespace: namespace to load filename into, ``str`` :returns [(dict, str)...]: list of parameter dictionary and corresponding namespaces for each YAML document in the file :raises: :exc:`RosParamException`: if unable to load contents of filename |
Load the YAML document as a string :param filename: name of filename, only used for debugging, ``str`` :param default_namespace: namespace to load filename into, ``str`` :param str: YAML text, ``str`` :returns: list of parameter dictionary and corresponding namespaces for each YAML document in the file, ``[(dict, str)...]`` |
Download a parameter from Parameter Server :param param: parameter name to retrieve from parameter server. If param is a parameter namespace, entire parameter subtree will be downloaded, ``str`` |
Download a parameter tree from the Parameter Server and store in a yaml file :param filename: name of file to save YAML representation, ``str`` :param param: name of parameter/namespace to dump, ``str`` :param verbose: print verbose output for debugging, ``bool`` |
Delete a parameter from the Parameter Server :param param: parameter name, ``str`` :param verbose: print verbose output for debugging, ``bool`` |
Set param on the Parameter Server. Unlike set_param(), this takes in a Python value to set instead of YAML. :param param: parameter name, ``str`` :param value XmlRpcLegalValue: value to upload, ``XmlRpcLegalValue`` |
Set param on the ROS parameter server using a YAML value. :param param: parameter name, ``str`` :param value: yaml-encoded value, ``str`` |
Get list of parameters in ns :param ns: namespace to match, ``str`` |
Command-line main routine. Loads in one or more input files :param argv: command-line arguments or None to use sys.argv, ``[str]`` |
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Fri Aug 28 12:33:32 2015 | http://epydoc.sourceforge.net |