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

#include <srdf_config.hpp>

Inheritance diagram for moveit_setup::SRDFConfig::GeneratedSRDF:
Inheritance graph
[legend]
Collaboration diagram for moveit_setup::SRDFConfig::GeneratedSRDF:
Collaboration graph
[legend]

Public Member Functions

 GeneratedSRDF (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, SRDFConfig &parent)
 
std::filesystem::path getRelativePath () const override
 Returns the path relative to the configuration package root.
 
std::string getDescription () const override
 Returns an English description of this file's purpose.
 
bool hasChanges () const override
 Returns true if this file will have changes when it is written to file.
 
bool write () override
 Writes the file to disk.
 
- 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

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

Additional Inherited Members

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

Detailed Description

Definition at line 155 of file srdf_config.hpp.

Constructor & Destructor Documentation

◆ GeneratedSRDF()

moveit_setup::SRDFConfig::GeneratedSRDF::GeneratedSRDF ( const std::filesystem::path &  package_path,
const GeneratedTime last_gen_time,
SRDFConfig parent 
)
inline

Definition at line 158 of file srdf_config.hpp.

Member Function Documentation

◆ getDescription()

std::string moveit_setup::SRDFConfig::GeneratedSRDF::getDescription ( ) const
inlineoverridevirtual

Returns an English description of this file's purpose.

Implements moveit_setup::GeneratedFile.

Definition at line 168 of file srdf_config.hpp.

◆ getRelativePath()

std::filesystem::path moveit_setup::SRDFConfig::GeneratedSRDF::getRelativePath ( ) const
inlineoverridevirtual

Returns the path relative to the configuration package root.

Implements moveit_setup::GeneratedFile.

Definition at line 163 of file srdf_config.hpp.

◆ hasChanges()

bool moveit_setup::SRDFConfig::GeneratedSRDF::hasChanges ( ) const
inlineoverridevirtual

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

Implements moveit_setup::GeneratedFile.

Definition at line 176 of file srdf_config.hpp.

◆ write()

bool moveit_setup::SRDFConfig::GeneratedSRDF::write ( )
inlineoverridevirtual

Writes the file to disk.

Implements moveit_setup::GeneratedFile.

Definition at line 181 of file srdf_config.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ parent_

SRDFConfig& moveit_setup::SRDFConfig::GeneratedSRDF::parent_
protected

Definition at line 189 of file srdf_config.hpp.


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