nav2_common.launch.rewritten_yaml.RewrittenYaml Class Reference

Inheritance diagram for nav2_common.launch.rewritten_yaml.RewrittenYaml:

Collaboration diagram for nav2_common.launch.rewritten_yaml.RewrittenYaml:

Public Member Functions
None	__init__ (self, launch.SomeSubstitutionsType source_file, Dict param_rewrites, Optional[launch.SomeSubstitutionsType] root_key=None, Optional[Dict] key_rewrites=None, convert_types=False)
List[launch.Substitution]	name (self)
Text	describe (self)
Text	perform (self, launch.LaunchContext context)
def	resolve_rewrites (self, context)
def	substitute_params (self, yaml, param_rewrites)
def	updateYamlPathVals (self, yaml, yaml_key_list, rewrite_val)
def	substitute_keys (self, yaml, key_rewrites)
def	getYamlLeafKeys (self, yamlData)
def	pathify (self, d, p=None, paths=None, joinchar='.')
def	convert (self, text_value)

Detailed Description

Substitution that modifies the given YAML file.

Used in launch system

Definition at line 37 of file rewritten_yaml.py.

Member Function Documentation

describe()

Text nav2_common.launch.rewritten_yaml.RewrittenYaml.describe

(

self

)

Return a description of this substitution as a string.

Definition at line 80 of file rewritten_yaml.py.

References nav2_common.launch.rewritten_yaml.RewrittenYaml.__convert_types, nav2_common.launch.rewritten_yaml.RewrittenYaml.__key_rewrites, nav2_common.launch.rewritten_yaml.RewrittenYaml.__param_rewrites, nav2_common.launch.rewritten_yaml.RewrittenYaml.__root_key, nav2_costmap_2d::Image< T >.convert(), nav2_common.launch.rewritten_yaml.RewrittenYaml.convert(), nav2_common.launch.rewritten_yaml.RewrittenYaml.getYamlLeafKeys(), nav2_common.launch.has_node_params.HasNodeParams.name(), nav2_common.launch.replace_string.ReplaceString.name(), nav2_common.launch.rewritten_yaml.RewrittenYaml.name(), nav2_common.launch.rewritten_yaml.RewrittenYaml.pathify(), nav2_common.launch.rewritten_yaml.RewrittenYaml.resolve_rewrites(), nav2_common.launch.rewritten_yaml.RewrittenYaml.substitute_keys(), nav2_common.launch.rewritten_yaml.RewrittenYaml.substitute_params(), and nav2_common.launch.rewritten_yaml.RewrittenYaml.updateYamlPathVals().

Here is the call graph for this function:

name()

List[launch.Substitution] nav2_common.launch.rewritten_yaml.RewrittenYaml.name

(

self

)

Getter for name.

Definition at line 76 of file rewritten_yaml.py.

References nav2_common.launch.has_node_params.HasNodeParams.__source_file, nav2_common.launch.replace_string.ReplaceString.__source_file, and nav2_common.launch.rewritten_yaml.RewrittenYaml.__source_file.

Referenced by nav2_common.launch.has_node_params.HasNodeParams.describe(), nav2_common.launch.replace_string.ReplaceString.describe(), and nav2_common.launch.rewritten_yaml.RewrittenYaml.describe().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• nav2_common/nav2_common/launch/rewritten_yaml.py