moveit2
The MoveIt Motion Planning Framework for ROS 2.
kinematics_plugin_loader.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2012, 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, Dave Coleman */
36 
37 #pragma once
38 
42 #include <kinematics_parameters.hpp>
43 #include <moveit/utils/logger.hpp>
44 
46 {
47 MOVEIT_CLASS_FORWARD(KinematicsPluginLoader); // Defines KinematicsPluginLoaderPtr, ConstPtr, WeakPtr... etc
48 
51 {
52 public:
58  KinematicsPluginLoader(const rclcpp::Node::SharedPtr& node,
59  const std::string& robot_description = "robot_description")
60  : node_(node), robot_description_(robot_description), logger_(moveit::getLogger("kinematics_plugin_loader"))
61  {
62  }
63 
66  moveit::core::SolverAllocatorFn getLoaderFunction(const srdf::ModelSharedPtr& srdf_model);
67 
69  const std::vector<std::string>& getKnownGroups() const
70  {
71  return groups_;
72  }
73 
75  const std::map<std::string, double>& getIKTimeout() const
76  {
77  return ik_timeout_;
78  }
79 
80  void status() const;
81 
82 private:
83  const rclcpp::Node::SharedPtr node_;
84  std::unordered_map<std::string, std::shared_ptr<kinematics::ParamListener>> group_param_listener_;
85  std::unordered_map<std::string, kinematics::Params> group_params_;
86  std::string robot_description_;
87 
88  MOVEIT_CLASS_FORWARD(KinematicsLoaderImpl); // Defines KinematicsLoaderImplPtr, ConstPtr, WeakPtr... etc
89  KinematicsLoaderImplPtr loader_;
90 
91  std::vector<std::string> groups_;
92  std::map<std::string, double> ik_timeout_;
93  rclcpp::Logger logger_;
94 };
95 } // namespace kinematics_plugin_loader
Helper class for loading kinematics solvers.
const std::map< std::string, double > & getIKTimeout() const
Get a map from group name to default IK timeout.
moveit::core::SolverAllocatorFn getLoaderFunction(const srdf::ModelSharedPtr &srdf_model)
Get a function pointer that allocates and initializes a kinematics solver. If not previously called,...
KinematicsPluginLoader(const rclcpp::Node::SharedPtr &node, const std::string &robot_description="robot_description")
Load the kinematics solvers based on information on the ROS parameter server. Take node as an argumen...
const std::vector< std::string > & getKnownGroups() const
Get the groups for which the function pointer returned by getLoaderFunction() can allocate a solver.
MOVEIT_CLASS_FORWARD(KinematicsPluginLoader)
std::function< kinematics::KinematicsBasePtr(const JointModelGroup *)> SolverAllocatorFn
Function type that allocates a kinematics solver for a particular group.
Main namespace for MoveIt.
Definition: exceptions.h:43