moveit_setup::GeneratedFile Class Reference

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:

Collaboration diagram for moveit_setup::GeneratedFile:

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 GeneratedTime &	last_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 &  )

default

GeneratedFile() [2/3]

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

default

~GeneratedFile()

virtual moveit_setup::GeneratedFile::~GeneratedFile ( )

virtualdefault

GeneratedFile() [3/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.

Member Function Documentation

getDescription()

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

pure virtual

Returns an English description of this file's purpose.

Implemented in moveit_setup::srdf_setup::GroupMetaConfig::GeneratedGroupMetaConfig, moveit_setup::SRDFConfig::GeneratedCartesianLimits, moveit_setup::SRDFConfig::GeneratedJointLimits, moveit_setup::SRDFConfig::GeneratedSRDF, moveit_setup::PackageSettingsConfig::GeneratedCMake, moveit_setup::PackageSettingsConfig::GeneratedPackageXML, moveit_setup::PackageSettingsConfig::GeneratedSettings, moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig, moveit_setup::controllers::MoveItControllersConfig::GeneratedControllersConfig, moveit_setup::ModifiedUrdfConfig::GeneratedModifiedURDF, moveit_setup::controllers::ControlXacroConfig::GeneratedInitialPositions, moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader, moveit_setup::app::PerceptionConfig::GeneratedSensorConfig, moveit_setup::app::LaunchBundle::BonusTemplatedFile, and moveit_setup::app::LaunchBundle::GenericLaunchTemplate.

getPath()

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

inline

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

Returns the path relative to the configuration package root.

Implemented in moveit_setup::srdf_setup::GroupMetaConfig::GeneratedGroupMetaConfig, moveit_setup::SRDFConfig::GeneratedCartesianLimits, moveit_setup::SRDFConfig::GeneratedJointLimits, moveit_setup::SRDFConfig::GeneratedSRDF, moveit_setup::PackageSettingsConfig::GeneratedCMake, moveit_setup::PackageSettingsConfig::GeneratedPackageXML, moveit_setup::PackageSettingsConfig::GeneratedSettings, moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig, moveit_setup::controllers::MoveItControllersConfig::GeneratedControllersConfig, moveit_setup::ModifiedUrdfConfig::GeneratedModifiedURDF, moveit_setup::controllers::ControlXacroConfig::GeneratedInitialPositions, moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader, moveit_setup::app::PerceptionConfig::GeneratedSensorConfig, moveit_setup::app::LaunchBundle::BonusTemplatedFile, and moveit_setup::app::LaunchBundle::GenericLaunchTemplate.

Here is the caller graph for this function:

getStatus()

FileStatus moveit_setup::GeneratedFile::getStatus ( ) const

inline

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

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

Implemented in moveit_setup::srdf_setup::GroupMetaConfig::GeneratedGroupMetaConfig, moveit_setup::SRDFConfig::GeneratedCartesianLimits, moveit_setup::SRDFConfig::GeneratedJointLimits, moveit_setup::SRDFConfig::GeneratedSRDF, moveit_setup::PackageSettingsConfig::GeneratedCMake, moveit_setup::PackageSettingsConfig::GeneratedPackageXML, moveit_setup::PackageSettingsConfig::GeneratedSettings, moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig, moveit_setup::controllers::MoveItControllersConfig::GeneratedControllersConfig, moveit_setup::ModifiedUrdfConfig::GeneratedModifiedURDF, moveit_setup::controllers::ControlXacroConfig::GeneratedInitialPositions, moveit_setup::controllers::ControlXacroConfig::GeneratedControlHeader, moveit_setup::app::PerceptionConfig::GeneratedSensorConfig, moveit_setup::app::LaunchBundle::BonusTemplatedFile, and moveit_setup::app::LaunchBundle::GenericLaunchTemplate.

Here is the caller graph for this function:

write()

virtual bool moveit_setup::GeneratedFile::write ( )

pure virtual

Writes the file to disk.

Implemented in moveit_setup::TemplatedGeneratedFile, moveit_setup::YamlGeneratedFile, moveit_setup::SRDFConfig::GeneratedSRDF, and moveit_setup::app::LaunchBundle::GenericLaunchTemplate.

Member Data Documentation

last_gen_time_

const GeneratedTime& moveit_setup::GeneratedFile::last_gen_time_

protected

Definition at line 128 of file generated_file.hpp.

package_path_

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

protected

Definition at line 127 of file generated_file.hpp.

TIME_MOD_TOLERANCE

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

staticconstexprprotected

Definition at line 125 of file generated_file.hpp.

---

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

• moveit_setup_assistant/moveit_setup_framework/include/moveit_setup_framework/generated_file.hpp