moveit_setup::YamlGeneratedFile Class Reference

#include <generated_file.hpp>

Inheritance diagram for moveit_setup::YamlGeneratedFile:

Collaboration diagram for moveit_setup::YamlGeneratedFile:

Public Member Functions
bool	write () override
	Writes the file to disk.
virtual bool	writeYaml (YAML::Emitter &emitter)=0
	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

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

Definition at line 131 of file generated_file.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

write()

bool moveit_setup::YamlGeneratedFile::write ( )

inlineoverridevirtual

Writes the file to disk.

Implements moveit_setup::GeneratedFile.

Definition at line 136 of file generated_file.hpp.

Here is the call graph for this function:

writeYaml()

virtual bool moveit_setup::YamlGeneratedFile::writeYaml ( YAML::Emitter &  emitter )

pure virtual

Implemented in moveit_setup::app::PerceptionConfig::GeneratedSensorConfig, moveit_setup::controllers::ControlXacroConfig::GeneratedInitialPositions, moveit_setup::controllers::MoveItControllersConfig::GeneratedControllersConfig, moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig, moveit_setup::PackageSettingsConfig::GeneratedSettings, moveit_setup::SRDFConfig::GeneratedJointLimits, and moveit_setup::srdf_setup::GroupMetaConfig::GeneratedGroupMetaConfig.

Here is the caller graph for this function:

---

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

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