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

Specialization of GeneratedFile for generating a text file from a template. More...

#include <templates.hpp>

Inheritance diagram for moveit_setup::TemplatedGeneratedFile:
Inheritance graph
Collaboration diagram for moveit_setup::TemplatedGeneratedFile:
Collaboration graph

Public Member Functions

virtual std::filesystem::path getTemplatePath () const =0
 Returns the full path to the template file. More...
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)
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...
std::filesystem::path getPath () const
 Returns the fully qualified path to this file. More...
FileStatus getStatus () const

Static Public Attributes

static std::vector< TemplateVariablevariables

Additional Inherited Members

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

Detailed Description

Specialization of GeneratedFile for generating a text file from a template.

Definition at line 59 of file templates.hpp.

Member Function Documentation

◆ GeneratedFile() [1/3]


◆ GeneratedFile() [2/3]


Definition at line 73 of file generated_file.hpp.

◆ GeneratedFile() [3/3]


◆ getTemplatePath()

virtual std::filesystem::path moveit_setup::TemplatedGeneratedFile::getTemplatePath ( ) const
pure virtual

◆ write()

bool moveit_setup::TemplatedGeneratedFile::write ( )

Writes the file to disk.

Implements moveit_setup::GeneratedFile.

Definition at line 53 of file templates.cpp.

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

Member Data Documentation

◆ variables

std::vector< TemplateVariable > moveit_setup::TemplatedGeneratedFile::variables

Definition at line 72 of file templates.hpp.

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