Program Listing for File planning_groups.hpp

↰ Return to documentation for file (include/moveit_setup_srdf_plugins/planning_groups.hpp)

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2021, PickNik Robotics
 *  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 PickNik Robotics 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: David V. Lu!! */
#pragma once

#include <moveit_setup_srdf_plugins/srdf_step.hpp>
#include <moveit_setup_srdf_plugins/group_meta_config.hpp>
#include <moveit/robot_model/robot_model.h>
#include <vector>

namespace moveit_setup
{
namespace srdf_setup
{
class LinkNameTree
{
public:
  std::string data;
  std::vector<LinkNameTree> children;
};

inline LinkNameTree buildLinkNameTree(const moveit::core::LinkModel* link)
{
  LinkNameTree node;
  node.data = link->getName();

  for (const auto& child_joint : link->getChildJointModels())
  {
    node.children.push_back(buildLinkNameTree(child_joint->getChildLinkModel()));
  }
  return node;
}

class PlanningGroups : public SuperSRDFStep<srdf::Model::Group>
{
public:
  std::string getName() const override
  {
    return "Planning Groups";
  }

  std::vector<srdf::Model::Group>& getContainer() override
  {
    return srdf_config_->getGroups();
  }

  InformationFields getInfoField() const override
  {
    return GROUPS;
  }

  void onInit() override;

  std::vector<srdf::Model::Group>& getGroups()
  {
    return srdf_config_->getGroups();
  }

  void renameGroup(const std::string& old_group_name, const std::string& new_group_name);
  void deleteGroup(const std::string& group_name);

  void setJoints(const std::string& group_name, const std::vector<std::string>& joint_names);

  void setLinks(const std::string& group_name, const std::vector<std::string>& link_names);

  void setChain(const std::string& group_name, const std::string& base, const std::string& tip);

  void setSubgroups(const std::string& selected_group_name, const std::vector<std::string>& subgroups);

  const GroupMetaData& getMetaData(const std::string& group_name) const
  {
    return group_meta_config_->getMetaData(group_name);
  }

  void setMetaData(const std::string& group_name, const GroupMetaData& meta_data)
  {
    group_meta_config_->setMetaData(group_name, meta_data);
  }

  std::vector<std::string> getGroupNames() const
  {
    return srdf_config_->getGroupNames();
  }

  const std::vector<std::string>& getJointNames() const
  {
    return srdf_config_->getRobotModel()->getJointModelNames();
  }

  const std::vector<std::string>& getLinkNames() const
  {
    return srdf_config_->getRobotModel()->getLinkModelNames();
  }

  std::string getChildOfJoint(const std::string& joint_name) const;
  std::string getJointType(const std::string& joint_name) const;
  LinkNameTree getLinkNameTree() const;
  std::vector<std::string> getPosesByGroup(const std::string& group_name) const;
  std::vector<std::string> getEndEffectorsByGroup(const std::string& group_name) const;
  std::vector<std::string> getKinematicPlanners() const;
  std::vector<std::string> getOMPLPlanners() const;

protected:
  std::shared_ptr<GroupMetaConfig> group_meta_config_;
};
}  // namespace srdf_setup
}  // namespace moveit_setup