|
def | __init__ (self, parent=None, group="") |
|
def | add (self, name, paramtype, description, level=0, edit_method='""', default=None, min=None, max=None, configurable=False, global_scope=False, constant=False) |
|
def | add_enum (self, name, description, entry_strings, default=None) |
|
def | add_group (self, name) |
|
def | generate (self, pkgname, nodename, classname) |
|
Automatic config file and header generator
Definition at line 44 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator.__init__ |
( |
|
self, |
|
|
|
parent = None , |
|
|
|
group = "" |
|
) |
| |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._generate_param_entries |
( |
|
self | ) |
|
|
private |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._generatecfg |
( |
|
self | ) |
|
|
private |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._generatehpp |
( |
|
self | ) |
|
|
private |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._generateImpl |
( |
|
self | ) |
|
|
private |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._generatepy |
( |
|
self | ) |
|
|
private |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._generateyml |
( |
|
self | ) |
|
|
private |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._get_cvalue |
( |
|
param, |
|
|
|
field |
|
) |
| |
|
staticprivate |
Helper function to convert strings and booleans to correct C++ syntax
:param param:
:return: C++ compatible representation
Definition at line 248 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._get_cvaluedict |
( |
|
param, |
|
|
|
field |
|
) |
| |
|
staticprivate |
Helper function to convert python dict of strings and booleans to correct C++ syntax
:param param:
:return: C++ compatible representation
Definition at line 297 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._get_cvaluelist |
( |
|
param, |
|
|
|
field |
|
) |
| |
|
staticprivate |
Helper function to convert python list of strings and booleans to correct C++ syntax
:param param:
:return: C++ compatible representation
Definition at line 276 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._get_parameters |
( |
|
self | ) |
|
|
private |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._get_pyvalue |
( |
|
param, |
|
|
|
field |
|
) |
| |
|
staticprivate |
Helper function to convert strings and booleans to correct C++ syntax
:param param:
:return: C++ compatible representation
Definition at line 262 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._make_bool |
( |
|
param | ) |
|
|
staticprivate |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._perform_checks |
( |
|
self, |
|
|
|
param |
|
) |
| |
|
private |
Will test some logical constraints as well as correct types.
Throws Exception in case of error.
:param self:
:param param: Dictionary of one param
:return:
Definition at line 152 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._pytype |
( |
|
drtype | ) |
|
|
staticprivate |
def rosparam_handler.parameter_generator_catkin.ParameterGenerator._test_primitive_type |
( |
|
name, |
|
|
|
drtype |
|
) |
| |
|
staticprivate |
Test whether parameter has one of the accepted C++ types
:param name: Parametername
:param drtype: Typestring
:return:
Definition at line 236 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator.add |
( |
|
self, |
|
|
|
name, |
|
|
|
paramtype, |
|
|
|
description, |
|
|
|
level = 0 , |
|
|
|
edit_method = '""' , |
|
|
|
default = None , |
|
|
|
min = None , |
|
|
|
max = None , |
|
|
|
configurable = False , |
|
|
|
global_scope = False , |
|
|
|
constant = False |
|
) |
| |
Add parameters to your parameter struct. Call this method from your .params file!
- If no default value is given, you need to specify one in your launch file
- Global parameters, vectors, maps and constant params can not be configurable
:param self:
:param name: The Name of you new parameter
:param paramtype: The C++ type of this parameter. Can be any of ['std::string', 'int', 'bool', 'float',
'double'] or std::vector<...> or std::map<std::string, ...>
:param description: Choose an informative documentation string for this parameter.
:param level: (optional) Passed to dynamic_reconfigure
:param edit_method: (optional) Passed to dynamic_reconfigure
:param default: (optional) default value
:param min: (optional)
:param max: (optional)
:param configurable: (optional) Should this parameter be dynamic configurable
:param global_scope: (optional) If true, parameter is searched in global ('/') namespace instead of private (
'~') ns
:param constant: (optional) If this is true, the parameter will not be fetched from param server,
but the default value is kept.
:return: None
Definition at line 107 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator.add_enum |
( |
|
self, |
|
|
|
name, |
|
|
|
description, |
|
|
|
entry_strings, |
|
|
|
default = None |
|
) |
| |
Add an enum to dynamic reconfigure
:param name: Name of enum parameter
:param description: Informative documentation string
:param entry_strings: Enum entries, must be strings! (will be numbered with increasing value)
:param default: Default value
:return:
Definition at line 84 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator.add_group |
( |
|
self, |
|
|
|
name |
|
) |
| |
Add a new group in the dynamic reconfigure selection
:param name: name of the new group
:return: a new group object that you can add parameters to
Definition at line 72 of file parameter_generator_catkin.py.
def rosparam_handler.parameter_generator_catkin.ParameterGenerator.generate |
( |
|
self, |
|
|
|
pkgname, |
|
|
|
nodename, |
|
|
|
classname |
|
) |
| |
Main working Function, call this at the end of your .params file!
:param self:
:param pkgname: Name of the catkin package
:param nodename: Name of the Node that will hold these params
:param classname: This should match your file name, so that cmake will detect changes in config file.
:return: Exit Code
Definition at line 317 of file parameter_generator_catkin.py.
rosparam_handler.parameter_generator_catkin.ParameterGenerator.childs |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.classname |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.cpp_gen_dir |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.dynconfpath |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.enums |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.group |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.group_variable |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.nodename |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.parameters |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.parent |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.pkgname |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.py_gen_dir |
rosparam_handler.parameter_generator_catkin.ParameterGenerator.share_dir |
The documentation for this class was generated from the following file: