Class PackageSettingsConfig

Nested Relationships

Nested Types

Inheritance Relationships

Base Type

Class Documentation

class PackageSettingsConfig : public moveit_setup::SetupConfig

Public Functions

virtual void loadPrevious(const std::filesystem::path &package_path, const YAML::Node &node) override

Overridden method to load THIS config’s data variables.

Not to be confused with loadExisting which is a PackageSettingsConfig-specific method for loading ALL configs and their data.

virtual YAML::Node saveToYaml() const override

Optionally save “meta” information for saving in the .setup_assistant yaml file.

void loadExisting(const std::string &package_path_or_name)

Method for loading the contents of the .setup_assistant file into all the configs.

Parameters:

package_path_or_name – Either the path to the MoveIt config package folder OR the name of the package.

inline const std::filesystem::path &getPackagePath() const
inline const std::string &getPackageName() const
void setPackagePath(const std::filesystem::path &package_path)
void setPackageName(const std::string &package_name)
inline const GeneratedTime &getGenerationTime() const
inline virtual bool isConfigured() const override

Return true if this part of the configuration is completely set up.

bool hasValidName() const
bool hasValidEmail() const
inline virtual void collectFiles(const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, std::vector<GeneratedFilePtr> &files) override

Collect the files generated by this configuration and add them to the vector.

Parameters:

  • package_path – [in] the path to the root of the config package

  • last_gen_time – [in] The time (if any) when the config package was last generated

  • files – [out] Where to put the new generated files

virtual void collectVariables(std::vector<TemplateVariable> &variables) override

Collect key/value pairs for use in templates.

Parameters:

variables – [out] Where to put the new Variables

void loadDependencies()
inline std::string getAuthorName() const
inline std::string getAuthorEmail() const
inline void setAuthorName(const std::string &name)
inline void setAuthorEmail(const std::string &email)
void setGenerationTime()

Protected Attributes

std::filesystem::path config_pkg_path_

Loaded configuration package path - if an existing package was loaded, holds that path.

std::string new_package_name_ = {"unnamed_moveit_config"}

Name of the new package that is being (or going) to be generated, based on user specified save path.

std::string author_name_

Name of the author of this config.

std::string author_email_

Email of the author of this config.

bool author_info_changed_ = {false}
GeneratedTime config_pkg_generated_timestamp_

Timestamp when configuration package was generated, if it was previously generated.

std::set<std::string> package_dependencies_
class GeneratedCMake : public moveit_setup::TemplatedGeneratedFile

Public Functions

inline virtual bool hasChanges() const override

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

inline virtual std::filesystem::path getRelativePath() const override

Returns the path relative to the configuration package root.

inline virtual std::filesystem::path getTemplatePath() const override

Returns the full path to the template file.

inline virtual std::string getDescription() const override

Returns an English description of this file’s purpose.

class GeneratedPackageXML : public moveit_setup::TemplatedGeneratedFile

Public Functions

inline GeneratedPackageXML(const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, PackageSettingsConfig &parent)
inline virtual bool hasChanges() const override

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

inline virtual std::filesystem::path getRelativePath() const override

Returns the path relative to the configuration package root.

inline virtual std::filesystem::path getTemplatePath() const override

Returns the full path to the template file.

inline virtual std::string getDescription() const override

Returns an English description of this file’s purpose.

Protected Attributes

PackageSettingsConfig &parent_
class GeneratedSettings : public moveit_setup::YamlGeneratedFile

Public Functions

inline GeneratedSettings(const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, PackageSettingsConfig &parent)
inline virtual std::filesystem::path getRelativePath() const override

Returns the path relative to the configuration package root.

inline virtual std::string getDescription() const override

Returns an English description of this file’s purpose.

inline virtual bool hasChanges() const override

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

virtual bool writeYaml(YAML::Emitter &emitter) override

Protected Attributes

PackageSettingsConfig &parent_