moveit2
The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | Protected Attributes | List of all members
moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader Class Reference

#include <control_xacro_config.hpp>

Inheritance diagram for moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader:
Inheritance graph
[legend]
Collaboration diagram for moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader:
Collaboration graph
[legend]

Public Member Functions

 GeneratedControlHeader (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, ControlXacroConfig &parent)
 
std::filesystem::path getRelativePath () const override
 Returns the path relative to the configuration package root. More...
 
std::filesystem::path getTemplatePath () const override
 Returns the full path to the template file. More...
 
std::string getDescription () const override
 Returns an English description of this file's purpose. More...
 
bool hasChanges () const override
 Returns true if this file will have changes when it is written to file. More...
 
- Public Member Functions inherited from moveit_setup::TemplatedGeneratedFile
bool write () override
 Writes the file to disk. More...
 
 GeneratedFile (const GeneratedFile &)=default
 
 GeneratedFile (GeneratedFile &&)=default
 
 GeneratedFile (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time)
 
- Public Member Functions inherited from moveit_setup::GeneratedFile
 GeneratedFile (const GeneratedFile &)=default
 
 GeneratedFile (GeneratedFile &&)=default
 
virtual ~GeneratedFile ()=default
 
 GeneratedFile (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time)
 
std::filesystem::path getPath () const
 Returns the fully qualified path to this file. More...
 
FileStatus getStatus () const
 

Protected Attributes

ControlXacroConfigparent_
 
- Protected Attributes inherited from moveit_setup::GeneratedFile
std::filesystem::path package_path_
 
const GeneratedTimelast_gen_time_
 

Additional Inherited Members

- Static Public Attributes inherited from moveit_setup::TemplatedGeneratedFile
static std::vector< TemplateVariablevariables_
 
- Static Protected Attributes inherited from moveit_setup::GeneratedFile
static constexpr GeneratedTime::duration TIME_MOD_TOLERANCE = std::chrono::seconds(10)
 

Detailed Description

Definition at line 115 of file control_xacro_config.hpp.

Constructor & Destructor Documentation

◆ GeneratedControlHeader()

moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader::GeneratedControlHeader ( const std::filesystem::path &  package_path,
const GeneratedTime last_gen_time,
ControlXacroConfig parent 
)
inline

Definition at line 118 of file control_xacro_config.hpp.

Member Function Documentation

◆ getDescription()

std::string moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader::getDescription ( ) const
inlineoverridevirtual

Returns an English description of this file's purpose.

Implements moveit_setup::GeneratedFile.

Definition at line 134 of file control_xacro_config.hpp.

◆ getRelativePath()

std::filesystem::path moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader::getRelativePath ( ) const
inlineoverridevirtual

Returns the path relative to the configuration package root.

Implements moveit_setup::GeneratedFile.

Definition at line 124 of file control_xacro_config.hpp.

◆ getTemplatePath()

std::filesystem::path moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader::getTemplatePath ( ) const
inlineoverridevirtual

Returns the full path to the template file.

Implements moveit_setup::TemplatedGeneratedFile.

Definition at line 129 of file control_xacro_config.hpp.

Here is the call graph for this function:

◆ hasChanges()

bool moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader::hasChanges ( ) const
inlineoverridevirtual

Returns true if this file will have changes when it is written to file.

Implements moveit_setup::GeneratedFile.

Definition at line 139 of file control_xacro_config.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ parent_

ControlXacroConfig& moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader::parent_
protected

Definition at line 145 of file control_xacro_config.hpp.


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