Classes | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
moveit::planning_interface::MoveGroupInterface Class Reference

Client class to conveniently use the ROS interfaces provided by the move_group node. More...

#include <moveit/planning_interface/move_group_interface.h>

Inheritance diagram for moveit::planning_interface::MoveGroupInterface:
Inheritance graph
[legend]

Classes

class  MoveGroupInterfaceImpl
 
struct  Options
 Specification of options to use when constructing the MoveGroupInterface class. More...
 
struct  Plan
 The representation of a motion plan (as ROS messasges) More...
 

Public Member Functions

const std::vector< std::string > & getActiveJoints () const
 Get only the active (actuated) joints this instance operates on. More...
 
std::string getDefaultPlannerId (const std::string &group="") const
 Get the default planner for a given group (or global default) More...
 
double getGoalJointTolerance () const
 Get the tolerance that is used for reaching a joint goal. This is distance for each joint in configuration space. More...
 
double getGoalOrientationTolerance () const
 Get the tolerance that is used for reaching an orientation goal. This is the tolerance for roll, pitch and yaw, in radians. More...
 
double getGoalPositionTolerance () const
 Get the tolerance that is used for reaching a position goal. This is be the radius of a sphere where the end-effector must reach. More...
 
bool getInterfaceDescription (moveit_msgs::PlannerInterfaceDescription &desc)
 Get the description of the planning plugin loaded by the action server. More...
 
const std::vector< std::string > & getJointNames ()
 Get vector of names of joints available in move group. More...
 
const std::vector< std::string > & getJoints () const
 Get all the joints this instance operates on (including fixed joints) More...
 
const std::vector< std::string > & getLinkNames ()
 Get vector of names of links available in move group. More...
 
const std::string & getName () const
 Get the name of the group this instance operates on. More...
 
const std::vector< std::string > getNamedTargets ()
 Get the names of the named robot states available as targets, both either remembered states or default states from srdf. More...
 
std::map< std::string, double > getNamedTargetValues (const std::string &name)
 Get the joint angles for targets specified by name. More...
 
const ros::NodeHandlegetNodeHandle () const
 Get the ROS node handle of this instance operates on. More...
 
std::map< std::string, std::string > getPlannerParams (const std::string &planner_id, const std::string &group="")
 Get the planner parameters for given group and planner_id. More...
 
const std::string & getPlanningFrame () const
 Get the name of the frame in which the robot is planning. More...
 
double getPlanningTime () const
 Get the number of seconds set by setPlanningTime() More...
 
robot_model::RobotModelConstPtr getRobotModel () const
 Get the RobotModel object. More...
 
unsigned int getVariableCount () const
 Get the number of variables used to describe the state of this group. This is larger or equal to the number of DOF. More...
 
 MoveGroupInterface (const Options &opt, const boost::shared_ptr< tf::Transformer > &tf=boost::shared_ptr< tf::Transformer >(), const ros::WallDuration &wait_for_servers=ros::WallDuration())
 Construct a MoveGroupInterface instance call using a specified set of options opt. More...
 
MOVEIT_DEPRECATED MoveGroupInterface (const Options &opt, const boost::shared_ptr< tf::Transformer > &tf, const ros::Duration &wait_for_servers)
 
 MoveGroupInterface (const std::string &group, const boost::shared_ptr< tf::Transformer > &tf=boost::shared_ptr< tf::Transformer >(), const ros::WallDuration &wait_for_servers=ros::WallDuration())
 Construct a client for the MoveGroup action for a particular group. More...
 
MOVEIT_DEPRECATED MoveGroupInterface (const std::string &group, const boost::shared_ptr< tf::Transformer > &tf, const ros::Duration &wait_for_servers)
 
 MOVEIT_STRUCT_FORWARD (Plan)
 
void setGoalJointTolerance (double tolerance)
 Set the joint tolerance (for each joint) that is used for reaching the goal when moving to a joint value target. More...
 
void setGoalOrientationTolerance (double tolerance)
 Set the orientation tolerance that is used for reaching the goal when moving to a pose. More...
 
void setGoalPositionTolerance (double tolerance)
 Set the position tolerance that is used for reaching the goal when moving to a pose. More...
 
void setGoalTolerance (double tolerance)
 Set the tolerance that is used for reaching the goal. For joint state goals, this will be distance for each joint, in the configuration space (radians or meters depending on joint type). For pose goals this will be the radius of a sphere where the end-effector must reach. This function simply triggers calls to setGoalPositionTolerance(), setGoalOrientationTolerance() and setGoalJointTolerance(). More...
 
void setMaxAccelerationScalingFactor (double max_acceleration_scaling_factor)
 Set a scaling factor for optionally reducing the maximum joint acceleration. Allowed values are in (0,1]. The maximum joint acceleration specified in the robot model is multiplied by the factor. If outside valid range (imporantly, this includes it being set to 0.0), the factor is set to a default value of 1.0 internally (i.e. maximum joint acceleration) More...
 
void setMaxVelocityScalingFactor (double max_velocity_scaling_factor)
 Set a scaling factor for optionally reducing the maximum joint velocity. Allowed values are in (0,1]. The maximum joint velocity specified in the robot model is multiplied by the factor. If outside valid range (imporantly, this includes it being set to 0.0), the factor is set to a default value of 1.0 internally (i.e. maximum joint velocity) More...
 
void setNumPlanningAttempts (unsigned int num_planning_attempts)
 Set the number of times the motion plan is to be computed from scratch before the shortest solution is returned. The default value is 1. More...
 
void setPlannerId (const std::string &planner_id)
 Specify a planner to be used for further planning. More...
 
void setPlannerParams (const std::string &planner_id, const std::string &group, const std::map< std::string, std::string > &params, bool bReplace=false)
 Set the planner parameters for given group and planner_id. More...
 
void setPlanningTime (double seconds)
 Specify the maximum amount of time to use when planning. More...
 
void setStartState (const moveit_msgs::RobotState &start_state)
 If a different start state should be considered instead of the current state of the robot, this function sets that state. More...
 
void setStartState (const robot_state::RobotState &start_state)
 If a different start state should be considered instead of the current state of the robot, this function sets that state. More...
 
void setStartStateToCurrentState ()
 Set the starting state for planning to be that reported by the robot's joint state publication. More...
 
void setSupportSurfaceName (const std::string &name)
 For pick/place operations, the name of the support surface is used to specify the fact that attached objects are allowed to touch the support surface. More...
 
void setWorkspace (double minx, double miny, double minz, double maxx, double maxy, double maxz)
 Specify the workspace bounding box. The box is specified in the planning frame (i.e. relative to the robot root link start position). This is useful when the planning group contains the root joint of the robot – i.e. when planning motion for the robot relative to the world. More...
 
 ~MoveGroupInterface ()
 
Setting a joint state target (goal)

There are 2 types of goal targets:

  • a JointValueTarget (aka JointStateTarget) specifies an absolute value for each joint (angle for rotational joints or position for prismatic joints).
  • a PoseTarget (Position, Orientation, or Pose) specifies the pose of one or more end effectors (and the planner can use any joint values that reaches the pose(s)).

Only one or the other is used for planning. Calling any of the set*JointValueTarget() functions sets the current goal target to the JointValueTarget. Calling any of the setPoseTarget(), setOrientationTarget(), setRPYTarget(), setPositionTarget() functions sets the current goal target to the Pose target.

bool setJointValueTarget (const std::vector< double > &group_variable_values)
 Set the JointValueTarget and use it for future planning requests. More...
 
bool setJointValueTarget (const std::map< std::string, double > &variable_values)
 Set the JointValueTarget and use it for future planning requests. More...
 
bool setJointValueTarget (const robot_state::RobotState &robot_state)
 Set the JointValueTarget and use it for future planning requests. More...
 
bool setJointValueTarget (const std::string &joint_name, const std::vector< double > &values)
 Set the JointValueTarget and use it for future planning requests. More...
 
bool setJointValueTarget (const std::string &joint_name, double value)
 Set the JointValueTarget and use it for future planning requests. More...
 
bool setJointValueTarget (const sensor_msgs::JointState &state)
 Set the JointValueTarget and use it for future planning requests. More...
 
bool setJointValueTarget (const geometry_msgs::Pose &eef_pose, const std::string &end_effector_link="")
 Set the joint state goal for a particular joint by computing IK. More...
 
bool setJointValueTarget (const geometry_msgs::PoseStamped &eef_pose, const std::string &end_effector_link="")
 Set the joint state goal for a particular joint by computing IK. More...
 
bool setJointValueTarget (const Eigen::Affine3d &eef_pose, const std::string &end_effector_link="")
 Set the joint state goal for a particular joint by computing IK. More...
 
bool setApproximateJointValueTarget (const geometry_msgs::Pose &eef_pose, const std::string &end_effector_link="")
 Set the joint state goal for a particular joint by computing IK. More...
 
bool setApproximateJointValueTarget (const geometry_msgs::PoseStamped &eef_pose, const std::string &end_effector_link="")
 Set the joint state goal for a particular joint by computing IK. More...
 
bool setApproximateJointValueTarget (const Eigen::Affine3d &eef_pose, const std::string &end_effector_link="")
 Set the joint state goal for a particular joint by computing IK. More...
 
void setRandomTarget ()
 Set the joint state goal to a random joint configuration. More...
 
bool setNamedTarget (const std::string &name)
 Set the current joint values to be ones previously remembered by rememberJointValues() or, if not found, that are specified in the SRDF under the name name as a group state. More...
 
const robot_state::RobotState & getJointValueTarget () const
 Get the currently set joint state goal. More...
 
Setting a pose target (goal)

Setting a Pose (or Position or Orientation) target disables any previously set JointValueTarget.

For groups that have multiple end effectors, a pose can be set for each end effector in the group. End effectors which do not have a pose target set will end up in arbitrary positions.

bool setPositionTarget (double x, double y, double z, const std::string &end_effector_link="")
 Set the goal position of the end-effector end_effector_link to be (x, y, z). More...
 
bool setRPYTarget (double roll, double pitch, double yaw, const std::string &end_effector_link="")
 Set the goal orientation of the end-effector end_effector_link to be (roll,pitch,yaw) radians. More...
 
bool setOrientationTarget (double x, double y, double z, double w, const std::string &end_effector_link="")
 Set the goal orientation of the end-effector end_effector_link to be the quaternion (x,y,z,w). More...
 
bool setPoseTarget (const Eigen::Affine3d &end_effector_pose, const std::string &end_effector_link="")
 Set the goal pose of the end-effector end_effector_link. More...
 
bool setPoseTarget (const geometry_msgs::Pose &target, const std::string &end_effector_link="")
 Set the goal pose of the end-effector end_effector_link. More...
 
bool setPoseTarget (const geometry_msgs::PoseStamped &target, const std::string &end_effector_link="")
 Set the goal pose of the end-effector end_effector_link. More...
 
bool setPoseTargets (const EigenSTL::vector_Affine3d &end_effector_pose, const std::string &end_effector_link="")
 Set goal poses for end_effector_link. More...
 
bool setPoseTargets (const std::vector< geometry_msgs::Pose > &target, const std::string &end_effector_link="")
 Set goal poses for end_effector_link. More...
 
bool setPoseTargets (const std::vector< geometry_msgs::PoseStamped > &target, const std::string &end_effector_link="")
 Set goal poses for end_effector_link. More...
 
void setPoseReferenceFrame (const std::string &pose_reference_frame)
 Specify which reference frame to assume for poses specified without a reference frame. More...
 
bool setEndEffectorLink (const std::string &end_effector_link)
 Specify the parent link of the end-effector. This end_effector_link will be used in calls to pose target functions when end_effector_link is not explicitly specified. More...
 
bool setEndEffector (const std::string &eef_name)
 Specify the name of the end-effector to use. This is equivalent to setting the EndEffectorLink to the parent link of this end effector. More...
 
void clearPoseTarget (const std::string &end_effector_link="")
 Forget pose(s) specified for end_effector_link. More...
 
void clearPoseTargets ()
 Forget any poses specified for all end-effectors. More...
 
const geometry_msgs::PoseStamped & getPoseTarget (const std::string &end_effector_link="") const
 
const std::vector< geometry_msgs::PoseStamped > & getPoseTargets (const std::string &end_effector_link="") const
 
const std::string & getEndEffectorLink () const
 Get the current end-effector link. This returns the value set by setEndEffectorLink() (or indirectly by setEndEffector()). If setEndEffectorLink() was not called, this function reports the link name that serves as parent of an end-effector attached to this group. If there are multiple end-effectors, one of them is returned. If no such link is known, the empty string is returned. More...
 
const std::string & getEndEffector () const
 Get the current end-effector name. This returns the value set by setEndEffector() (or indirectly by setEndEffectorLink()). If setEndEffector() was not called, this function reports an end-effector attached to this group. If there are multiple end-effectors, one of them is returned. If no end-effector is known, the empty string is returned. More...
 
const std::string & getPoseReferenceFrame () const
 Get the reference frame set by setPoseReferenceFrame(). By default this is the reference frame of the robot model. More...
 
Planning a path from the start position to the Target (goal) position, and executing that plan.
MoveItErrorCode asyncMove ()
 Plan and execute a trajectory that takes the group of joints declared in the constructor to the specified target. This call is not blocking (does not wait for the execution of the trajectory to complete). More...
 
MoveItErrorCode move ()
 Plan and execute a trajectory that takes the group of joints declared in the constructor to the specified target. This call is always blocking (waits for the execution of the trajectory to complete) and requires an asynchronous spinner to be started. More...
 
MoveItErrorCode plan (Plan &plan)
 Compute a motion plan that takes the group declared in the constructor from the current state to the specified target. No execution is performed. The resulting plan is stored in plan. More...
 
MoveItErrorCode asyncExecute (const Plan &plan)
 Given a plan, execute it without waiting for completion. Return true on success. More...
 
MoveItErrorCode execute (const Plan &plan)
 Given a plan, execute it while waiting for completion. Return true on success. More...
 
double computeCartesianPath (const std::vector< geometry_msgs::Pose > &waypoints, double eef_step, double jump_threshold, moveit_msgs::RobotTrajectory &trajectory, bool avoid_collisions=true, moveit_msgs::MoveItErrorCodes *error_code=NULL)
 Compute a Cartesian path that follows specified waypoints with a step size of at most eef_step meters between end effector configurations of consecutive points in the result trajectory. The reference frame for the waypoints is that specified by setPoseReferenceFrame(). No more than jump_threshold is allowed as change in distance in the configuration space of the robot (this is to prevent 'jumps' in IK solutions). Collisions are avoided if avoid_collisions is set to true. If collisions cannot be avoided, the function fails. Return a value that is between 0.0 and 1.0 indicating the fraction of the path achieved as described by the waypoints. Return -1.0 in case of error. More...
 
double computeCartesianPath (const std::vector< geometry_msgs::Pose > &waypoints, double eef_step, double jump_threshold, moveit_msgs::RobotTrajectory &trajectory, const moveit_msgs::Constraints &path_constraints, bool avoid_collisions=true, moveit_msgs::MoveItErrorCodes *error_code=NULL)
 Compute a Cartesian path that follows specified waypoints with a step size of at most eef_step meters between end effector configurations of consecutive points in the result trajectory. The reference frame for the waypoints is that specified by setPoseReferenceFrame(). No more than jump_threshold is allowed as change in distance in the configuration space of the robot (this is to prevent 'jumps' in IK solutions). Kinematic constraints for the path given by path_constraints will be met for every point along the trajectory, if they are not met, a partial solution will be returned. Constraints are checked (collision and kinematic) if avoid_collisions is set to true. If constraints cannot be met, the function fails. Return a value that is between 0.0 and 1.0 indicating the fraction of the path achieved as described by the waypoints. Return -1.0 in case of error. More...
 
void stop ()
 Stop any trajectory execution, if one is active. More...
 
void allowLooking (bool flag)
 Specify whether the robot is allowed to look around before moving if it determines it should (default is true) More...
 
void allowReplanning (bool flag)
 Specify whether the robot is allowed to replan if it detects changes in the environment. More...
 
void constructMotionPlanRequest (moveit_msgs::MotionPlanRequest &request)
 Build the MotionPlanRequest that would be sent to the move_group action with plan() or move() and store it in request. More...
 
High level actions that trigger a sequence of plans and actions.
MoveItErrorCode pick (const std::string &object)
 Pick up an object. More...
 
MoveItErrorCode pick (const std::string &object, const moveit_msgs::Grasp &grasp)
 Pick up an object given a grasp pose. More...
 
MoveItErrorCode pick (const std::string &object, const std::vector< moveit_msgs::Grasp > &grasps)
 Pick up an object given possible grasp poses. More...
 
MoveItErrorCode planGraspsAndPick (const std::string &object="")
 Pick up an object. More...
 
MoveItErrorCode planGraspsAndPick (const moveit_msgs::CollisionObject &object)
 Pick up an object. More...
 
MoveItErrorCode place (const std::string &object)
 Place an object somewhere safe in the world (a safe location will be detected) More...
 
MoveItErrorCode place (const std::string &object, const std::vector< moveit_msgs::PlaceLocation > &locations)
 Place an object at one of the specified possible locations. More...
 
MoveItErrorCode place (const std::string &object, const std::vector< geometry_msgs::PoseStamped > &poses)
 Place an object at one of the specified possible locations. More...
 
MoveItErrorCode place (const std::string &object, const geometry_msgs::PoseStamped &pose)
 Place an object at one of the specified possible location. More...
 
bool attachObject (const std::string &object, const std::string &link="")
 Given the name of an object in the planning scene, make the object attached to a link of the robot. If no link name is specified, the end-effector is used. If there is no end-effector, the first link in the group is used. If the object name does not exist an error will be produced in move_group, but the request made by this interface will succeed. More...
 
bool attachObject (const std::string &object, const std::string &link, const std::vector< std::string > &touch_links)
 Given the name of an object in the planning scene, make the object attached to a link of the robot. The set of links the object is allowed to touch without considering that a collision is specified by touch_links. If link is empty, the end-effector link is used. If there is no end-effector, the first link in the group is used. If the object name does not exist an error will be produced in move_group, but the request made by this interface will succeed. More...
 
bool detachObject (const std::string &name="")
 Detach an object. name specifies the name of the object attached to this group, or the name of the link the object is attached to. If there is no name specified, and there is only one attached object, that object is detached. An error is produced if no object to detach is identified. More...
 
Query current robot state
bool startStateMonitor (double wait=1.0)
 When reasoning about the current state of a robot, a CurrentStateMonitor instance is automatically constructed. This function allows triggering the construction of that object from the beginning, so that future calls to functions such as getCurrentState() will not take so long and are less likely to fail. More...
 
std::vector< double > getCurrentJointValues ()
 Get the current joint values for the joints planned for by this instance (see getJoints()) More...
 
robot_state::RobotStatePtr getCurrentState ()
 Get the current state of the robot. More...
 
geometry_msgs::PoseStamped getCurrentPose (const std::string &end_effector_link="")
 Get the pose for the end-effector end_effector_link. If end_effector_link is empty (the default value) then the end-effector reported by getEndEffectorLink() is assumed. More...
 
std::vector< double > getCurrentRPY (const std::string &end_effector_link="")
 Get the roll-pitch-yaw (XYZ) for the end-effector end_effector_link. If end_effector_link is empty (the default value) then the end-effector reported by getEndEffectorLink() is assumed. More...
 
std::vector< double > getRandomJointValues ()
 Get random joint values for the joints planned for by this instance (see getJoints()) More...
 
geometry_msgs::PoseStamped getRandomPose (const std::string &end_effector_link="")
 Get a random reachable pose for the end-effector end_effector_link. If end_effector_link is empty (the default value) then the end-effector reported by getEndEffectorLink() is assumed. More...
 
Manage named joint configurations
void rememberJointValues (const std::string &name)
 Remember the current joint values (of the robot being monitored) under name. These can be used by setNamedTarget(). These values are remembered locally in the client. Other clients will not have access to them. More...
 
void rememberJointValues (const std::string &name, const std::vector< double > &values)
 Remember the specified joint values under name. These can be used by setNamedTarget(). These values are remembered locally in the client. Other clients will not have access to them. More...
 
const std::map< std::string, std::vector< double > > & getRememberedJointValues () const
 Get the currently remembered map of names to joint values. More...
 
void forgetJointValues (const std::string &name)
 Forget the joint values remebered under name. More...
 
Manage planning constraints
void setConstraintsDatabase (const std::string &host, unsigned int port)
 Specify where the database server that holds known constraints resides. More...
 
std::vector< std::string > getKnownConstraints () const
 Get the names of the known constraints as read from the Mongo database, if a connection was achieved. More...
 
moveit_msgs::Constraints getPathConstraints () const
 Get the actual set of constraints in use with this MoveGroupInterface. More...
 
bool setPathConstraints (const std::string &constraint)
 Specify a set of path constraints to use. The constraints are looked up by name from the Mongo database server. This replaces any path constraints set in previous calls to setPathConstraints(). More...
 
void setPathConstraints (const moveit_msgs::Constraints &constraint)
 Specify a set of path constraints to use. This version does not require a database server. This replaces any path constraints set in previous calls to setPathConstraints(). More...
 
void clearPathConstraints ()
 Specify that no path constraints are to be used. This removes any path constraints set in previous calls to setPathConstraints(). More...
 

Static Public Attributes

static const std::string ROBOT_DESCRIPTION
 Default ROS parameter name from where to read the robot's URDF. Set to 'robot_description'. More...
 

Private Attributes

MoveGroupInterfaceImplimpl_
 
std::map< std::string, std::vector< double > > remembered_joint_values_
 

Detailed Description

Client class to conveniently use the ROS interfaces provided by the move_group node.

This class includes many default settings to make things easy to use.

Definition at line 88 of file move_group_interface.h.

Constructor & Destructor Documentation

moveit::planning_interface::MoveGroupInterface::MoveGroupInterface ( const Options opt,
const boost::shared_ptr< tf::Transformer > &  tf = boost::shared_ptr<tf::Transformer>(),
const ros::WallDuration wait_for_servers = ros::WallDuration() 
)

Construct a MoveGroupInterface instance call using a specified set of options opt.

Parameters
opt.A MoveGroupInterface::Options structure, if you pass a ros::NodeHandle with a specific callback queue, it has to be of type ros::CallbackQueue (which is the default type of callback queues used in ROS)
tf.Specify a TF instance to use. If not specified, one will be constructed internally.
wait_for_servers.Timeout for connecting to action servers. Zero time means unlimited waiting.

Definition at line 1352 of file move_group_interface.cpp.

moveit::planning_interface::MoveGroupInterface::MoveGroupInterface ( const Options opt,
const boost::shared_ptr< tf::Transformer > &  tf,
const ros::Duration wait_for_servers 
)

Definition at line 1359 of file move_group_interface.cpp.

moveit::planning_interface::MoveGroupInterface::MoveGroupInterface ( const std::string &  group,
const boost::shared_ptr< tf::Transformer > &  tf = boost::shared_ptr<tf::Transformer>(),
const ros::WallDuration wait_for_servers = ros::WallDuration() 
)

Construct a client for the MoveGroup action for a particular group.

Parameters
tf.Specify a TF instance to use. If not specified, one will be constructed internally.
wait_for_servers.Timeout for connecting to action servers. Zero time means unlimited waiting.

Definition at line 1336 of file move_group_interface.cpp.

moveit::planning_interface::MoveGroupInterface::MoveGroupInterface ( const std::string &  group,
const boost::shared_ptr< tf::Transformer > &  tf,
const ros::Duration wait_for_servers 
)

Definition at line 1345 of file move_group_interface.cpp.

moveit::planning_interface::MoveGroupInterface::~MoveGroupInterface ( )

Definition at line 1366 of file move_group_interface.cpp.

Member Function Documentation

void moveit::planning_interface::MoveGroupInterface::allowLooking ( bool  flag)

Specify whether the robot is allowed to look around before moving if it determines it should (default is true)

Definition at line 2128 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::allowReplanning ( bool  flag)

Specify whether the robot is allowed to replan if it detects changes in the environment.

Definition at line 2133 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::asyncExecute ( const Plan plan)

Given a plan, execute it without waiting for completion. Return true on success.

Definition at line 1458 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::asyncMove ( )

Plan and execute a trajectory that takes the group of joints declared in the constructor to the specified target. This call is not blocking (does not wait for the execution of the trajectory to complete).

Definition at line 1447 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::attachObject ( const std::string &  object,
const std::string &  link = "" 
)

Given the name of an object in the planning scene, make the object attached to a link of the robot. If no link name is specified, the end-effector is used. If there is no end-effector, the first link in the group is used. If the object name does not exist an error will be produced in move_group, but the request made by this interface will succeed.

Definition at line 2196 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::attachObject ( const std::string &  object,
const std::string &  link,
const std::vector< std::string > &  touch_links 
)

Given the name of an object in the planning scene, make the object attached to a link of the robot. The set of links the object is allowed to touch without considering that a collision is specified by touch_links. If link is empty, the end-effector link is used. If there is no end-effector, the first link in the group is used. If the object name does not exist an error will be produced in move_group, but the request made by this interface will succeed.

Definition at line 2201 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::clearPathConstraints ( )

Specify that no path constraints are to be used. This removes any path constraints set in previous calls to setPathConstraints().

Definition at line 2158 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::clearPoseTarget ( const std::string &  end_effector_link = "")

Forget pose(s) specified for end_effector_link.

Definition at line 1755 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::clearPoseTargets ( )

Forget any poses specified for all end-effectors.

Definition at line 1760 of file move_group_interface.cpp.

double moveit::planning_interface::MoveGroupInterface::computeCartesianPath ( const std::vector< geometry_msgs::Pose > &  waypoints,
double  eef_step,
double  jump_threshold,
moveit_msgs::RobotTrajectory &  trajectory,
bool  avoid_collisions = true,
moveit_msgs::MoveItErrorCodes *  error_code = NULL 
)

Compute a Cartesian path that follows specified waypoints with a step size of at most eef_step meters between end effector configurations of consecutive points in the result trajectory. The reference frame for the waypoints is that specified by setPoseReferenceFrame(). No more than jump_threshold is allowed as change in distance in the configuration space of the robot (this is to prevent 'jumps' in IK solutions). Collisions are avoided if avoid_collisions is set to true. If collisions cannot be avoided, the function fails. Return a value that is between 0.0 and 1.0 indicating the fraction of the path achieved as described by the waypoints. Return -1.0 in case of error.

Definition at line 1527 of file move_group_interface.cpp.

double moveit::planning_interface::MoveGroupInterface::computeCartesianPath ( const std::vector< geometry_msgs::Pose > &  waypoints,
double  eef_step,
double  jump_threshold,
moveit_msgs::RobotTrajectory &  trajectory,
const moveit_msgs::Constraints &  path_constraints,
bool  avoid_collisions = true,
moveit_msgs::MoveItErrorCodes *  error_code = NULL 
)

Compute a Cartesian path that follows specified waypoints with a step size of at most eef_step meters between end effector configurations of consecutive points in the result trajectory. The reference frame for the waypoints is that specified by setPoseReferenceFrame(). No more than jump_threshold is allowed as change in distance in the configuration space of the robot (this is to prevent 'jumps' in IK solutions). Kinematic constraints for the path given by path_constraints will be met for every point along the trajectory, if they are not met, a partial solution will be returned. Constraints are checked (collision and kinematic) if avoid_collisions is set to true. If constraints cannot be met, the function fails. Return a value that is between 0.0 and 1.0 indicating the fraction of the path achieved as described by the waypoints. Return -1.0 in case of error.

Definition at line 1536 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::constructMotionPlanRequest ( moveit_msgs::MotionPlanRequest request)

Build the MotionPlanRequest that would be sent to the move_group action with plan() or move() and store it in request.

Definition at line 2212 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::detachObject ( const std::string &  name = "")

Detach an object. name specifies the name of the object attached to this group, or the name of the link the object is attached to. If there is no name specified, and there is only one attached object, that object is detached. An error is produced if no object to detach is identified.

Definition at line 2207 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::execute ( const Plan plan)

Given a plan, execute it while waiting for completion. Return true on success.

Definition at line 1463 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::forgetJointValues ( const std::string &  name)

Forget the joint values remebered under name.

Definition at line 2123 of file move_group_interface.cpp.

const std::vector< std::string > & moveit::planning_interface::MoveGroupInterface::getActiveJoints ( ) const

Get only the active (actuated) joints this instance operates on.

Definition at line 2095 of file move_group_interface.cpp.

std::vector< double > moveit::planning_interface::MoveGroupInterface::getCurrentJointValues ( )

Get the current joint values for the joints planned for by this instance (see getJoints())

Definition at line 2000 of file move_group_interface.cpp.

geometry_msgs::PoseStamped moveit::planning_interface::MoveGroupInterface::getCurrentPose ( const std::string &  end_effector_link = "")

Get the pose for the end-effector end_effector_link. If end_effector_link is empty (the default value) then the end-effector reported by getEndEffectorLink() is assumed.

Definition at line 2043 of file move_group_interface.cpp.

std::vector< double > moveit::planning_interface::MoveGroupInterface::getCurrentRPY ( const std::string &  end_effector_link = "")

Get the roll-pitch-yaw (XYZ) for the end-effector end_effector_link. If end_effector_link is empty (the default value) then the end-effector reported by getEndEffectorLink() is assumed.

Definition at line 2067 of file move_group_interface.cpp.

robot_state::RobotStatePtr moveit::planning_interface::MoveGroupInterface::getCurrentState ( )

Get the current state of the robot.

Definition at line 2110 of file move_group_interface.cpp.

std::string moveit::planning_interface::MoveGroupInterface::getDefaultPlannerId ( const std::string &  group = "") const

Get the default planner for a given group (or global default)

Definition at line 1421 of file move_group_interface.cpp.

const std::string & moveit::planning_interface::MoveGroupInterface::getEndEffector ( ) const

Get the current end-effector name. This returns the value set by setEndEffector() (or indirectly by setEndEffectorLink()). If setEndEffector() was not called, this function reports an end-effector attached to this group. If there are multiple end-effectors, one of them is returned. If no end-effector is known, the empty string is returned.

Definition at line 1733 of file move_group_interface.cpp.

const std::string & moveit::planning_interface::MoveGroupInterface::getEndEffectorLink ( ) const

Get the current end-effector link. This returns the value set by setEndEffectorLink() (or indirectly by setEndEffector()). If setEndEffectorLink() was not called, this function reports the link name that serves as parent of an end-effector attached to this group. If there are multiple end-effectors, one of them is returned. If no such link is known, the empty string is returned.

Definition at line 1728 of file move_group_interface.cpp.

double moveit::planning_interface::MoveGroupInterface::getGoalJointTolerance ( ) const

Get the tolerance that is used for reaching a joint goal. This is distance for each joint in configuration space.

Definition at line 1953 of file move_group_interface.cpp.

double moveit::planning_interface::MoveGroupInterface::getGoalOrientationTolerance ( ) const

Get the tolerance that is used for reaching an orientation goal. This is the tolerance for roll, pitch and yaw, in radians.

Definition at line 1963 of file move_group_interface.cpp.

double moveit::planning_interface::MoveGroupInterface::getGoalPositionTolerance ( ) const

Get the tolerance that is used for reaching a position goal. This is be the radius of a sphere where the end-effector must reach.

Definition at line 1958 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::getInterfaceDescription ( moveit_msgs::PlannerInterfaceDescription &  desc)

Get the description of the planning plugin loaded by the action server.

Definition at line 1401 of file move_group_interface.cpp.

const std::vector< std::string > & moveit::planning_interface::MoveGroupInterface::getJointNames ( )

Get vector of names of joints available in move group.

Definition at line 1583 of file move_group_interface.cpp.

const std::vector< std::string > & moveit::planning_interface::MoveGroupInterface::getJoints ( ) const

Get all the joints this instance operates on (including fixed joints)

Definition at line 2100 of file move_group_interface.cpp.

const robot_state::RobotState & moveit::planning_interface::MoveGroupInterface::getJointValueTarget ( ) const

Get the currently set joint state goal.

Definition at line 1723 of file move_group_interface.cpp.

std::vector< std::string > moveit::planning_interface::MoveGroupInterface::getKnownConstraints ( ) const

Get the names of the known constraints as read from the Mongo database, if a connection was achieved.

Definition at line 2138 of file move_group_interface.cpp.

const std::vector< std::string > & moveit::planning_interface::MoveGroupInterface::getLinkNames ( )

Get vector of names of links available in move group.

Definition at line 1588 of file move_group_interface.cpp.

const std::string & moveit::planning_interface::MoveGroupInterface::getName ( ) const

Get the name of the group this instance operates on.

Definition at line 1371 of file move_group_interface.cpp.

const std::vector< std::string > moveit::planning_interface::MoveGroupInterface::getNamedTargets ( )

Get the names of the named robot states available as targets, both either remembered states or default states from srdf.

Definition at line 1376 of file move_group_interface.cpp.

std::map< std::string, double > moveit::planning_interface::MoveGroupInterface::getNamedTargetValues ( const std::string &  name)

Get the joint angles for targets specified by name.

Definition at line 1594 of file move_group_interface.cpp.

const ros::NodeHandle & moveit::planning_interface::MoveGroupInterface::getNodeHandle ( ) const

Get the ROS node handle of this instance operates on.

Definition at line 1396 of file move_group_interface.cpp.

moveit_msgs::Constraints moveit::planning_interface::MoveGroupInterface::getPathConstraints ( ) const

Get the actual set of constraints in use with this MoveGroupInterface.

Returns
A copy of the current path constraints set for this interface

Definition at line 2143 of file move_group_interface.cpp.

std::map< std::string, std::string > moveit::planning_interface::MoveGroupInterface::getPlannerParams ( const std::string &  planner_id,
const std::string &  group = "" 
)

Get the planner parameters for given group and planner_id.

Definition at line 1407 of file move_group_interface.cpp.

const std::string & moveit::planning_interface::MoveGroupInterface::getPlanningFrame ( ) const

Get the name of the frame in which the robot is planning.

Definition at line 2191 of file move_group_interface.cpp.

double moveit::planning_interface::MoveGroupInterface::getPlanningTime ( ) const

Get the number of seconds set by setPlanningTime()

Get time allowed to planner to solve problem before aborting.

Definition at line 2181 of file move_group_interface.cpp.

const std::string & moveit::planning_interface::MoveGroupInterface::getPoseReferenceFrame ( ) const

Get the reference frame set by setPoseReferenceFrame(). By default this is the reference frame of the robot model.

Definition at line 1948 of file move_group_interface.cpp.

const geometry_msgs::PoseStamped & moveit::planning_interface::MoveGroupInterface::getPoseTarget ( const std::string &  end_effector_link = "") const

Get the currently set pose goal for the end-effector end_effector_link. If end_effector_link is empty (the default value) then the end-effector reported by getEndEffectorLink() is assumed. If multiple targets are set for end_effector_link this will return the first one. If no pose target is set for this end_effector_link then an empty pose will be returned (check for orientation.xyzw == 0).

Definition at line 1838 of file move_group_interface.cpp.

const std::vector< geometry_msgs::PoseStamped > & moveit::planning_interface::MoveGroupInterface::getPoseTargets ( const std::string &  end_effector_link = "") const

Get the currently set pose goal for the end-effector end_effector_link. The pose goal can consist of multiple poses, if corresponding setPoseTarget() calls were made. Otherwise, only one pose is returned in the vector. If end_effector_link is empty (the default value) then the end-effector reported by getEndEffectorLink() is assumed

Definition at line 1844 of file move_group_interface.cpp.

std::vector< double > moveit::planning_interface::MoveGroupInterface::getRandomJointValues ( )

Get random joint values for the joints planned for by this instance (see getJoints())

Definition at line 2009 of file move_group_interface.cpp.

geometry_msgs::PoseStamped moveit::planning_interface::MoveGroupInterface::getRandomPose ( const std::string &  end_effector_link = "")

Get a random reachable pose for the end-effector end_effector_link. If end_effector_link is empty (the default value) then the end-effector reported by getEndEffectorLink() is assumed.

Definition at line 2017 of file move_group_interface.cpp.

const std::map<std::string, std::vector<double> >& moveit::planning_interface::MoveGroupInterface::getRememberedJointValues ( ) const
inline

Get the currently remembered map of names to joint values.

Definition at line 850 of file move_group_interface.h.

robot_model::RobotModelConstPtr moveit::planning_interface::MoveGroupInterface::getRobotModel ( ) const

Get the RobotModel object.

Definition at line 1391 of file move_group_interface.cpp.

unsigned int moveit::planning_interface::MoveGroupInterface::getVariableCount ( ) const

Get the number of variables used to describe the state of this group. This is larger or equal to the number of DOF.

Definition at line 2105 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::move ( )

Plan and execute a trajectory that takes the group of joints declared in the constructor to the specified target. This call is always blocking (waits for the execution of the trajectory to complete) and requires an asynchronous spinner to be started.

Definition at line 1452 of file move_group_interface.cpp.

moveit::planning_interface::MoveGroupInterface::MOVEIT_STRUCT_FORWARD ( Plan  )
moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::pick ( const std::string &  object)

Pick up an object.

This applies a number of hard-coded default grasps

Definition at line 1474 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::pick ( const std::string &  object,
const moveit_msgs::Grasp &  grasp 
)

Pick up an object given a grasp pose.

Definition at line 1480 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::pick ( const std::string &  object,
const std::vector< moveit_msgs::Grasp > &  grasps 
)

Pick up an object given possible grasp poses.

if the vector is left empty this behaves like pick(const std::string &object)

Definition at line 1485 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::place ( const std::string &  object)

Place an object somewhere safe in the world (a safe location will be detected)

Definition at line 1504 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::place ( const std::string &  object,
const std::vector< moveit_msgs::PlaceLocation > &  locations 
)

Place an object at one of the specified possible locations.

Definition at line 1509 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::place ( const std::string &  object,
const std::vector< geometry_msgs::PoseStamped > &  poses 
)

Place an object at one of the specified possible locations.

Definition at line 1515 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::place ( const std::string &  object,
const geometry_msgs::PoseStamped &  pose 
)

Place an object at one of the specified possible location.

Definition at line 1522 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::plan ( Plan plan)

Compute a motion plan that takes the group declared in the constructor from the current state to the specified target. No execution is performed. The resulting plan is stored in plan.

Definition at line 1468 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::planGraspsAndPick ( const std::string &  object = "")

Pick up an object.

calls the external moveit_msgs::GraspPlanning service "plan_grasps" to compute possible grasps

Definition at line 1492 of file move_group_interface.cpp.

moveit::planning_interface::MoveItErrorCode moveit::planning_interface::MoveGroupInterface::planGraspsAndPick ( const moveit_msgs::CollisionObject &  object)

Pick up an object.

calls the external moveit_msgs::GraspPlanning service "plan_grasps" to compute possible grasps

Definition at line 1498 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::rememberJointValues ( const std::string &  name)

Remember the current joint values (of the robot being monitored) under name. These can be used by setNamedTarget(). These values are remembered locally in the client. Other clients will not have access to them.

Definition at line 1990 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::rememberJointValues ( const std::string &  name,
const std::vector< double > &  values 
)

Remember the specified joint values under name. These can be used by setNamedTarget(). These values are remembered locally in the client. Other clients will not have access to them.

Definition at line 2117 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setApproximateJointValueTarget ( const geometry_msgs::Pose eef_pose,
const std::string &  end_effector_link = "" 
)

Set the joint state goal for a particular joint by computing IK.

This is different from setPoseTarget() in that a single IK state (aka JointValueTarget) is computed using IK, and the resulting JointValueTarget is used as the target for planning.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If IK fails to find a solution then an approximation is used.

Definition at line 1703 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setApproximateJointValueTarget ( const geometry_msgs::PoseStamped &  eef_pose,
const std::string &  end_effector_link = "" 
)

Set the joint state goal for a particular joint by computing IK.

This is different from setPoseTarget() in that a single IK state (aka JointValueTarget) is computed using IK, and the resulting JointValueTarget is used as the target for planning.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If IK fails to find a solution then an approximation is used.

Definition at line 1709 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setApproximateJointValueTarget ( const Eigen::Affine3d &  eef_pose,
const std::string &  end_effector_link = "" 
)

Set the joint state goal for a particular joint by computing IK.

This is different from setPoseTarget() in that a single IK state (aka JointValueTarget) is computed using IK, and the resulting JointValueTarget is used as the target for planning.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If IK fails to find a solution then an approximation is used.

Definition at line 1715 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setConstraintsDatabase ( const std::string &  host,
unsigned int  port 
)

Specify where the database server that holds known constraints resides.

Definition at line 2163 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setEndEffector ( const std::string &  eef_name)

Specify the name of the end-effector to use. This is equivalent to setting the EndEffectorLink to the parent link of this end effector.

Definition at line 1747 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setEndEffectorLink ( const std::string &  end_effector_link)

Specify the parent link of the end-effector. This end_effector_link will be used in calls to pose target functions when end_effector_link is not explicitly specified.

Definition at line 1738 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setGoalJointTolerance ( double  tolerance)

Set the joint tolerance (for each joint) that is used for reaching the goal when moving to a joint value target.

Definition at line 1975 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setGoalOrientationTolerance ( double  tolerance)

Set the orientation tolerance that is used for reaching the goal when moving to a pose.

Definition at line 1985 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setGoalPositionTolerance ( double  tolerance)

Set the position tolerance that is used for reaching the goal when moving to a pose.

Definition at line 1980 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setGoalTolerance ( double  tolerance)

Set the tolerance that is used for reaching the goal. For joint state goals, this will be distance for each joint, in the configuration space (radians or meters depending on joint type). For pose goals this will be the radius of a sphere where the end-effector must reach. This function simply triggers calls to setGoalPositionTolerance(), setGoalOrientationTolerance() and setGoalJointTolerance().

Definition at line 1968 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const std::vector< double > &  group_variable_values)

Set the JointValueTarget and use it for future planning requests.

group_variable_values MUST contain exactly one value per joint variable in the same order as returned by getJointValueTarget().getJointModelGroup(getName())->getVariableNames().

This always sets all of the group's joint values.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If these values are out of bounds then false is returned BUT THE VALUES ARE STILL SET AS THE GOAL.

Definition at line 1633 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const std::map< std::string, double > &  variable_values)

Set the JointValueTarget and use it for future planning requests.

variable_values is a map of joint variable names to values. Joints in the group are used to set the JointValueTarget. Joints in the model but not in the group are ignored. An exception is thrown if a joint name is not found in the model. Joint variables in the group that are missing from variable_values remain unchanged (to reset all target variables to their current values in the robot use setJointValueTarget(getCurrentJointValues())).

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If these values are out of bounds then false is returned BUT THE VALUES ARE STILL SET AS THE GOAL.

Definition at line 1642 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const robot_state::RobotState &  robot_state)

Set the JointValueTarget and use it for future planning requests.

The target for all joints in the group are set to the value in robot_state.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If these values are out of bounds then false is returned BUT THE VALUES ARE STILL SET AS THE GOAL.

Definition at line 1650 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const std::string &  joint_name,
const std::vector< double > &  values 
)

Set the JointValueTarget and use it for future planning requests.

values MUST have one value for each variable in joint joint_name. values are set as the target for this joint. Other joint targets remain unchanged.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If these values are out of bounds then false is returned BUT THE VALUES ARE STILL SET AS THE GOAL.

Definition at line 1663 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const std::string &  joint_name,
double  value 
)

Set the JointValueTarget and use it for future planning requests.

Joint joint_name must be a 1-DOF joint. value is set as the target for this joint. Other joint targets remain unchanged.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If these values are out of bounds then false is returned BUT THE VALUES ARE STILL SET AS THE GOAL.

Definition at line 1657 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const sensor_msgs::JointState &  state)

Set the JointValueTarget and use it for future planning requests.

state is used to set the target joint state values. Values not specified in state remain unchanged.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If these values are out of bounds then false is returned BUT THE VALUES ARE STILL SET AS THE GOAL.

Definition at line 1676 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const geometry_msgs::Pose eef_pose,
const std::string &  end_effector_link = "" 
)

Set the joint state goal for a particular joint by computing IK.

This is different from setPoseTarget() in that a single IK state (aka JointValueTarget) is computed using IK, and the resulting JointValueTarget is used as the target for planning.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If IK fails to find a solution then false is returned BUT THE PARTIAL RESULT OF IK IS STILL SET AS THE GOAL.

Definition at line 1683 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const geometry_msgs::PoseStamped &  eef_pose,
const std::string &  end_effector_link = "" 
)

Set the joint state goal for a particular joint by computing IK.

This is different from setPoseTarget() in that a single IK state (aka JointValueTarget) is computed using IK, and the resulting JointValueTarget is used as the target for planning.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If IK fails to find a solution then false is returned BUT THE PARTIAL RESULT OF IK IS STILL SET AS THE GOAL.

Definition at line 1689 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setJointValueTarget ( const Eigen::Affine3d &  eef_pose,
const std::string &  end_effector_link = "" 
)

Set the joint state goal for a particular joint by computing IK.

This is different from setPoseTarget() in that a single IK state (aka JointValueTarget) is computed using IK, and the resulting JointValueTarget is used as the target for planning.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

If IK fails to find a solution then false is returned BUT THE PARTIAL RESULT OF IK IS STILL SET AS THE GOAL.

Definition at line 1695 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setMaxAccelerationScalingFactor ( double  max_acceleration_scaling_factor)

Set a scaling factor for optionally reducing the maximum joint acceleration. Allowed values are in (0,1]. The maximum joint acceleration specified in the robot model is multiplied by the factor. If outside valid range (imporantly, this includes it being set to 0.0), the factor is set to a default value of 1.0 internally (i.e. maximum joint acceleration)

Definition at line 1441 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setMaxVelocityScalingFactor ( double  max_velocity_scaling_factor)

Set a scaling factor for optionally reducing the maximum joint velocity. Allowed values are in (0,1]. The maximum joint velocity specified in the robot model is multiplied by the factor. If outside valid range (imporantly, this includes it being set to 0.0), the factor is set to a default value of 1.0 internally (i.e. maximum joint velocity)

Definition at line 1436 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setNamedTarget ( const std::string &  name)

Set the current joint values to be ones previously remembered by rememberJointValues() or, if not found, that are specified in the SRDF under the name name as a group state.

Definition at line 1614 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setNumPlanningAttempts ( unsigned int  num_planning_attempts)

Set the number of times the motion plan is to be computed from scratch before the shortest solution is returned. The default value is 1.

Definition at line 1431 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setOrientationTarget ( double  x,
double  y,
double  z,
double  w,
const std::string &  end_effector_link = "" 
)

Set the goal orientation of the end-effector end_effector_link to be the quaternion (x,y,z,w).

If end_effector_link is empty then getEndEffectorLink() is used.

This new orientation target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target for this end_effector_link.

Definition at line 1917 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setPathConstraints ( const std::string &  constraint)

Specify a set of path constraints to use. The constraints are looked up by name from the Mongo database server. This replaces any path constraints set in previous calls to setPathConstraints().

Definition at line 2148 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setPathConstraints ( const moveit_msgs::Constraints &  constraint)

Specify a set of path constraints to use. This version does not require a database server. This replaces any path constraints set in previous calls to setPathConstraints().

Definition at line 2153 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setPlannerId ( const std::string &  planner_id)

Specify a planner to be used for further planning.

Definition at line 1426 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setPlannerParams ( const std::string &  planner_id,
const std::string &  group,
const std::map< std::string, std::string > &  params,
bool  bReplace = false 
)

Set the planner parameters for given group and planner_id.

Definition at line 1413 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setPlanningTime ( double  seconds)

Specify the maximum amount of time to use when planning.

Set time allowed to planner to solve problem before aborting.

Definition at line 2175 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setPoseReferenceFrame ( const std::string &  pose_reference_frame)

Specify which reference frame to assume for poses specified without a reference frame.

Definition at line 1943 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setPoseTarget ( const Eigen::Affine3d &  end_effector_pose,
const std::string &  end_effector_link = "" 
)

Set the goal pose of the end-effector end_effector_link.

If end_effector_link is empty then getEndEffectorLink() is used.

This new pose target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target for this end_effector_link.

Definition at line 1765 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setPoseTarget ( const geometry_msgs::Pose target,
const std::string &  end_effector_link = "" 
)

Set the goal pose of the end-effector end_effector_link.

If end_effector_link is empty then getEndEffectorLink() is used.

This new orientation target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target for this end_effector_link.

Definition at line 1775 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setPoseTarget ( const geometry_msgs::PoseStamped &  target,
const std::string &  end_effector_link = "" 
)

Set the goal pose of the end-effector end_effector_link.

If end_effector_link is empty then getEndEffectorLink() is used.

This new orientation target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target for this end_effector_link.

Definition at line 1785 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setPoseTargets ( const EigenSTL::vector_Affine3d end_effector_pose,
const std::string &  end_effector_link = "" 
)

Set goal poses for end_effector_link.

If end_effector_link is empty then getEndEffectorLink() is used.

When planning, the planner will find a path to one (arbitrarily chosen) pose from the list. If this group contains multiple end effectors then all end effectors in the group should have the same number of pose targets. If planning is successful then the result of the plan will place all end effectors at a pose from the same index in the list. (In other words, if one end effector ends up at the 3rd pose in the list then all end effectors in the group will end up at the 3rd pose in their respective lists. End effectors which do not matter (i.e. can end up in any position) can have their pose targets disabled by calling clearPoseTarget() for that end_effector_link.

This new orientation target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target(s) for this end_effector_link.

Definition at line 1792 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setPoseTargets ( const std::vector< geometry_msgs::Pose > &  target,
const std::string &  end_effector_link = "" 
)

Set goal poses for end_effector_link.

If end_effector_link is empty then getEndEffectorLink() is used.

When planning, the planner will find a path to one (arbitrarily chosen) pose from the list. If this group contains multiple end effectors then all end effectors in the group should have the same number of pose targets. If planning is successful then the result of the plan will place all end effectors at a pose from the same index in the list. (In other words, if one end effector ends up at the 3rd pose in the list then all end effectors in the group will end up at the 3rd pose in their respective lists. End effectors which do not matter (i.e. can end up in any position) can have their pose targets disabled by calling clearPoseTarget() for that end_effector_link.

This new orientation target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target(s) for this end_effector_link.

Definition at line 1807 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setPoseTargets ( const std::vector< geometry_msgs::PoseStamped > &  target,
const std::string &  end_effector_link = "" 
)

Set goal poses for end_effector_link.

If end_effector_link is empty then getEndEffectorLink() is used.

When planning, the planner will find a path to one (arbitrarily chosen) pose from the list. If this group contains multiple end effectors then all end effectors in the group should have the same number of pose targets. If planning is successful then the result of the plan will place all end effectors at a pose from the same index in the list. (In other words, if one end effector ends up at the 3rd pose in the list then all end effectors in the group will end up at the 3rd pose in their respective lists. End effectors which do not matter (i.e. can end up in any position) can have their pose targets disabled by calling clearPoseTarget() for that end_effector_link.

This new orientation target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target(s) for this end_effector_link.

Definition at line 1822 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setPositionTarget ( double  x,
double  y,
double  z,
const std::string &  end_effector_link = "" 
)

Set the goal position of the end-effector end_effector_link to be (x, y, z).

If end_effector_link is empty then getEndEffectorLink() is used.

This new position target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target for this end_effector_link.

Definition at line 1868 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setRandomTarget ( )

Set the joint state goal to a random joint configuration.

After this call, the JointValueTarget is used instead of any previously set Position, Orientation, or Pose targets.

Definition at line 1577 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::setRPYTarget ( double  roll,
double  pitch,
double  yaw,
const std::string &  end_effector_link = "" 
)

Set the goal orientation of the end-effector end_effector_link to be (roll,pitch,yaw) radians.

If end_effector_link is empty then getEndEffectorLink() is used.

This new orientation target replaces any pre-existing JointValueTarget or pre-existing Position, Orientation, or Pose target for this end_effector_link.

Definition at line 1894 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setStartState ( const moveit_msgs::RobotState &  start_state)

If a different start state should be considered instead of the current state of the robot, this function sets that state.

Definition at line 1559 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setStartState ( const robot_state::RobotState &  start_state)

If a different start state should be considered instead of the current state of the robot, this function sets that state.

Definition at line 1567 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setStartStateToCurrentState ( )

Set the starting state for planning to be that reported by the robot's joint state publication.

Definition at line 1572 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setSupportSurfaceName ( const std::string &  name)

For pick/place operations, the name of the support surface is used to specify the fact that attached objects are allowed to touch the support surface.

Definition at line 2186 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::setWorkspace ( double  minx,
double  miny,
double  minz,
double  maxx,
double  maxy,
double  maxz 
)

Specify the workspace bounding box. The box is specified in the planning frame (i.e. relative to the robot root link start position). This is useful when the planning group contains the root joint of the robot – i.e. when planning motion for the robot relative to the world.

Definition at line 2168 of file move_group_interface.cpp.

bool moveit::planning_interface::MoveGroupInterface::startStateMonitor ( double  wait = 1.0)

When reasoning about the current state of a robot, a CurrentStateMonitor instance is automatically constructed. This function allows triggering the construction of that object from the beginning, so that future calls to functions such as getCurrentState() will not take so long and are less likely to fail.

Definition at line 1995 of file move_group_interface.cpp.

void moveit::planning_interface::MoveGroupInterface::stop ( void  )

Stop any trajectory execution, if one is active.

Definition at line 1554 of file move_group_interface.cpp.

Member Data Documentation

MoveGroupInterfaceImpl* moveit::planning_interface::MoveGroupInterface::impl_
private

Definition at line 894 of file move_group_interface.h.

std::map<std::string, std::vector<double> > moveit::planning_interface::MoveGroupInterface::remembered_joint_values_
private

Definition at line 893 of file move_group_interface.h.

const std::string moveit::planning_interface::MoveGroupInterface::ROBOT_DESCRIPTION
static
Initial value:
=
"robot_description"

Default ROS parameter name from where to read the robot's URDF. Set to 'robot_description'.

Definition at line 92 of file move_group_interface.h.


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


planning_interface
Author(s): Ioan Sucan
autogenerated on Sun Nov 12 2017 03:55:14