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

#include <templates.hpp>

Inheritance diagram for moveit_setup::TemplatedGeneratedFile:

[legend]

Collaboration diagram for moveit_setup::TemplatedGeneratedFile:

[legend]

Public Member Functions
virtual std::filesystem::path	getTemplatePath () const =0
	Returns the full path to the template file.

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)

virtual std::filesystem::path	getRelativePath () const =0
	Returns the path relative to the configuration package root.

virtual std::string	getDescription () const =0
	Returns an English description of this file's purpose.

virtual bool	hasChanges () const =0
	Returns true if this file will have changes when it is written to file.

std::filesystem::path	getPath () const
	Returns the fully qualified path to this file.

FileStatus	getStatus () const

Static Public Attributes
static std::vector< TemplateVariable >	variables

Additional Inherited Members
Protected Attributes inherited from moveit_setup::GeneratedFile
std::filesystem::path	package_path_

const GeneratedTime &	last_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]

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

default

◆ GeneratedFile() [2/3]

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

inline

Definition at line 73 of file generated_file.hpp.

◆ GeneratedFile() [3/3]

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

default

◆ getTemplatePath()

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

pure virtual

Returns the full path to the template file.

Implemented in moveit_setup::app::LaunchBundle::GenericLaunchTemplate, moveit_setup::app::LaunchBundle::BonusTemplatedFile, moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader, moveit_setup::ModifiedUrdfConfig::GeneratedModifiedURDF, moveit_setup::PackageSettingsConfig::GeneratedPackageXML, moveit_setup::PackageSettingsConfig::GeneratedCMake, and moveit_setup::SRDFConfig::GeneratedCartesianLimits.

Here is the caller graph for this function:

◆ write()

bool moveit_setup::TemplatedGeneratedFile::write ( )

overridevirtual

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

static

Definition at line 72 of file templates.hpp.

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

moveit_setup_assistant/moveit_setup_framework/include/moveit_setup_framework/templates.hpp
moveit_setup_assistant/moveit_setup_framework/src/templates.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members