Public Member Functions | Public Attributes | List of all members
moveit_setup_assistant::OMPLPlannerDescription Class Reference

This class describes the OMPL planners by name, type, and parameter list, used to create the ompl_planning.yaml file. More...

#include <moveit_config_data.h>

Public Member Functions

void addParameter (const std::string &name, const std::string &value="", const std::string &comment="")
 adds a parameter to the planner description More...
 
 OMPLPlannerDescription (const std::string &name, const std::string &type)
 Constructor. More...
 
 ~OMPLPlannerDescription ()
 Destructor. More...
 

Public Attributes

std::string name_
 
std::vector< OmplPlanningParameterparameter_list_
 
std::string type_
 

Detailed Description

This class describes the OMPL planners by name, type, and parameter list, used to create the ompl_planning.yaml file.

Definition at line 134 of file moveit_config_data.h.

Constructor & Destructor Documentation

◆ OMPLPlannerDescription()

moveit_setup_assistant::OMPLPlannerDescription::OMPLPlannerDescription ( const std::string &  name,
const std::string &  type 
)
inline

Constructor.

Parameters
namename of planner @parameter type: type of planner

Definition at line 141 of file moveit_config_data.h.

◆ ~OMPLPlannerDescription()

moveit_setup_assistant::OMPLPlannerDescription::~OMPLPlannerDescription ( )
inline

Destructor.

Definition at line 147 of file moveit_config_data.h.

Member Function Documentation

◆ addParameter()

void moveit_setup_assistant::OMPLPlannerDescription::addParameter ( const std::string &  name,
const std::string &  value = "",
const std::string &  comment = "" 
)
inline

adds a parameter to the planner description

Parameters
namename of parameter to add @parameter: value: value of parameter as a string @parameter: value: value of parameter as a string

Definition at line 156 of file moveit_config_data.h.

Member Data Documentation

◆ name_

std::string moveit_setup_assistant::OMPLPlannerDescription::name_

Definition at line 165 of file moveit_config_data.h.

◆ parameter_list_

std::vector<OmplPlanningParameter> moveit_setup_assistant::OMPLPlannerDescription::parameter_list_

Definition at line 164 of file moveit_config_data.h.

◆ type_

std::string moveit_setup_assistant::OMPLPlannerDescription::type_

Definition at line 166 of file moveit_config_data.h.


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


moveit_setup_assistant
Author(s): Dave Coleman
autogenerated on Sat May 3 2025 02:28:05