Public Member Functions | |
| None | __init__ (self, launch.SomeSubstitutionsType source_file, dict[str, launch.SomeSubstitutionsType] param_rewrites, Optional[launch.SomeSubstitutionsType] root_key=None, Optional[dict[str, launch.SomeSubstitutionsType]] key_rewrites=None, Optional[dict[str, launch.SomeSubstitutionsType]] value_rewrites=None, bool convert_types=False) |
| list[launch.Substitution] | name (self) |
| str | describe (self) |
| str | perform (self, launch.LaunchContext context) |
| \ tuple[dict[str, str], dict[str, str], dict[str, str]] | resolve_rewrites (self, launch.LaunchContext context) |
| None | substitute_params (self, dict[str, YamlValue] yaml, dict[str, str] param_rewrites) |
| None | add_params (self, dict[str, YamlValue] yaml, dict[str, str] param_rewrites) |
| None | substitute_values (self, dict[str, YamlValue] yaml, dict[str, str] value_rewrites) |
| dict[str, YamlValue] | updateYamlPathVals (self, dict[str, YamlValue] yaml, list[str] yaml_key_list, YamlValue rewrite_val) |
| None | substitute_keys (self, dict[str, YamlValue] yaml, dict[str, str] key_rewrites) |
| \ Generator[DictItemReference, None, None] | getYamlLeafKeys (self, dict[str, YamlValue] yamlData) |
| dict[str, YamlValue] | pathify (self, Union[dict[str, YamlValue], list[YamlValue], YamlValue] d, Optional[str] p=None, Optional[dict[str, YamlValue]] paths=None, str joinchar='.') |
| YamlValue | convert (self, str text_value) |
Detailed Description
Substitution that modifies the given YAML file. Used in launch system
Definition at line 38 of file rewritten_yaml.py.
Member Function Documentation
◆ describe()
| str nav2_common.launch.rewritten_yaml.RewrittenYaml.describe | ( | self | ) |
Return a description of this substitution as a string.
Definition at line 98 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_common.launch.rewritten_yaml.RewrittenYaml.__value_rewrites, nav2_common.launch.rewritten_yaml.RewrittenYaml.add_params(), 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(), nav2_common.launch.rewritten_yaml.RewrittenYaml.substitute_values(), and nav2_common.launch.rewritten_yaml.RewrittenYaml.updateYamlPathVals().
◆ name()
| list[launch.Substitution] nav2_common.launch.rewritten_yaml.RewrittenYaml.name | ( | self | ) |
Getter for name.
Definition at line 94 of file rewritten_yaml.py.
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().
The documentation for this class was generated from the following file:
- nav2_common/nav2_common/launch/rewritten_yaml.py
