kdl_arm_kinematics_plugin.h

Go to the documentation of this file.

/*********************************************************************
*
* Software License Agreement (BSD License)
*
*  Copyright (c) 2008, 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 the 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: Sachin Chitta
*********************************************************************/

#ifndef KDL_ARM_KINEMATICS_PLUGIN_H_
#define KDL_ARM_KINEMATICS_PLUGIN_H_

// ROS
#include <ros/ros.h>
#include <tf/tf.h>
#include <tf/transform_datatypes.h>
#include <tf_conversions/tf_kdl.h>

// System
#include <boost/shared_ptr.hpp>
#include <algorithm>
#include <numeric>
#include <cstring>

// ROS msgs
#include <geometry_msgs/PoseStamped.h>
#include <kinematics_msgs/GetPositionFK.h>
#include <kinematics_msgs/GetPositionIK.h>
#include <kinematics_msgs/GetKinematicSolverInfo.h>
#include <arm_navigation_msgs/ArmNavigationErrorCodes.h>

// Plugin
#include <kinematics_base/kinematics_base.h>

// KDL
#include <kdl/jntarray.hpp>
#include <kdl_parser/kdl_parser.hpp>
#include <kdl/chainiksolverpos_nr_jl.hpp>
#include <kdl/chainiksolvervel_pinv.hpp>
#include <kdl/chainfksolverpos_recursive.hpp>

// MISC
#include <angles/angles.h>
#include <urdf/model.h>

namespace arm_kinematics_constraint_aware
{
class KDLArmKinematicsPlugin : public kinematics::KinematicsBase
  {
    public:

    KDLArmKinematicsPlugin();

    bool isActive();

    bool getPositionIK(const geometry_msgs::Pose &ik_pose,
                       const std::vector<double> &ik_seed_state,
                       std::vector<double> &solution,
                       int &error_code);      
    
    bool searchPositionIK(const geometry_msgs::Pose &ik_pose,
                          const std::vector<double> &ik_seed_state,
                          const double &timeout,
                          std::vector<double> &solution,
                          int &error_code);      
    
    virtual bool searchPositionIK(const geometry_msgs::Pose &ik_pose,
                                  const std::vector<double> &ik_seed_state,
                                  const double &timeout,
                                  const unsigned int& redundancy,
                                  const double &consistency_limit,
                                  std::vector<double> &solution,
                                  int &error_code);      
    
    bool searchPositionIK(const geometry_msgs::Pose &ik_pose,
                          const std::vector<double> &ik_seed_state,
                          const double &timeout,
                          std::vector<double> &solution,
                          const boost::function<void(const geometry_msgs::Pose &ik_pose,const std::vector<double> &ik_solution,int &error_code)> &desired_pose_callback,
                          const boost::function<void(const geometry_msgs::Pose &ik_pose,const std::vector<double> &ik_solution,int &error_code)> &solution_callback,
                          int &error_code);    

       virtual bool searchPositionIK(const geometry_msgs::Pose &ik_pose,
                                     const std::vector<double> &ik_seed_state,
                                     const double &timeout,
                                     const unsigned int& redundancy,
                                     const double &consistency_limit,
                                     std::vector<double> &solution,
                                     const boost::function<void(const geometry_msgs::Pose &ik_pose,const std::vector<double> &ik_solution,int &error_code)> &desired_pose_callback,
                                     const boost::function<void(const geometry_msgs::Pose &ik_pose,const std::vector<double> &ik_solution,int &error_code)> &solution_callback,
                                     int &error_code);      

    bool getPositionFK(const std::vector<std::string> &link_names,
                       const std::vector<double> &joint_angles, 
                       std::vector<geometry_msgs::Pose> &poses);
    
    bool initialize(const std::string& group_name,
                    const std::string& base_name,
                    const std::string& tip_name,
                    const double& search_discretization = .01);
    const std::vector<std::string>& getJointNames() const;
    
    const std::vector<std::string>& getLinkNames() const;
    
    protected:

    bool loadModel(const std::string xml);
    bool readJoints(urdf::Model &robot_model);
    int getJointIndex(const std::string &name);
    int getKDLSegmentIndex(const std::string &name);
    double genRandomNumber(const double &min, const double &max);
    KDL::JntArray getRandomConfiguration();
    KDL::JntArray getRandomConfiguration(const KDL::JntArray& seed_state,
                                         const unsigned int& redundancy,
                                         const double& consistency_limit);

    bool checkConsistency(const KDL::JntArray& seed_state,
                          const unsigned int& redundancy,
                          const double& consistency_limit, 
                          const KDL::JntArray& solution) const;

    int max_search_iterations_;

    bool active_;
    kinematics_msgs::KinematicSolverInfo chain_info_;

    boost::shared_ptr<KDL::ChainIkSolverVel_pinv> ik_solver_vel_;
    boost::shared_ptr<KDL::ChainFkSolverPos_recursive> fk_solver_;
    boost::shared_ptr<KDL::ChainIkSolverPos_NR_JL> ik_solver_pos_;

    unsigned int dimension_;
    KDL::Chain kdl_chain_;
    KDL::JntArray joint_min_, joint_max_;

    /*
      boost::function<void(const geometry_msgs::Pose &ik_pose,const std::vector<double> &ik_solution,int &error_code)> solutionCallback_;    
      boost::function<void(const geometry_msgs::Pose &ik_pose,const std::vector<double> &ik_solution,int &error_code)> desiredPoseCallback_;
      
      void desiredPoseCallback(const KDL::JntArray& jnt_array, 
      const KDL::Frame& ik_pose,
      arm_navigation_msgs::ArmNavigationErrorCodes& error_code);
      
      void jointSolutionCallback(const KDL::JntArray& jnt_array, 
      const KDL::Frame& ik_pose,
      arm_navigation_msgs::ArmNavigationErrorCodes& error_code);
    */
  };
}

#endif