moveit2
The MoveIt Motion Planning Framework for ROS 2.
union_constraint_sampler.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011, Willow Garage, Inc.
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 Willow Garage 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 /* Author: Ioan Sucan */
36 
37 #pragma once
38 
40 #include <rclcpp/rclcpp.hpp>
41 
42 namespace constraint_samplers
43 {
58 {
59 public:
98  UnionConstraintSampler(const planning_scene::PlanningSceneConstPtr& scene, const std::string& group_name,
99  const std::vector<ConstraintSamplerPtr>& samplers);
100 
107  const std::vector<ConstraintSamplerPtr>& getSamplers() const
108  {
109  return samplers_;
110  }
111 
120  bool configure(const moveit_msgs::msg::Constraints& /*constr*/) override
121  {
122  return true;
123  }
124 
132  virtual bool canService(const moveit_msgs::msg::Constraints& /*constr*/) const
133  {
134  return true;
135  }
136 
152  bool sample(moveit::core::RobotState& state, const moveit::core::RobotState& reference_state,
153  unsigned int max_attempts) override;
154 
160  const std::string& getName() const override
161  {
162  static const std::string SAMPLER_NAME = "UnionConstraintSampler";
163  return SAMPLER_NAME;
164  }
165 
166 protected:
167  std::vector<ConstraintSamplerPtr> samplers_;
168 };
169 } // namespace constraint_samplers
ConstraintSampler is an abstract base class that allows the sampling of a kinematic state for a parti...
This class exists as a union of constraint samplers. It contains a vector of constraint samplers,...
const std::string & getName() const override
Get the name of the constraint sampler, for debugging purposes should be in CamelCase format.
bool configure(const moveit_msgs::msg::Constraints &) override
No-op, as the union constraint sampler is for already configured samplers.
virtual bool canService(const moveit_msgs::msg::Constraints &) const
No-op, as the union constraint sampler can act on anything.
bool sample(moveit::core::RobotState &state, const moveit::core::RobotState &reference_state, unsigned int max_attempts) override
Produces a sample from all configured samplers.
std::vector< ConstraintSamplerPtr > samplers_
Holder for sorted internal list of samplers.
const std::vector< ConstraintSamplerPtr > & getSamplers() const
Gets the sorted internal list of constraint samplers.
UnionConstraintSampler(const planning_scene::PlanningSceneConstPtr &scene, const std::string &group_name, const std::vector< ConstraintSamplerPtr > &samplers)
Constructor, which will re-order its internal list of samplers on construction.
Representation of a robot's state. This includes position, velocity, acceleration and effort.
Definition: robot_state.h:90
The constraint samplers namespace contains a number of methods for generating samples based on a cons...