controller_manager.h
Go to the documentation of this file.
00001 /*********************************************************************
00002 * Software License Agreement (BSD License)
00003 *
00004 *  Copyright (c) 2012, Willow Garage, Inc.
00005 *  All rights reserved.
00006 *
00007 *  Redistribution and use in source and binary forms, with or without
00008 *  modification, are permitted provided that the following conditions
00009 *  are met:
00010 *
00011 *   * Redistributions of source code must retain the above copyright
00012 *     notice, this list of conditions and the following disclaimer.
00013 *   * Redistributions in binary form must reproduce the above
00014 *     copyright notice, this list of conditions and the following
00015 *     disclaimer in the documentation and/or other materials provided
00016 *     with the distribution.
00017 *   * Neither the name of the Willow Garage nor the names of its
00018 *     contributors may be used to endorse or promote products derived
00019 *     from this software without specific prior written permission.
00020 *
00021 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032 *  POSSIBILITY OF SUCH DAMAGE.
00033 *********************************************************************/
00034 
00035 /* Author: Ioan Sucan */
00036 
00037 #ifndef MOVEIT_MOVEIT_CONTROLLER_MANAGER_
00038 #define MOVEIT_MOVEIT_CONTROLLER_MANAGER_
00039 
00040 #include <vector>
00041 #include <string>
00042 #include <boost/shared_ptr.hpp>
00043 #include <moveit_msgs/RobotTrajectory.h>
00044 
00046 namespace moveit_controller_manager
00047 {
00048 
00050 struct ExecutionStatus
00051 {
00052   enum Value
00053     {
00054       UNKNOWN, RUNNING, SUCCEEDED, PREEMPTED, TIMED_OUT, ABORTED, FAILED
00055     };
00056 
00057   ExecutionStatus(Value value = UNKNOWN) : status_(value)
00058   {
00059   }
00060 
00061   operator Value() const
00062   {
00063     return status_;
00064   }
00065 
00066   operator bool() const
00067   {
00068     return status_ == SUCCEEDED;
00069   }
00070 
00072   std::string asString() const
00073   {
00074     switch (status_)
00075     {
00076     case RUNNING:
00077       return "RUNNING";
00078     case SUCCEEDED:
00079       return "SUCCEEDED";
00080     case PREEMPTED:
00081       return "PREEMPTED";
00082     case TIMED_OUT:
00083       return "TIMED_OUT";
00084     case ABORTED:
00085       return "ABORTED";
00086     case FAILED:
00087       return "FAILED";
00088     default:
00089       return "UNKNOWN";
00090     }
00091   }
00092 private:
00093   Value status_;
00094 };
00095 
00097 class MoveItControllerHandle
00098 {
00099 public:
00100 
00102   MoveItControllerHandle(const std::string &name) : name_(name)
00103   {
00104   }
00105 
00106   virtual ~MoveItControllerHandle()
00107   {
00108   }
00109 
00111   const std::string& getName() const
00112   {
00113     return name_;
00114   }
00115 
00117   virtual bool sendTrajectory(const moveit_msgs::RobotTrajectory &trajectory) = 0;
00118 
00120   virtual bool cancelExecution() = 0;
00121 
00123   virtual bool waitForExecution(const ros::Duration &timeout = ros::Duration(0)) = 0;
00124 
00126   virtual ExecutionStatus getLastExecutionStatus() = 0;
00127 
00128 protected:
00129 
00130   std::string name_;
00131 
00132 };
00133 
00134 typedef boost::shared_ptr<MoveItControllerHandle> MoveItControllerHandlePtr;
00135 typedef boost::shared_ptr<const MoveItControllerHandle> MoveItControllerHandleConstPtr;
00136 
00144 class MoveItControllerManager
00145 {
00146 public:
00147 
00150   struct ControllerState
00151   {
00152     ControllerState() : active_(false),
00153                         default_(false)
00154     {
00155     }
00156 
00159     bool active_;
00160 
00163     bool default_;
00164   };
00165 
00167   MoveItControllerManager()
00168   {
00169   }
00170 
00171   virtual ~MoveItControllerManager()
00172   {
00173   }
00174 
00176   virtual MoveItControllerHandlePtr getControllerHandle(const std::string &name) = 0;
00177 
00179   virtual void getControllersList(std::vector<std::string> &names) = 0;
00180 
00182   virtual void getActiveControllers(std::vector<std::string> &names) = 0;
00183 
00185   virtual void getControllerJoints(const std::string &name, std::vector<std::string> &joints) = 0;
00186 
00188   virtual ControllerState getControllerState(const std::string &name) = 0;
00189 
00191   virtual bool switchControllers(const std::vector<std::string> &activate, const std::vector<std::string> &deactivate) = 0;
00192 };
00193 
00194 typedef boost::shared_ptr<MoveItControllerManager> MoveItControllerManagerPtr;
00195 typedef boost::shared_ptr<const MoveItControllerManager> MoveItControllerManagerConstPtr;
00196 
00197 }
00198 
00199 #endif


moveit_core
Author(s): Ioan Sucan , Sachin Chitta , Acorn Pooley
autogenerated on Mon Oct 6 2014 02:24:46