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

#include <launch_bundle.hpp>

Inheritance diagram for moveit_setup::app::LaunchBundle::GenericLaunchTemplate:
Inheritance graph
[legend]
Collaboration diagram for moveit_setup::app::LaunchBundle::GenericLaunchTemplate:
Collaboration graph
[legend]

Public Member Functions

 GenericLaunchTemplate (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, const LaunchBundle &parent)
 
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...
 
bool write () override
 Writes the file to disk. 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

const LaunchBundleparent_
 
std::string function_name_
 
std::filesystem::path relative_path_
 
std::filesystem::path template_path_
 
- 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 107 of file launch_bundle.hpp.

Constructor & Destructor Documentation

◆ GenericLaunchTemplate()

moveit_setup::app::LaunchBundle::GenericLaunchTemplate::GenericLaunchTemplate ( const std::filesystem::path &  package_path,
const GeneratedTime last_gen_time,
const LaunchBundle parent 
)
inline

Definition at line 110 of file launch_bundle.hpp.

Here is the call graph for this function:

Member Function Documentation

◆ getDescription()

std::string moveit_setup::app::LaunchBundle::GenericLaunchTemplate::getDescription ( ) const
inlineoverridevirtual

Returns an English description of this file's purpose.

Implements moveit_setup::GeneratedFile.

Definition at line 124 of file launch_bundle.hpp.

◆ getRelativePath()

std::filesystem::path moveit_setup::app::LaunchBundle::GenericLaunchTemplate::getRelativePath ( ) const
inlineoverridevirtual

Returns the path relative to the configuration package root.

Implements moveit_setup::GeneratedFile.

Definition at line 119 of file launch_bundle.hpp.

◆ getTemplatePath()

std::filesystem::path moveit_setup::app::LaunchBundle::GenericLaunchTemplate::getTemplatePath ( ) const
inlineoverridevirtual

Returns the full path to the template file.

Implements moveit_setup::TemplatedGeneratedFile.

Definition at line 129 of file launch_bundle.hpp.

◆ hasChanges()

bool moveit_setup::app::LaunchBundle::GenericLaunchTemplate::hasChanges ( ) const
inlineoverridevirtual

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

Implements moveit_setup::GeneratedFile.

Definition at line 134 of file launch_bundle.hpp.

◆ write()

bool moveit_setup::app::LaunchBundle::GenericLaunchTemplate::write ( )
inlineoverridevirtual

Writes the file to disk.

Implements moveit_setup::GeneratedFile.

Definition at line 139 of file launch_bundle.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ function_name_

std::string moveit_setup::app::LaunchBundle::GenericLaunchTemplate::function_name_
protected

Definition at line 150 of file launch_bundle.hpp.

◆ parent_

const LaunchBundle& moveit_setup::app::LaunchBundle::GenericLaunchTemplate::parent_
protected

Definition at line 149 of file launch_bundle.hpp.

◆ relative_path_

std::filesystem::path moveit_setup::app::LaunchBundle::GenericLaunchTemplate::relative_path_
protected

Definition at line 151 of file launch_bundle.hpp.

◆ template_path_

std::filesystem::path moveit_setup::app::LaunchBundle::GenericLaunchTemplate::template_path_
protected

Definition at line 151 of file launch_bundle.hpp.


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