v2/kinematics_cache/include/moveit/kinematics_cache/kinematics_cache.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, Inc. 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: Sachin Chitta
*********************************************************************/

#ifndef KINEMATICS_CACHE_H_
#define KINEMATICS_CACHE_H_

#include <moveit/kinematics_base/kinematics_base.h>
#include <moveit/robot_model/robot_model.h>
#include <moveit/robot_state/robot_state.h>

#include <boost/shared_ptr.hpp>

namespace kinematics_cache
{
class KinematicsCache
{
public:
  struct Options
  {
    geometry_msgs::Point origin;
    boost::array<double, 3> workspace_size;
    boost::array<double, 3> resolution;
    unsigned int max_solutions_per_grid_location;
  };

  KinematicsCache();

  bool generateCacheMap(double timeout);

  bool getSolution(const geometry_msgs::Pose& pose, unsigned int solution_index, std::vector<double>& solution) const;

  bool getSolutions(const geometry_msgs::Pose& pose, std::vector<std::vector<double> >& solutions) const;

  bool getNumSolutions(const geometry_msgs::Pose& pose, unsigned int& num_solutions) const;

  bool initialize(kinematics::KinematicsBaseConstPtr& solver, const robot_model::RobotModelConstPtr& kinematic_model,
                  const KinematicsCache::Options& opt);

  const kinematics::KinematicsBaseConstPtr& getSolverInstance() const
  {
    return kinematics_solver_;
  }

  const robot_model::RobotModelConstPtr& getModelInstance() const
  {
    return kinematic_model_;
  }

  const Options& getCacheParameters() const
  {
    return options_;
  }

  const std::string& getGroupName() const
  {
    return kinematics_solver_->getGroupName();
  }

  bool addToCache(const geometry_msgs::Pose& pose, const std::vector<double>& joint_values, bool overwrite = false);

  bool writeToFile(const std::string& filename);

  bool readFromFile(const std::string& filename);

  std::pair<double, double> getMinMaxSquaredDistance();

private:
  unsigned int getSolutionLocation(unsigned int& grid_index, unsigned int& solution_index) const;

  std::vector<double> getSolution(unsigned int grid_index, unsigned int solution_index) const;

  bool getGridIndex(const geometry_msgs::Pose& pose, unsigned int& grid_index) const;

  void setup(const KinematicsCache::Options& opt);

  void updateDistances(const geometry_msgs::Pose& pose);

  KinematicsCache::Options options_;                                    
  geometry_msgs::Point cache_origin_;                                   
  double cache_resolution_x_, cache_resolution_y_, cache_resolution_z_; 
  unsigned int cache_size_x_, cache_size_y_, cache_size_z_;             
  unsigned int max_solutions_per_grid_location_;                        
  unsigned int solution_dimension_;                                     
  unsigned int size_grid_node_; 
  unsigned int kinematics_cache_points_with_solution_; 
  unsigned int kinematics_cache_size_;                 
  std::vector<double> kinematics_cache_vector_;    
  std::vector<unsigned int> num_solutions_vector_; 
  kinematics::KinematicsBaseConstPtr kinematics_solver_; 
  robot_model::RobotModelConstPtr kinematic_model_; 
  robot_state::RobotStatePtr kinematic_state_;      
  const robot_model::JointModelGroup* joint_model_group_; 
  boost::shared_ptr<robot_state::JointStateGroup> joint_state_group_; 
  //    mutable std::vector<double> solution_local_; /** Local pre-allocated storage */

  double min_squared_distance_, max_squared_distance_;
};

typedef boost::shared_ptr<KinematicsCache> KinematicsCachePtr;
}

#endif