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

#include <ros2_controllers_config.hpp>

Inheritance diagram for moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig:
Inheritance graph
[legend]
Collaboration diagram for moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig:
Collaboration graph
[legend]

Public Member Functions

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

Protected Attributes

ROS2ControllersConfigparent_
 
- Protected Attributes inherited from moveit_setup::GeneratedFile
std::filesystem::path package_path_
 
const GeneratedTimelast_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 55 of file ros2_controllers_config.hpp.

Constructor & Destructor Documentation

◆ GeneratedControllersConfig()

moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig::GeneratedControllersConfig ( const std::filesystem::path &  package_path,
const GeneratedTime last_gen_time,
ROS2ControllersConfig parent 
)
inline

Definition at line 58 of file ros2_controllers_config.hpp.

Member Function Documentation

◆ getDescription()

std::string moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig::getDescription ( ) const
inlineoverridevirtual

Returns an English description of this file's purpose.

Implements moveit_setup::GeneratedFile.

Definition at line 74 of file ros2_controllers_config.hpp.

◆ getRelativePath()

std::filesystem::path moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig::getRelativePath ( ) const
inlineoverridevirtual

Returns the path relative to the configuration package root.

Implements moveit_setup::GeneratedFile.

Definition at line 69 of file ros2_controllers_config.hpp.

◆ hasChanges()

bool moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig::hasChanges ( ) const
inlineoverridevirtual

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

Implements moveit_setup::GeneratedFile.

Definition at line 64 of file ros2_controllers_config.hpp.

Here is the call graph for this function:

◆ writeYaml()

bool moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig::writeYaml ( YAML::Emitter &  emitter)
overridevirtual

Implements moveit_setup::YamlGeneratedFile.

Definition at line 138 of file ros2_controllers_config.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ parent_

ROS2ControllersConfig& moveit_setup::controllers::ROS2ControllersConfig::GeneratedControllersConfig::parent_
protected

Definition at line 82 of file ros2_controllers_config.hpp.


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