kinematics_plugin_loader.h

Go to the documentation of this file.

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2012, Willow Garage, Inc.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of Willow Garage nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *********************************************************************/

/* Author: Ioan Sucan, Dave Coleman */

#ifndef MOVEIT_KINEMATICS_PLUGIN_LOADER_
#define MOVEIT_KINEMATICS_PLUGIN_LOADER_

#include <boost/function.hpp>
#include <boost/shared_ptr.hpp>
#include <moveit/robot_model/robot_model.h>
#include <moveit/kinematics_base/kinematics_base.h>

namespace kinematics_plugin_loader
{

class KinematicsPluginLoader
{
public:

  KinematicsPluginLoader(const std::string &robot_description = "robot_description",
                         double default_search_resolution = 0.0) :
    robot_description_(robot_description),
    default_search_resolution_(default_search_resolution)
  {
  }

  KinematicsPluginLoader(const std::string &solver_plugin, double solve_timeout, unsigned int ik_attempts,
                         const std::string &robot_description = "robot_description",
                         double default_search_resolution = 0.0) :
    robot_description_(robot_description),
    default_search_resolution_(default_search_resolution),
    default_solver_plugin_(solver_plugin),
    default_solver_timeout_(solve_timeout),
    default_ik_attempts_(ik_attempts)
  {
  }

  robot_model::SolverAllocatorFn getLoaderFunction();

  robot_model::SolverAllocatorFn getLoaderFunction(const boost::shared_ptr<srdf::Model> &srdf_model);

  const std::vector<std::string>& getKnownGroups() const
  {
    return groups_;
  }

  const std::map<std::string, double>& getIKTimeout() const
  {
    return ik_timeout_;
  }

  const std::map<std::string, unsigned int>& getIKAttempts() const
  {
    return ik_attempts_;
  }

  void status() const;

private:

  std::string robot_description_;
  double default_search_resolution_;

  class KinematicsLoaderImpl;
  boost::shared_ptr<KinematicsLoaderImpl> loader_;

  std::vector<std::string> groups_;
  std::map<std::string, double> ik_timeout_;
  std::map<std::string, unsigned int> ik_attempts_;

  // default configuration
  std::string default_solver_plugin_;
  double default_solver_timeout_;
  unsigned int default_ik_attempts_;
};

typedef boost::shared_ptr<KinematicsPluginLoader> KinematicsPluginLoaderPtr;
typedef boost::shared_ptr<const KinematicsPluginLoader> KinematicsPluginLoaderConstPtr;

}

#endif