moveit2
The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | List of all members
moveit_configs_utils.substitutions.xacro.Xacro Class Reference
Inheritance diagram for moveit_configs_utils.substitutions.xacro.Xacro:
Inheritance graph
[legend]
Collaboration diagram for moveit_configs_utils.substitutions.xacro.Xacro:
Collaboration graph
[legend]

Public Member Functions

None __init__ (self, SomeSubstitutionsType file_path, *Optional[dict[SomeSubstitutionsType, SomeSubstitutionsType]] mappings=None)
 
def parse (cls, Iterable[SomeSubstitutionsType] data)
 
list[Substitution] file_path (self)
 
dict[SomeSubstitutionsType, SomeSubstitutionsType] mappings (self)
 
Text describe (self)
 
Text perform (self, LaunchContext context)
 

Detailed Description

Substitution that can access load xacro file with mappings involving any subsititutable.

Definition at line 13 of file xacro.py.

Constructor & Destructor Documentation

◆ __init__()

None moveit_configs_utils.substitutions.xacro.Xacro.__init__ (   self,
SomeSubstitutionsType  file_path,
*Optional[dict[SomeSubstitutionsType, SomeSubstitutionsType]]   mappings = None 
)
Create a Xacro substitution.

Definition at line 16 of file xacro.py.

Member Function Documentation

◆ describe()

Text moveit_configs_utils.substitutions.xacro.Xacro.describe (   self)
Return a description of this substitution as a string.

Definition at line 52 of file xacro.py.

Here is the call graph for this function:

◆ file_path()

list[Substitution] moveit_configs_utils.substitutions.xacro.Xacro.file_path (   self)
Getter for file_path.

Definition at line 43 of file xacro.py.

◆ mappings()

dict[SomeSubstitutionsType, SomeSubstitutionsType] moveit_configs_utils.substitutions.xacro.Xacro.mappings (   self)
Getter for mappings.

Definition at line 48 of file xacro.py.

Here is the caller graph for this function:

◆ parse()

def moveit_configs_utils.substitutions.xacro.Xacro.parse (   cls,
Iterable[SomeSubstitutionsType]  data 
)
Parse `XacroSubstitution` substitution.

Definition at line 32 of file xacro.py.

◆ perform()

Text moveit_configs_utils.substitutions.xacro.Xacro.perform (   self,
LaunchContext  context 
)
Perform the substitution by retrieving the mappings and context.

Definition at line 59 of file xacro.py.


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