moveit_setup::app::LaunchBundle Class Reference

One launch file and any other bonus files that get bundled with it, i.e. the RViz launch file and its config. More...

#include <launch_bundle.hpp>

Classes
struct	BonusFile
class	BonusTemplatedFile
class	GenericLaunchTemplate

Public Member Functions
	LaunchBundle (const std::string &title, const std::string &description, const std::string &launch_name, const std::set< std::string > &dependencies={})
const std::string &	getTitle () const
const std::string &	getDescription () const
unsigned int	getID () const
	The ID is an index in a list, used for quick identification and argument passing.
void	setID (unsigned int id)
void	addFile (const std::filesystem::path &relative_path, const std::string &description)
const std::set< std::string >	getDependencies () const
bool	operator< (const LaunchBundle &other) const
	Defined so that LaunchBundles can be added to sets.
void	collectFiles (const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, std::vector< GeneratedFilePtr > &files) const

Protected Attributes
std::string	title_
std::string	description_
std::string	launch_name_
std::set< std::string >	dependencies_
unsigned int	id_
std::vector< BonusFile >	bonus_files_

Detailed Description

One launch file and any other bonus files that get bundled with it, i.e. the RViz launch file and its config.

Each launch bundle is presented to the user as option to generate. They are bundled because it would not (generally) make sense to generate the RViz config without the launch file.

Definition at line 51 of file launch_bundle.hpp.

Constructor & Destructor Documentation

LaunchBundle()

moveit_setup::app::LaunchBundle::LaunchBundle ( const std::string &  title, const std::string &  description, const std::string &  launch_name, const std::set< std::string > &  dependencies = {}  )

inline

Parameters

title	The display name for this LaunchBundle
description	An English description of the files contained within
launch_name	The identifier that signifies the name of the generated launch file (launch_name.launch.py)
dependencies	Each string is the name of a package that should be added as a dependency if this bundle is generated

Definition at line 60 of file launch_bundle.hpp.

Member Function Documentation

addFile()

void moveit_setup::app::LaunchBundle::addFile ( const std::filesystem::path &  relative_path, const std::string &  description  )

inline

Definition at line 89 of file launch_bundle.hpp.

collectFiles()

void moveit_setup::app::LaunchBundle::collectFiles ( const std::filesystem::path &  package_path, const GeneratedTime &  last_gen_time, std::vector< GeneratedFilePtr > &  files  ) const

inline

Definition at line 197 of file launch_bundle.hpp.

getDependencies()

const std::set< std::string > moveit_setup::app::LaunchBundle::getDependencies ( ) const

inline

Definition at line 94 of file launch_bundle.hpp.

getDescription()

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

inline

Definition at line 71 of file launch_bundle.hpp.

getID()

unsigned int moveit_setup::app::LaunchBundle::getID ( ) const

inline

The ID is an index in a list, used for quick identification and argument passing.

Definition at line 79 of file launch_bundle.hpp.

getTitle()

const std::string & moveit_setup::app::LaunchBundle::getTitle ( ) const

inline

Definition at line 66 of file launch_bundle.hpp.

operator<()

bool moveit_setup::app::LaunchBundle::operator< ( const LaunchBundle &  other ) const

inline

Defined so that LaunchBundles can be added to sets.

Definition at line 102 of file launch_bundle.hpp.

setID()

void moveit_setup::app::LaunchBundle::setID ( unsigned int  id )

inline

Definition at line 84 of file launch_bundle.hpp.

Member Data Documentation

bonus_files_

std::vector<BonusFile> moveit_setup::app::LaunchBundle::bonus_files_

protected

Definition at line 214 of file launch_bundle.hpp.

dependencies_

std::set<std::string> moveit_setup::app::LaunchBundle::dependencies_

protected

Definition at line 211 of file launch_bundle.hpp.

description_

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

protected

Definition at line 210 of file launch_bundle.hpp.

id_

unsigned int moveit_setup::app::LaunchBundle::id_

protected

Definition at line 212 of file launch_bundle.hpp.

launch_name_

std::string moveit_setup::app::LaunchBundle::launch_name_

protected

Definition at line 210 of file launch_bundle.hpp.

title_

std::string moveit_setup::app::LaunchBundle::title_

protected

Definition at line 210 of file launch_bundle.hpp.

---

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

• moveit_setup_assistant/moveit_setup_app_plugins/include/moveit_setup_app_plugins/launch_bundle.hpp