simple_client_goal_state.h
Go to the documentation of this file.
00001 /*********************************************************************
00002 * Software License Agreement (BSD License)
00003 *
00004 *  Copyright (c) 2008, 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 #ifndef ACTIONLIB__CLIENT__SIMPLE_CLIENT_GOAL_STATE_H_
00036 #define ACTIONLIB__CLIENT__SIMPLE_CLIENT_GOAL_STATE_H_
00037 
00038 #include <string>
00039 
00040 namespace actionlib
00041 {
00042 
00043 class SimpleClientGoalState
00044 {
00045 public:
00047   enum StateEnum
00048   {
00049     PENDING,
00050     ACTIVE,
00051     RECALLED,
00052     REJECTED,
00053     PREEMPTED,
00054     ABORTED,
00055     SUCCEEDED,
00056     LOST
00057   };
00058 
00059   StateEnum state_;
00060   std::string text_;
00061 
00062   SimpleClientGoalState(const StateEnum & state,
00063     const std::string & text = std::string(""))
00064   : state_(state), text_(text) {}
00065 
00066   inline bool operator==(const SimpleClientGoalState & rhs) const
00067   {
00068     return state_ == rhs.state_;
00069   }
00070 
00071   inline bool operator==(const SimpleClientGoalState::StateEnum & rhs) const
00072   {
00073     return state_ == rhs;
00074   }
00075 
00076   inline bool operator!=(const SimpleClientGoalState::StateEnum & rhs) const
00077   {
00078     return !(*this == rhs);
00079   }
00080 
00081   inline bool operator!=(const SimpleClientGoalState & rhs) const
00082   {
00083     return !(*this == rhs);
00084   }
00085 
00090   inline bool isDone() const
00091   {
00092     switch (state_) {
00093       case RECALLED:
00094       case REJECTED:
00095       case PREEMPTED:
00096       case ABORTED:
00097       case SUCCEEDED:
00098       case LOST:
00099         return true;
00100       default:
00101         return false;
00102     }
00103   }
00104 
00105   std::string getText() const
00106   {
00107     return text_;
00108   }
00109 
00111   std::string toString() const
00112   {
00113     switch (state_) {
00114       case PENDING:
00115         return "PENDING";
00116       case ACTIVE:
00117         return "ACTIVE";
00118       case RECALLED:
00119         return "RECALLED";
00120       case REJECTED:
00121         return "REJECTED";
00122       case PREEMPTED:
00123         return "PREEMPTED";
00124       case ABORTED:
00125         return "ABORTED";
00126       case SUCCEEDED:
00127         return "SUCCEEDED";
00128       case LOST:
00129         return "LOST";
00130       default:
00131         ROS_ERROR_NAMED("actionlib", "BUG: Unhandled SimpleGoalState: %u", state_);
00132         break;
00133     }
00134     return "BUG-UNKNOWN";
00135   }
00136 };
00137 
00138 }  // namespace actionlib
00139 
00140 #endif  // ACTIONLIB__CLIENT__SIMPLE_CLIENT_GOAL_STATE_H_


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Tue Dec 19 2017 03:23:31