The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
moveit_setup::GeneratedFile Class Referenceabstract

Container for the logic for a single file to appear in MoveIt configuration package. More...

#include <generated_file.hpp>

Inheritance diagram for moveit_setup::GeneratedFile:
Inheritance graph
Collaboration diagram for moveit_setup::GeneratedFile:
Collaboration graph

Public Member Functions

 GeneratedFile (const GeneratedFile &)=default
 GeneratedFile (GeneratedFile &&)=default
virtual ~GeneratedFile ()=default
 GeneratedFile (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time)
virtual std::filesystem::path getRelativePath () const =0
 Returns the path relative to the configuration package root. More...
virtual std::string getDescription () const =0
 Returns an English description of this file's purpose. More...
virtual bool hasChanges () const =0
 Returns true if this file will have changes when it is written to file. More...
virtual bool write ()=0
 Writes the file to disk. More...
std::filesystem::path getPath () const
 Returns the fully qualified path to this file. More...
FileStatus getStatus () const

Protected Attributes

std::filesystem::path package_path_
const GeneratedTimelast_gen_time_

Static Protected Attributes

static constexpr GeneratedTime::duration TIME_MOD_TOLERANCE = std::chrono::seconds(10)

Detailed Description

Container for the logic for a single file to appear in MoveIt configuration package.

Definition at line 66 of file generated_file.hpp.

Constructor & Destructor Documentation

◆ GeneratedFile() [1/3]

moveit_setup::GeneratedFile::GeneratedFile ( const GeneratedFile )

◆ GeneratedFile() [2/3]

moveit_setup::GeneratedFile::GeneratedFile ( GeneratedFile &&  )

◆ ~GeneratedFile()

virtual moveit_setup::GeneratedFile::~GeneratedFile ( )

◆ GeneratedFile() [3/3]

moveit_setup::GeneratedFile::GeneratedFile ( const std::filesystem::path &  package_path,
const GeneratedTime last_gen_time 

Definition at line 73 of file generated_file.hpp.

Member Function Documentation

◆ getDescription()

virtual std::string moveit_setup::GeneratedFile::getDescription ( ) const
pure virtual

◆ getPath()

std::filesystem::path moveit_setup::GeneratedFile::getPath ( ) const

Returns the fully qualified path to this file.

Definition at line 101 of file generated_file.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getRelativePath()

virtual std::filesystem::path moveit_setup::GeneratedFile::getRelativePath ( ) const
pure virtual

◆ getStatus()

FileStatus moveit_setup::GeneratedFile::getStatus ( ) const

Definition at line 106 of file generated_file.hpp.

Here is the call graph for this function:

◆ hasChanges()

virtual bool moveit_setup::GeneratedFile::hasChanges ( ) const
pure virtual

◆ write()

virtual bool moveit_setup::GeneratedFile::write ( )
pure virtual

Member Data Documentation

◆ last_gen_time_

const GeneratedTime& moveit_setup::GeneratedFile::last_gen_time_

Definition at line 128 of file generated_file.hpp.

◆ package_path_

std::filesystem::path moveit_setup::GeneratedFile::package_path_

Definition at line 127 of file generated_file.hpp.


constexpr GeneratedTime::duration moveit_setup::GeneratedFile::TIME_MOD_TOLERANCE = std::chrono::seconds(10)

Definition at line 125 of file generated_file.hpp.

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