moveit2
The MoveIt Motion Planning Framework for ROS 2.
Classes | Public Member Functions | Protected Attributes | List of all members
moveit_setup::PackageSettingsConfig Class Reference

#include <package_settings_config.hpp>

Inheritance diagram for moveit_setup::PackageSettingsConfig:
Inheritance graph
[legend]
Collaboration diagram for moveit_setup::PackageSettingsConfig:
Collaboration graph
[legend]

Classes

class  GeneratedCMake
 
class  GeneratedPackageXML
 
class  GeneratedSettings
 

Public Member Functions

void loadPrevious (const std::filesystem::path &package_path, const YAML::Node &node) override
 Overridden method to load THIS config's data variables. More...
 
YAML::Node saveToYaml () const override
 Optionally save "meta" information for saving in the .setup_assistant yaml file. More...
 
void loadExisting (const std::string &package_path_or_name)
 Method for loading the contents of the .setup_assistant file into all the configs. More...
 
const std::filesystem::path & getPackagePath () const
 
const std::string & getPackageName () const
 
void setPackagePath (const std::filesystem::path &package_path)
 
void setPackageName (const std::string &package_name)
 
const GeneratedTimegetGenerationTime () const
 
bool isConfigured () const override
 Return true if this part of the configuration is completely set up. More...
 
bool hasValidName () const
 
bool hasValidEmail () const
 
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. More...
 
void collectVariables (std::vector< TemplateVariable > &variables) override
 Collect key/value pairs for use in templates. More...
 
void loadDependencies ()
 
std::string getAuthorName () const
 
std::string getAuthorEmail () const
 
void setAuthorName (const std::string &name)
 
void setAuthorEmail (const std::string &email)
 
void setGenerationTime ()
 
- Public Member Functions inherited from moveit_setup::SetupConfig
 SetupConfig ()=default
 
 SetupConfig (const SetupConfig &)=default
 
 SetupConfig (SetupConfig &&)=default
 
SetupConfigoperator= (const SetupConfig &)=default
 
SetupConfigoperator= (SetupConfig &&)=default
 
virtual ~SetupConfig ()=default
 
void initialize (const std::shared_ptr< DataWarehouse > &config_data, const rclcpp::Node::SharedPtr &parent_node, const std::string &name)
 Called after construction to initialize the step. More...
 
virtual void onInit ()
 Overridable initialization method. More...
 
const std::string & getName ()
 The name for this part of the configuration. More...
 
virtual void collectDependencies (std::set< std::string > &) const
 Collect the package dependencies generated by this configuration. More...
 

Protected Attributes

std::filesystem::path config_pkg_path_
 Loaded configuration package path - if an existing package was loaded, holds that path. More...
 
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. More...
 
std::string author_name_
 Name of the author of this config. More...
 
std::string author_email_
 Email of the author of this config. More...
 
bool author_info_changed_ { false }
 
GeneratedTime config_pkg_generated_timestamp_
 Timestamp when configuration package was generated, if it was previously generated. More...
 
std::set< std::string > package_dependencies_
 
- Protected Attributes inherited from moveit_setup::SetupConfig
std::shared_ptr< DataWarehouseconfig_data_
 
rclcpp::Node::SharedPtr parent_node_
 
std::string name_
 
std::shared_ptr< rclcpp::Logger > logger_
 

Detailed Description

Definition at line 44 of file package_settings_config.hpp.

Member Function Documentation

◆ collectFiles()

void moveit_setup::PackageSettingsConfig::collectFiles ( const std::filesystem::path &  ,
const GeneratedTime ,
std::vector< GeneratedFilePtr > &   
)
inlineoverridevirtual

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

Parameters
[in]package_paththe path to the root of the config package
[in]last_gen_timeThe time (if any) when the config package was last generated @parma[out] files Where to put the new generated files

Reimplemented from moveit_setup::SetupConfig.

Definition at line 182 of file package_settings_config.hpp.

◆ collectVariables()

void moveit_setup::PackageSettingsConfig::collectVariables ( std::vector< TemplateVariable > &  )
overridevirtual

Collect key/value pairs for use in templates.

Parameters
[out]variablesWhere to put the new Variables

Reimplemented from moveit_setup::SetupConfig.

Definition at line 188 of file package_settings_config.cpp.

◆ getAuthorEmail()

std::string moveit_setup::PackageSettingsConfig::getAuthorEmail ( ) const
inline

Definition at line 198 of file package_settings_config.hpp.

◆ getAuthorName()

std::string moveit_setup::PackageSettingsConfig::getAuthorName ( ) const
inline

Definition at line 194 of file package_settings_config.hpp.

◆ getGenerationTime()

const GeneratedTime& moveit_setup::PackageSettingsConfig::getGenerationTime ( ) const
inline

Definition at line 77 of file package_settings_config.hpp.

◆ getPackageName()

const std::string& moveit_setup::PackageSettingsConfig::getPackageName ( ) const
inline

Definition at line 68 of file package_settings_config.hpp.

◆ getPackagePath()

const std::filesystem::path& moveit_setup::PackageSettingsConfig::getPackagePath ( ) const
inline

Definition at line 63 of file package_settings_config.hpp.

◆ hasValidEmail()

bool moveit_setup::PackageSettingsConfig::hasValidEmail ( ) const

Definition at line 211 of file package_settings_config.cpp.

Here is the call graph for this function:

◆ hasValidName()

bool moveit_setup::PackageSettingsConfig::hasValidName ( ) const

Definition at line 205 of file package_settings_config.cpp.

◆ isConfigured()

bool moveit_setup::PackageSettingsConfig::isConfigured ( ) const
inlineoverridevirtual

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

Reimplemented from moveit_setup::SetupConfig.

Definition at line 82 of file package_settings_config.hpp.

◆ loadDependencies()

void moveit_setup::PackageSettingsConfig::loadDependencies ( )

Definition at line 179 of file package_settings_config.cpp.

◆ loadExisting()

void moveit_setup::PackageSettingsConfig::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_nameEither the path to the MoveIt config package folder OR the name of the package.

Definition at line 73 of file package_settings_config.cpp.

Here is the call graph for this function:

◆ loadPrevious()

void moveit_setup::PackageSettingsConfig::loadPrevious ( const std::filesystem::path &  package_path,
const YAML::Node &  node 
)
overridevirtual

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.

Reimplemented from moveit_setup::SetupConfig.

Definition at line 45 of file package_settings_config.cpp.

Here is the call graph for this function:

◆ saveToYaml()

YAML::Node moveit_setup::PackageSettingsConfig::saveToYaml ( ) const
overridevirtual

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

Reimplemented from moveit_setup::SetupConfig.

Definition at line 54 of file package_settings_config.cpp.

Here is the call graph for this function:

◆ setAuthorEmail()

void moveit_setup::PackageSettingsConfig::setAuthorEmail ( const std::string &  email)
inline

Definition at line 206 of file package_settings_config.hpp.

◆ setAuthorName()

void moveit_setup::PackageSettingsConfig::setAuthorName ( const std::string &  name)
inline

Definition at line 202 of file package_settings_config.hpp.

◆ setGenerationTime()

void moveit_setup::PackageSettingsConfig::setGenerationTime ( )

Definition at line 216 of file package_settings_config.cpp.

◆ setPackageName()

void moveit_setup::PackageSettingsConfig::setPackageName ( const std::string &  package_name)

Definition at line 68 of file package_settings_config.cpp.

◆ setPackagePath()

void moveit_setup::PackageSettingsConfig::setPackagePath ( const std::filesystem::path &  package_path)

Definition at line 63 of file package_settings_config.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ author_email_

std::string moveit_setup::PackageSettingsConfig::author_email_
protected

Email of the author of this config.

Definition at line 224 of file package_settings_config.hpp.

◆ author_info_changed_

bool moveit_setup::PackageSettingsConfig::author_info_changed_ { false }
protected

Definition at line 226 of file package_settings_config.hpp.

◆ author_name_

std::string moveit_setup::PackageSettingsConfig::author_name_
protected

Name of the author of this config.

Definition at line 221 of file package_settings_config.hpp.

◆ config_pkg_generated_timestamp_

GeneratedTime moveit_setup::PackageSettingsConfig::config_pkg_generated_timestamp_
protected

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

Definition at line 229 of file package_settings_config.hpp.

◆ config_pkg_path_

std::filesystem::path moveit_setup::PackageSettingsConfig::config_pkg_path_
protected

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

Definition at line 215 of file package_settings_config.hpp.

◆ new_package_name_

std::string moveit_setup::PackageSettingsConfig::new_package_name_ { "unnamed_moveit_config" }
protected

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

Definition at line 218 of file package_settings_config.hpp.

◆ package_dependencies_

std::set<std::string> moveit_setup::PackageSettingsConfig::package_dependencies_
protected

Definition at line 231 of file package_settings_config.hpp.


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