moveit2
The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | List of all members
ompl_interface::OMPLPlannerManager Class Reference
Inheritance diagram for ompl_interface::OMPLPlannerManager:
Inheritance graph
[legend]
Collaboration diagram for ompl_interface::OMPLPlannerManager:
Collaboration graph
[legend]

Public Member Functions

 OMPLPlannerManager ()
 
bool initialize (const moveit::core::RobotModelConstPtr &model, const rclcpp::Node::SharedPtr &node, const std::string &parameter_namespace) override
 
bool canServiceRequest (const moveit_msgs::msg::MotionPlanRequest &req) const override
 Determine whether this plugin instance is able to represent this planning request. More...
 
std::string getDescription () const override
 Get. More...
 
void getPlanningAlgorithms (std::vector< std::string > &algs) const override
 Get the names of the known planning algorithms (values that can be filled as planner_id in the planning request) More...
 
void setPlannerConfigurations (const planning_interface::PlannerConfigurationMap &pconfig) override
 Specify the settings to be used for specific algorithms. More...
 
planning_interface::PlanningContextPtr getPlanningContext (const planning_scene::PlanningSceneConstPtr &planning_scene, const planning_interface::MotionPlanRequest &req, moveit_msgs::msg::MoveItErrorCodes &error_code) const override
 Construct a planning context given the current scene and a planning request. If a problem is encountered, error code is set and empty ptr is returned. The returned motion planner context is clean – the motion planner will start from scratch every time a context is constructed. More...
 
- Public Member Functions inherited from planning_interface::PlannerManager
 PlannerManager ()
 
virtual ~PlannerManager ()
 
PlanningContextPtr getPlanningContext (const planning_scene::PlanningSceneConstPtr &planning_scene, const MotionPlanRequest &req) const
 Calls the function above but ignores the error_code. More...
 
const PlannerConfigurationMapgetPlannerConfigurations () const
 Get the settings for a specific algorithm. More...
 
void terminate () const
 Request termination, if a solve() function is currently computing plans. More...
 

Additional Inherited Members

- Protected Attributes inherited from planning_interface::PlannerManager
PlannerConfigurationMap config_settings_
 All the existing planning configurations. The name of the configuration is the key of the map. This name can be of the form "group_name[config_name]" if there are particular configurations specified for a group, or of the form "group_name" if default settings are to be used. More...
 

Detailed Description

Definition at line 48 of file ompl_planner_manager.cpp.

Constructor & Destructor Documentation

◆ OMPLPlannerManager()

ompl_interface::OMPLPlannerManager::OMPLPlannerManager ( )
inline

Definition at line 51 of file ompl_planner_manager.cpp.

Member Function Documentation

◆ canServiceRequest()

bool ompl_interface::OMPLPlannerManager::canServiceRequest ( const moveit_msgs::msg::MotionPlanRequest &  req) const
inlineoverridevirtual

Determine whether this plugin instance is able to represent this planning request.

Implements planning_interface::PlannerManager.

Definition at line 93 of file ompl_planner_manager.cpp.

◆ getDescription()

std::string ompl_interface::OMPLPlannerManager::getDescription ( ) const
inlineoverridevirtual

Get.

a short string that identifies the planning interface

Reimplemented from planning_interface::PlannerManager.

Definition at line 98 of file ompl_planner_manager.cpp.

◆ getPlanningAlgorithms()

void ompl_interface::OMPLPlannerManager::getPlanningAlgorithms ( std::vector< std::string > &  algs) const
inlineoverridevirtual

Get the names of the known planning algorithms (values that can be filled as planner_id in the planning request)

Reimplemented from planning_interface::PlannerManager.

Definition at line 103 of file ompl_planner_manager.cpp.

◆ getPlanningContext()

planning_interface::PlanningContextPtr ompl_interface::OMPLPlannerManager::getPlanningContext ( const planning_scene::PlanningSceneConstPtr &  planning_scene,
const planning_interface::MotionPlanRequest req,
moveit_msgs::msg::MoveItErrorCodes &  error_code 
) const
inlineoverridevirtual

Construct a planning context given the current scene and a planning request. If a problem is encountered, error code is set and empty ptr is returned. The returned motion planner context is clean – the motion planner will start from scratch every time a context is constructed.

Parameters
planning_sceneA const planning scene to use for planning
reqThe representation of the planning request
error_codeThis is where the error is set if constructing the planning context fails

Implements planning_interface::PlannerManager.

Definition at line 121 of file ompl_planner_manager.cpp.

◆ initialize()

bool ompl_interface::OMPLPlannerManager::initialize ( const moveit::core::RobotModelConstPtr &  model,
const rclcpp::Node::SharedPtr &  node,
const std::string &  parameter_namespace 
)
inlineoverridevirtual

Initialize a planner. This function will be called after the construction of the plugin, before any other call is made. It is assumed that motion plans will be computed for the robot described by model and that any exposed ROS functionality or required ROS parameters are namespaced by parameter_namespace

Reimplemented from planning_interface::PlannerManager.

Definition at line 85 of file ompl_planner_manager.cpp.

Here is the call graph for this function:

◆ setPlannerConfigurations()

void ompl_interface::OMPLPlannerManager::setPlannerConfigurations ( const planning_interface::PlannerConfigurationMap pcs)
inlineoverridevirtual

Specify the settings to be used for specific algorithms.

Implements planning_interface::PlannerManager.

Definition at line 112 of file ompl_planner_manager.cpp.

Here is the caller graph for this function:

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