moveit2
The MoveIt Motion Planning Framework for ROS 2.
planning_context_loader.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2018 Pilz GmbH & Co. KG
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of Pilz GmbH & Co. KG nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *********************************************************************/
34 
35 #pragma once
36 
38 
39 #include <memory>
40 #include <vector>
41 
43 
45 
47 {
55 {
56 public:
58  virtual ~PlanningContextLoader();
59 
61  virtual std::string getAlgorithm() const;
62 
68  virtual bool setModel(const moveit::core::RobotModelConstPtr& model);
69 
77 
85  virtual bool loadContext(planning_interface::PlanningContextPtr& planning_context, const std::string& name,
86  const std::string& group) const = 0;
87 
88 protected:
96  template <typename T>
97  bool loadContext(planning_interface::PlanningContextPtr& planning_context, const std::string& name,
98  const std::string& group) const;
99 
100 protected:
102  std::string alg_;
103 
106 
109 
112 
114  moveit::core::RobotModelConstPtr model_;
115 };
116 
117 typedef std::shared_ptr<PlanningContextLoader> PlanningContextLoaderPtr;
118 typedef std::shared_ptr<const PlanningContextLoader> PlanningContextLoaderConstPtr;
119 
120 template <typename T>
121 bool PlanningContextLoader::loadContext(planning_interface::PlanningContextPtr& planning_context,
122  const std::string& name, const std::string& group) const
123 {
124  if (limits_set_ && model_set_)
125  {
126  planning_context = std::make_shared<T>(name, group, model_, limits_);
127  return true;
128  }
129  else
130  {
131  if (!limits_set_)
132  {
133  RCLCPP_ERROR(rclcpp::get_logger("planning_context_loader"),
134  "Limits are not defined. Cannot load planning context. Call setLimits loadContext");
135  }
136  if (!model_set_)
137  {
138  RCLCPP_ERROR(rclcpp::get_logger("planning_context_loader"), "Robot model was not set");
139  }
140  return false;
141  }
142 }
143 
144 } // namespace pilz_industrial_motion_planner
This class combines CartesianLimit and JointLimits into on single class.
Base class for all PlanningContextLoaders. Since planning_interface::PlanningContext has a non empty ...
virtual bool setLimits(const pilz_industrial_motion_planner::LimitsContainer &limits)
Sets limits the planner can pass to the contexts.
virtual std::string getAlgorithm() const
Return the algorithm the loader uses.
virtual bool loadContext(planning_interface::PlanningContextPtr &planning_context, const std::string &name, const std::string &group) const =0
Return the planning context.
pilz_industrial_motion_planner::LimitsContainer limits_
Limits to be used during planning.
virtual bool setModel(const moveit::core::RobotModelConstPtr &model)
Sets the robot model that can be passed to the planning context.
moveit::core::RobotModelConstPtr model_
The robot model.
std::shared_ptr< PlanningContextLoader > PlanningContextLoaderPtr
std::shared_ptr< const PlanningContextLoader > PlanningContextLoaderConstPtr
name
Definition: setup.py:7