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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Wed Aug 22 2018 02:38:23