nav2_common.launch.replace_string.ReplaceString Class Reference

Inheritance diagram for nav2_common.launch.replace_string.ReplaceString:

Collaboration diagram for nav2_common.launch.replace_string.ReplaceString:

Public Member Functions
None	__init__ (self, launch.SomeSubstitutionsType source_file, Dict replacements, Optional[launch.Condition] condition=None)
List[launch.Substitution]	name (self)
Optional[launch.Condition]	condition (self)
Text	describe (self)
Text	perform (self, launch.LaunchContext context)
def	resolve_replacements (self, context)
def	replace (self, input_file, output_file, replacements)

Detailed Description

Substitution that replaces strings on a given file.

Used in launch system

Definition at line 22 of file replace_string.py.

Member Function Documentation

condition()

Optional[launch.Condition] nav2_common.launch.replace_string.ReplaceString.condition

(

self

)

Getter for condition.

Definition at line 48 of file replace_string.py.

References nav2_common.launch.replace_string.ReplaceString.__condition.

describe()

Text nav2_common.launch.replace_string.ReplaceString.describe

(

self

)

Return a description of this substitution as a string.

Definition at line 52 of file replace_string.py.

References nav2_common.launch.replace_string.ReplaceString.__condition, nav2_common.launch.replace_string.ReplaceString.__replacements, 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.replace_string.ReplaceString.replace(), and nav2_common.launch.replace_string.ReplaceString.resolve_replacements().

Here is the call graph for this function:

name()

List[launch.Substitution] nav2_common.launch.replace_string.ReplaceString.name

(

self

)

Getter for name.

Definition at line 43 of file replace_string.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/replace_string.py