moveit_setup::PackageSettingsConfig::GeneratedSettings Class Reference

#include <package_settings_config.hpp>

Inheritance diagram for moveit_setup::PackageSettingsConfig::GeneratedSettings:

Collaboration diagram for moveit_setup::PackageSettingsConfig::GeneratedSettings:

Public Member Functions
	GeneratedSettings (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, PackageSettingsConfig &parent)
std::filesystem::path	getRelativePath () const override
	Returns the path relative to the configuration package root.
std::string	getDescription () const override
	Returns an English description of this file's purpose.
bool	hasChanges () const override
	Returns true if this file will have changes when it is written to file.
bool	writeYaml (YAML::Emitter &emitter) override
Public Member Functions inherited from moveit_setup::YamlGeneratedFile
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)
std::filesystem::path	getPath () const
	Returns the fully qualified path to this file.
FileStatus	getStatus () const

Protected Attributes
PackageSettingsConfig &	parent_
Protected Attributes inherited from moveit_setup::GeneratedFile
std::filesystem::path	package_path_
const GeneratedTime &	last_gen_time_

Additional Inherited Members
Static Protected Attributes inherited from moveit_setup::GeneratedFile
static constexpr GeneratedTime::duration	TIME_MOD_TOLERANCE = std::chrono::seconds(10)

Detailed Description

Definition at line 91 of file package_settings_config.hpp.

Constructor & Destructor Documentation

GeneratedSettings()

moveit_setup::PackageSettingsConfig::GeneratedSettings::GeneratedSettings ( const std::filesystem::path &  package_path, const GeneratedTime &  last_gen_time, PackageSettingsConfig &  parent  )

inline

Definition at line 94 of file package_settings_config.hpp.

Member Function Documentation

getDescription()

std::string moveit_setup::PackageSettingsConfig::GeneratedSettings::getDescription ( ) const

inlineoverridevirtual

Returns an English description of this file's purpose.

Implements moveit_setup::GeneratedFile.

Definition at line 105 of file package_settings_config.hpp.

getRelativePath()

std::filesystem::path moveit_setup::PackageSettingsConfig::GeneratedSettings::getRelativePath ( ) const

inlineoverridevirtual

Returns the path relative to the configuration package root.

Implements moveit_setup::GeneratedFile.

Definition at line 100 of file package_settings_config.hpp.

hasChanges()

bool moveit_setup::PackageSettingsConfig::GeneratedSettings::hasChanges ( ) const

inlineoverridevirtual

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

Implements moveit_setup::GeneratedFile.

Definition at line 110 of file package_settings_config.hpp.

writeYaml()

bool moveit_setup::PackageSettingsConfig::GeneratedSettings::writeYaml ( YAML::Emitter &  emitter )

overridevirtual

Implements moveit_setup::YamlGeneratedFile.

Definition at line 158 of file package_settings_config.cpp.

Member Data Documentation

parent_

PackageSettingsConfig& moveit_setup::PackageSettingsConfig::GeneratedSettings::parent_

protected

Definition at line 119 of file package_settings_config.hpp.

---

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

• moveit_setup_assistant/moveit_setup_framework/include/moveit_setup_framework/data/package_settings_config.hpp
• moveit_setup_assistant/moveit_setup_framework/src/package_settings_config.cpp