moveit2
The MoveIt Motion Planning Framework for ROS 2.
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
moveit_setup::PackageSettingsConfig::GeneratedPackageXML Class Reference

#include <package_settings_config.hpp>

Inheritance diagram for moveit_setup::PackageSettingsConfig::GeneratedPackageXML:
Inheritance graph
[legend]
Collaboration diagram for moveit_setup::PackageSettingsConfig::GeneratedPackageXML:
Collaboration graph
[legend]

Public Member Functions

 GeneratedPackageXML (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, PackageSettingsConfig &parent)
 
bool hasChanges () const override
 Returns true if this file will have changes when it is written to file.
 
std::filesystem::path getRelativePath () const override
 Returns the path relative to the configuration package root.
 
std::filesystem::path getTemplatePath () const override
 Returns the full path to the template file.
 
std::string getDescription () const override
 Returns an English description of this file's purpose.
 
- Public Member Functions inherited from moveit_setup::TemplatedGeneratedFile
bool write () override
 Writes the file to disk.
 
 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.
 
FileStatus getStatus () const
 

Protected Attributes

PackageSettingsConfigparent_
 
- 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 122 of file package_settings_config.hpp.

Constructor & Destructor Documentation

◆ GeneratedPackageXML()

moveit_setup::PackageSettingsConfig::GeneratedPackageXML::GeneratedPackageXML ( const std::filesystem::path &  package_path,
const GeneratedTime last_gen_time,
PackageSettingsConfig parent 
)
inline

Definition at line 125 of file package_settings_config.hpp.

Member Function Documentation

◆ getDescription()

std::string moveit_setup::PackageSettingsConfig::GeneratedPackageXML::getDescription ( ) const
inlineoverridevirtual

Returns an English description of this file's purpose.

Implements moveit_setup::GeneratedFile.

Definition at line 147 of file package_settings_config.hpp.

◆ getRelativePath()

std::filesystem::path moveit_setup::PackageSettingsConfig::GeneratedPackageXML::getRelativePath ( ) const
inlineoverridevirtual

Returns the path relative to the configuration package root.

Implements moveit_setup::GeneratedFile.

Definition at line 136 of file package_settings_config.hpp.

◆ getTemplatePath()

std::filesystem::path moveit_setup::PackageSettingsConfig::GeneratedPackageXML::getTemplatePath ( ) const
inlineoverridevirtual

Returns the full path to the template file.

Implements moveit_setup::TemplatedGeneratedFile.

Definition at line 141 of file package_settings_config.hpp.

Here is the call graph for this function:

◆ hasChanges()

bool moveit_setup::PackageSettingsConfig::GeneratedPackageXML::hasChanges ( ) const
inlineoverridevirtual

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

Implements moveit_setup::GeneratedFile.

Definition at line 131 of file package_settings_config.hpp.

Member Data Documentation

◆ parent_

PackageSettingsConfig& moveit_setup::PackageSettingsConfig::GeneratedPackageXML::parent_
protected

Definition at line 153 of file package_settings_config.hpp.


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