The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | Protected Attributes | List of all members
moveit_setup::app::LaunchBundle::BonusTemplatedFile Class Reference

#include <launch_bundle.hpp>

Inheritance diagram for moveit_setup::app::LaunchBundle::BonusTemplatedFile:
Inheritance graph
Collaboration diagram for moveit_setup::app::LaunchBundle::BonusTemplatedFile:
Collaboration graph

Public Member Functions

 BonusTemplatedFile (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, const std::filesystem::path &relative_path, const std::string &description)
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...
std::filesystem::path getTemplatePath () const override
 Returns the full path to the template file. More...
bool hasChanges () const override
 Returns true if this file will have changes when it is written to file. More...
- Public Member Functions inherited from moveit_setup::TemplatedGeneratedFile
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

std::filesystem::path relative_path_
std::string description_
- Protected Attributes inherited from moveit_setup::GeneratedFile
std::filesystem::path package_path_
const GeneratedTimelast_gen_time_

Additional Inherited Members

- Static Public Attributes inherited from moveit_setup::TemplatedGeneratedFile
static std::vector< TemplateVariablevariables
- Static Protected Attributes inherited from moveit_setup::GeneratedFile
static constexpr GeneratedTime::duration TIME_MOD_TOLERANCE = std::chrono::seconds(10)

Detailed Description

Definition at line 163 of file launch_bundle.hpp.

Constructor & Destructor Documentation

◆ BonusTemplatedFile()

moveit_setup::app::LaunchBundle::BonusTemplatedFile::BonusTemplatedFile ( const std::filesystem::path &  package_path,
const GeneratedTime last_gen_time,
const std::filesystem::path &  relative_path,
const std::string &  description 

Definition at line 166 of file launch_bundle.hpp.

Member Function Documentation

◆ getDescription()

std::string moveit_setup::app::LaunchBundle::BonusTemplatedFile::getDescription ( ) const

Returns an English description of this file's purpose.

Implements moveit_setup::GeneratedFile.

Definition at line 177 of file launch_bundle.hpp.

◆ getRelativePath()

std::filesystem::path moveit_setup::app::LaunchBundle::BonusTemplatedFile::getRelativePath ( ) const

Returns the path relative to the configuration package root.

Implements moveit_setup::GeneratedFile.

Definition at line 172 of file launch_bundle.hpp.

◆ getTemplatePath()

std::filesystem::path moveit_setup::app::LaunchBundle::BonusTemplatedFile::getTemplatePath ( ) const

Returns the full path to the template file.

Implements moveit_setup::TemplatedGeneratedFile.

Definition at line 182 of file launch_bundle.hpp.

Here is the call graph for this function:

◆ hasChanges()

bool moveit_setup::app::LaunchBundle::BonusTemplatedFile::hasChanges ( ) const

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

Implements moveit_setup::GeneratedFile.

Definition at line 187 of file launch_bundle.hpp.

Member Data Documentation

◆ description_

std::string moveit_setup::app::LaunchBundle::BonusTemplatedFile::description_

Definition at line 194 of file launch_bundle.hpp.

◆ relative_path_

std::filesystem::path moveit_setup::app::LaunchBundle::BonusTemplatedFile::relative_path_

Definition at line 193 of file launch_bundle.hpp.

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