Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
kdl_kinematics_plugin::KDLKinematicsPlugin Class Reference

Specific implementation of kinematics using KDL. This version can be used with any robot. More...

#include <kdl_kinematics_plugin.h>

Inheritance diagram for kdl_kinematics_plugin::KDLKinematicsPlugin:
Inheritance graph
[legend]

Public Member Functions

const std::vector< std::string > & getJointNames () const
 Return all the joint names in the order they are used internally. More...
 
const std::vector< std::string > & getLinkNames () const
 Return all the link names in the order they are represented internally. More...
 
virtual bool getPositionFK (const std::vector< std::string > &link_names, const std::vector< double > &joint_angles, std::vector< geometry_msgs::Pose > &poses) const
 
virtual bool getPositionIK (const geometry_msgs::Pose &ik_pose, const std::vector< double > &ik_seed_state, std::vector< double > &solution, moveit_msgs::MoveItErrorCodes &error_code, const kinematics::KinematicsQueryOptions &options=kinematics::KinematicsQueryOptions()) const
 
virtual bool initialize (const std::string &robot_description, const std::string &group_name, const std::string &base_name, const std::string &tip_name, double search_discretization)
 
 KDLKinematicsPlugin ()
 Default constructor. More...
 
virtual bool searchPositionIK (const geometry_msgs::Pose &ik_pose, const std::vector< double > &ik_seed_state, double timeout, std::vector< double > &solution, moveit_msgs::MoveItErrorCodes &error_code, const kinematics::KinematicsQueryOptions &options=kinematics::KinematicsQueryOptions()) const
 
virtual bool searchPositionIK (const geometry_msgs::Pose &ik_pose, const std::vector< double > &ik_seed_state, double timeout, const std::vector< double > &consistency_limits, std::vector< double > &solution, moveit_msgs::MoveItErrorCodes &error_code, const kinematics::KinematicsQueryOptions &options=kinematics::KinematicsQueryOptions()) const
 
virtual bool searchPositionIK (const geometry_msgs::Pose &ik_pose, const std::vector< double > &ik_seed_state, double timeout, std::vector< double > &solution, const IKCallbackFn &solution_callback, moveit_msgs::MoveItErrorCodes &error_code, const kinematics::KinematicsQueryOptions &options=kinematics::KinematicsQueryOptions()) const
 
virtual bool searchPositionIK (const geometry_msgs::Pose &ik_pose, const std::vector< double > &ik_seed_state, double timeout, const std::vector< double > &consistency_limits, std::vector< double > &solution, const IKCallbackFn &solution_callback, moveit_msgs::MoveItErrorCodes &error_code, const kinematics::KinematicsQueryOptions &options=kinematics::KinematicsQueryOptions()) const
 
- Public Member Functions inherited from kinematics::KinematicsBase
virtual const std::string & getBaseFrame () const
 
double getDefaultTimeout () const
 
virtual const std::string & getGroupName () const
 
virtual bool getPositionIK (const std::vector< geometry_msgs::Pose > &ik_poses, const std::vector< double > &ik_seed_state, std::vector< std::vector< double > > &solutions, KinematicsResult &result, const kinematics::KinematicsQueryOptions &options) const
 
virtual void getRedundantJoints (std::vector< unsigned int > &redundant_joint_indices) const
 
double getSearchDiscretization (int joint_index=0) const
 
std::vector< DiscretizationMethodgetSupportedDiscretizationMethods () const
 
virtual const std::string & getTipFrame () const
 
virtual const std::vector< std::string > & getTipFrames () const
 
virtual bool initialize (const std::string &robot_description, const std::string &group_name, const std::string &base_frame, const std::vector< std::string > &tip_frames, double search_discretization)
 
 KinematicsBase ()
 
virtual bool searchPositionIK (const std::vector< geometry_msgs::Pose > &ik_poses, const std::vector< double > &ik_seed_state, double timeout, const std::vector< double > &consistency_limits, std::vector< double > &solution, const IKCallbackFn &solution_callback, moveit_msgs::MoveItErrorCodes &error_code, const kinematics::KinematicsQueryOptions &options=kinematics::KinematicsQueryOptions(), const moveit::core::RobotState *context_state=NULL) const
 
void setDefaultTimeout (double timeout)
 
bool setRedundantJoints (const std::vector< std::string > &redundant_joint_names)
 
void setSearchDiscretization (const std::map< int, double > &discretization)
 
void setSearchDiscretization (double sd)
 
virtual void setValues (const std::string &robot_description, const std::string &group_name, const std::string &base_frame, const std::string &tip_frame, double search_discretization)
 
virtual void setValues (const std::string &robot_description, const std::string &group_name, const std::string &base_frame, const std::vector< std::string > &tip_frames, double search_discretization)
 
virtual bool supportsGroup (const moveit::core::JointModelGroup *jmg, std::string *error_text_out=NULL) const
 
virtual ~KinematicsBase ()
 

Protected Member Functions

bool searchPositionIK (const geometry_msgs::Pose &ik_pose, const std::vector< double > &ik_seed_state, double timeout, std::vector< double > &solution, const IKCallbackFn &solution_callback, moveit_msgs::MoveItErrorCodes &error_code, const std::vector< double > &consistency_limits, const kinematics::KinematicsQueryOptions &options=kinematics::KinematicsQueryOptions()) const
 Given a desired pose of the end-effector, search for the joint angles required to reach it. This particular method is intended for "searching" for a solutions by stepping through the redundancy (or other numerical routines). More...
 
virtual bool setRedundantJoints (const std::vector< unsigned int > &redundant_joint_indices)
 
- Protected Member Functions inherited from kinematics::KinematicsBase
bool lookupParam (const std::string &param, T &val, const T &default_val) const
 

Private Member Functions

bool checkConsistency (const KDL::JntArray &seed_state, const std::vector< double > &consistency_limit, const KDL::JntArray &solution) const
 Check whether the solution lies within the consistency limit of the seed state. More...
 
int getJointIndex (const std::string &name) const
 
int getKDLSegmentIndex (const std::string &name) const
 
void getRandomConfiguration (KDL::JntArray &jnt_array, bool lock_redundancy) const
 
void getRandomConfiguration (const KDL::JntArray &seed_state, const std::vector< double > &consistency_limits, KDL::JntArray &jnt_array, bool lock_redundancy) const
 Get a random configuration within joint limits close to the seed state. More...
 
bool isRedundantJoint (unsigned int index) const
 
bool timedOut (const ros::WallTime &start_time, double duration) const
 

Private Attributes

bool active_
 
unsigned int dimension_
 
double epsilon_
 
moveit_msgs::KinematicSolverInfo fk_chain_info_
 
moveit_msgs::KinematicSolverInfo ik_chain_info_
 
KDL::JntArray joint_max_
 
KDL::JntArray joint_min_
 
robot_model::JointModelGroup * joint_model_group_
 
KDL::Chain kdl_chain_
 
double max_solver_iterations_
 
std::vector< JointMimicmimic_joints_
 
int num_possible_redundant_joints_
 
bool position_ik_
 
random_numbers::RandomNumberGenerator random_number_generator_
 
std::vector< unsigned int > redundant_joints_map_index_
 
robot_model::RobotModelPtr robot_model_
 
robot_state::RobotStatePtr state_
 
robot_state::RobotStatePtr state_2_
 

Additional Inherited Members

- Public Types inherited from kinematics::KinematicsBase
typedef boost::function< void(const geometry_msgs::Pose &ik_pose, const std::vector< double > &ik_solution, moveit_msgs::MoveItErrorCodes &error_code)> IKCallbackFn
 
- Static Public Attributes inherited from kinematics::KinematicsBase
static const double DEFAULT_SEARCH_DISCRETIZATION
 
static const double DEFAULT_TIMEOUT
 
- Protected Attributes inherited from kinematics::KinematicsBase
std::string base_frame_
 
double default_timeout_
 
std::string group_name_
 
std::map< int, double > redundant_joint_discretization_
 
std::vector< unsigned int > redundant_joint_indices_
 
std::string robot_description_
 
double search_discretization_
 
std::vector< DiscretizationMethodsupported_methods_
 
std::string tip_frame_
 
std::vector< std::string > tip_frames_
 

Detailed Description

Specific implementation of kinematics using KDL. This version can be used with any robot.

Definition at line 70 of file kdl_kinematics_plugin.h.

Constructor & Destructor Documentation

kdl_kinematics_plugin::KDLKinematicsPlugin::KDLKinematicsPlugin ( )

Default constructor.

Definition at line 55 of file kdl_kinematics_plugin.cpp.

Member Function Documentation

bool kdl_kinematics_plugin::KDLKinematicsPlugin::checkConsistency ( const KDL::JntArray seed_state,
const std::vector< double > &  consistency_limit,
const KDL::JntArray solution 
) const
private

Check whether the solution lies within the consistency limit of the seed state.

Parameters
seed_stateSeed state
redundancyIndex of the redundant joint within the chain
consistency_limitThe returned state for redundant joint should be in the range [seed_state(redundancy_limit)-consistency_limit,seed_state(redundancy_limit)+consistency_limit]
solutionsolution configuration
Returns
true if check succeeds

Definition at line 118 of file kdl_kinematics_plugin.cpp.

int kdl_kinematics_plugin::KDLKinematicsPlugin::getJointIndex ( const std::string &  name) const
private

Definition at line 347 of file kdl_kinematics_plugin.cpp.

const std::vector< std::string > & kdl_kinematics_plugin::KDLKinematicsPlugin::getJointNames ( ) const
virtual

Return all the joint names in the order they are used internally.

Implements kinematics::KinematicsBase.

Definition at line 603 of file kdl_kinematics_plugin.cpp.

int kdl_kinematics_plugin::KDLKinematicsPlugin::getKDLSegmentIndex ( const std::string &  name) const
private

Definition at line 357 of file kdl_kinematics_plugin.cpp.

const std::vector< std::string > & kdl_kinematics_plugin::KDLKinematicsPlugin::getLinkNames ( ) const
virtual

Return all the link names in the order they are represented internally.

Implements kinematics::KinematicsBase.

Definition at line 608 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::getPositionFK ( const std::vector< std::string > &  link_names,
const std::vector< double > &  joint_angles,
std::vector< geometry_msgs::Pose > &  poses 
) const
virtual

Implements kinematics::KinematicsBase.

Definition at line 557 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::getPositionIK ( const geometry_msgs::Pose ik_pose,
const std::vector< double > &  ik_seed_state,
std::vector< double > &  solution,
moveit_msgs::MoveItErrorCodes &  error_code,
const kinematics::KinematicsQueryOptions options = kinematics::KinematicsQueryOptions() 
) const
virtual

Implements kinematics::KinematicsBase.

Definition at line 376 of file kdl_kinematics_plugin.cpp.

void kdl_kinematics_plugin::KDLKinematicsPlugin::getRandomConfiguration ( KDL::JntArray jnt_array,
bool  lock_redundancy 
) const
private

Definition at line 59 of file kdl_kinematics_plugin.cpp.

void kdl_kinematics_plugin::KDLKinematicsPlugin::getRandomConfiguration ( const KDL::JntArray seed_state,
const std::vector< double > &  consistency_limits,
KDL::JntArray jnt_array,
bool  lock_redundancy 
) const
private

Get a random configuration within joint limits close to the seed state.

Parameters
seed_stateSeed state
redundancyIndex of the redundant joint within the chain
consistency_limitThe returned state will contain a value for the redundant joint in the range [seed_state(redundancy_limit)-consistency_limit,seed_state(redundancy_limit)+consistency_limit]
jnt_arrayReturned random configuration

Definition at line 81 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::initialize ( const std::string &  robot_description,
const std::string &  group_name,
const std::string &  base_name,
const std::string &  tip_name,
double  search_discretization 
)
virtual

Implements kinematics::KinematicsBase.

Definition at line 128 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::isRedundantJoint ( unsigned int  index) const
private

Definition at line 73 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::searchPositionIK ( const geometry_msgs::Pose ik_pose,
const std::vector< double > &  ik_seed_state,
double  timeout,
std::vector< double > &  solution,
moveit_msgs::MoveItErrorCodes &  error_code,
const kinematics::KinematicsQueryOptions options = kinematics::KinematicsQueryOptions() 
) const
virtual

Implements kinematics::KinematicsBase.

Definition at line 387 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::searchPositionIK ( const geometry_msgs::Pose ik_pose,
const std::vector< double > &  ik_seed_state,
double  timeout,
const std::vector< double > &  consistency_limits,
std::vector< double > &  solution,
moveit_msgs::MoveItErrorCodes &  error_code,
const kinematics::KinematicsQueryOptions options = kinematics::KinematicsQueryOptions() 
) const
virtual

Implements kinematics::KinematicsBase.

Definition at line 399 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::searchPositionIK ( const geometry_msgs::Pose ik_pose,
const std::vector< double > &  ik_seed_state,
double  timeout,
std::vector< double > &  solution,
const IKCallbackFn solution_callback,
moveit_msgs::MoveItErrorCodes &  error_code,
const kinematics::KinematicsQueryOptions options = kinematics::KinematicsQueryOptions() 
) const
virtual

Implements kinematics::KinematicsBase.

Definition at line 409 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::searchPositionIK ( const geometry_msgs::Pose ik_pose,
const std::vector< double > &  ik_seed_state,
double  timeout,
const std::vector< double > &  consistency_limits,
std::vector< double > &  solution,
const IKCallbackFn solution_callback,
moveit_msgs::MoveItErrorCodes &  error_code,
const kinematics::KinematicsQueryOptions options = kinematics::KinematicsQueryOptions() 
) const
virtual

Implements kinematics::KinematicsBase.

Definition at line 420 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::searchPositionIK ( const geometry_msgs::Pose ik_pose,
const std::vector< double > &  ik_seed_state,
double  timeout,
std::vector< double > &  solution,
const IKCallbackFn solution_callback,
moveit_msgs::MoveItErrorCodes &  error_code,
const std::vector< double > &  consistency_limits,
const kinematics::KinematicsQueryOptions options = kinematics::KinematicsQueryOptions() 
) const
protected

Given a desired pose of the end-effector, search for the joint angles required to reach it. This particular method is intended for "searching" for a solutions by stepping through the redundancy (or other numerical routines).

Parameters
ik_posethe desired pose of the link
ik_seed_statean initial guess solution for the inverse kinematics
timeoutThe amount of time (in seconds) available to the solver
solutionthe solution vector
solution_callbackA callback solution for the IK solution
error_codean error code that encodes the reason for failure or success
check_consistencySet to true if consistency check needs to be performed
redundancyThe index of the redundant joint
consistency_limitThe returned solutuion will contain a value for the redundant joint in the range [seed_state(redundancy_limit)-consistency_limit,seed_state(redundancy_limit)+consistency_limit]
Returns
True if a valid solution was found, false otherwise

Definition at line 430 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::setRedundantJoints ( const std::vector< unsigned int > &  redundant_joint_indices)
protectedvirtual

Reimplemented from kinematics::KinematicsBase.

Definition at line 289 of file kdl_kinematics_plugin.cpp.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::timedOut ( const ros::WallTime start_time,
double  duration 
) const
private

Definition at line 371 of file kdl_kinematics_plugin.cpp.

Member Data Documentation

bool kdl_kinematics_plugin::KDLKinematicsPlugin::active_
private

Definition at line 177 of file kdl_kinematics_plugin.h.

unsigned int kdl_kinematics_plugin::KDLKinematicsPlugin::dimension_
private

Definition at line 185 of file kdl_kinematics_plugin.h.

double kdl_kinematics_plugin::KDLKinematicsPlugin::epsilon_
private

Definition at line 202 of file kdl_kinematics_plugin.h.

moveit_msgs::KinematicSolverInfo kdl_kinematics_plugin::KDLKinematicsPlugin::fk_chain_info_
private

Stores information for the inverse kinematics solver

Definition at line 181 of file kdl_kinematics_plugin.h.

moveit_msgs::KinematicSolverInfo kdl_kinematics_plugin::KDLKinematicsPlugin::ik_chain_info_
private

Internal variable that indicates whether solvers are configured and ready

Definition at line 179 of file kdl_kinematics_plugin.h.

KDL::JntArray kdl_kinematics_plugin::KDLKinematicsPlugin::joint_max_
private

Definition at line 187 of file kdl_kinematics_plugin.h.

KDL::JntArray kdl_kinematics_plugin::KDLKinematicsPlugin::joint_min_
private

Dimension of the group

Definition at line 187 of file kdl_kinematics_plugin.h.

robot_model::JointModelGroup* kdl_kinematics_plugin::KDLKinematicsPlugin::joint_model_group_
private

Definition at line 200 of file kdl_kinematics_plugin.h.

KDL::Chain kdl_kinematics_plugin::KDLKinematicsPlugin::kdl_chain_
private

Store information for the forward kinematics solver

Definition at line 183 of file kdl_kinematics_plugin.h.

double kdl_kinematics_plugin::KDLKinematicsPlugin::max_solver_iterations_
private

Definition at line 201 of file kdl_kinematics_plugin.h.

std::vector<JointMimic> kdl_kinematics_plugin::KDLKinematicsPlugin::mimic_joints_
private

Definition at line 203 of file kdl_kinematics_plugin.h.

int kdl_kinematics_plugin::KDLKinematicsPlugin::num_possible_redundant_joints_
private

Definition at line 195 of file kdl_kinematics_plugin.h.

bool kdl_kinematics_plugin::KDLKinematicsPlugin::position_ik_
private

Definition at line 199 of file kdl_kinematics_plugin.h.

random_numbers::RandomNumberGenerator kdl_kinematics_plugin::KDLKinematicsPlugin::random_number_generator_
mutableprivate

Joint limits

Definition at line 189 of file kdl_kinematics_plugin.h.

std::vector<unsigned int> kdl_kinematics_plugin::KDLKinematicsPlugin::redundant_joints_map_index_
private

Definition at line 196 of file kdl_kinematics_plugin.h.

robot_model::RobotModelPtr kdl_kinematics_plugin::KDLKinematicsPlugin::robot_model_
private

Definition at line 191 of file kdl_kinematics_plugin.h.

robot_state::RobotStatePtr kdl_kinematics_plugin::KDLKinematicsPlugin::state_
private

Definition at line 193 of file kdl_kinematics_plugin.h.

robot_state::RobotStatePtr kdl_kinematics_plugin::KDLKinematicsPlugin::state_2_
private

Definition at line 193 of file kdl_kinematics_plugin.h.


The documentation for this class was generated from the following files:


moveit_kinematics
Author(s): Dave Coleman , Ioan Sucan , Sachin Chitta
autogenerated on Mon Jan 15 2018 03:51:32