constraint_sampler.h

Go to the documentation of this file.

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

/* Author: Ioan Sucan */

#ifndef MOVEIT_CONSTRAINT_SAMPLERS_CONSTRAINT_SAMPLER_
#define MOVEIT_CONSTRAINT_SAMPLERS_CONSTRAINT_SAMPLER_

#include <moveit/planning_scene/planning_scene.h>
#include <moveit/kinematic_constraints/kinematic_constraint.h>
#include <vector>

namespace constraint_samplers
{
MOVEIT_CLASS_FORWARD(ConstraintSampler);  // Defines ConstraintSamplerPtr, ConstPtr, WeakPtr... etc

class ConstraintSampler
{
public:
  static const unsigned int DEFAULT_MAX_SAMPLING_ATTEMPTS = 2;

  ConstraintSampler(const planning_scene::PlanningSceneConstPtr& scene, const std::string& group_name);

  virtual ~ConstraintSampler()
  {
  }

  virtual bool configure(const moveit_msgs::Constraints& constr) = 0;

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

  const robot_model::JointModelGroup* getJointModelGroup() const
  {
    return jmg_;
  }

  const planning_scene::PlanningSceneConstPtr& getPlanningScene() const
  {
    return scene_;
  }

  const std::vector<std::string>& getFrameDependency() const
  {
    return frame_depends_;
  }

  const robot_state::GroupStateValidityCallbackFn& getGroupStateValidityCallback() const
  {
    return group_state_validity_callback_;
  }

  void setGroupStateValidityCallback(const robot_state::GroupStateValidityCallbackFn& callback)
  {
    group_state_validity_callback_ = callback;
  }

  bool sample(robot_state::RobotState& state)
  {
    return sample(state, state, DEFAULT_MAX_SAMPLING_ATTEMPTS);
  }

  bool sample(robot_state::RobotState& state, unsigned int max_attempts)
  {
    return sample(state, state, max_attempts);
  }

  bool sample(robot_state::RobotState& state, const robot_state::RobotState& reference_state)
  {
    return sample(state, reference_state, DEFAULT_MAX_SAMPLING_ATTEMPTS);
  }

  bool project(robot_state::RobotState& state)
  {
    return project(state, DEFAULT_MAX_SAMPLING_ATTEMPTS);
  }

  virtual bool sample(robot_state::RobotState& state, const robot_state::RobotState& reference_state,
                      unsigned int max_attempts) = 0;

  virtual bool project(robot_state::RobotState& state, unsigned int max_attempts) = 0;

  bool isValid() const
  {
    return is_valid_;
  }

  bool getVerbose() const
  {
    return verbose_;
  }

  virtual void setVerbose(bool verbose)
  {
    verbose_ = verbose;
  }

  virtual const std::string& getName() const = 0;

protected:
  virtual void clear();

  bool is_valid_;  

  planning_scene::PlanningSceneConstPtr scene_;
  const robot_model::JointModelGroup* const jmg_;
  std::vector<std::string> frame_depends_;
  robot_state::GroupStateValidityCallbackFn group_state_validity_callback_;
  bool verbose_;  
};
}  // namespace constraint_samplers

#endif