terminal_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__TERMINAL_STATE_H_
00036 #define ACTIONLIB__CLIENT__TERMINAL_STATE_H_
00037 
00038 #include <string>
00039 #include "ros/console.h"
00040 
00041 namespace actionlib
00042 {
00043 
00044 class TerminalState
00045 {
00046 public:
00047   enum StateEnum
00048   {
00049     RECALLED,
00050     REJECTED,
00051     PREEMPTED,
00052     ABORTED,
00053     SUCCEEDED,
00054     LOST
00055   };
00056 
00057   TerminalState(const StateEnum & state, const std::string & text = std::string(""))
00058   : state_(state), text_(text) {}
00059 
00060   inline bool operator==(const TerminalState & rhs) const
00061   {
00062     return state_ == rhs.state_;
00063   }
00064 
00065   inline bool operator==(const TerminalState::StateEnum & rhs) const
00066   {
00067     return state_ == rhs;
00068   }
00069 
00070   inline bool operator!=(const TerminalState::StateEnum & rhs) const
00071   {
00072     return !(*this == rhs);
00073   }
00074 
00075   inline bool operator!=(const TerminalState & rhs) const
00076   {
00077     return !(*this == rhs);
00078   }
00079 
00080   std::string getText() const
00081   {
00082     return text_;
00083   }
00084 
00085   std::string toString() const
00086   {
00087     switch (state_) {
00088       case RECALLED:
00089         return "RECALLED";
00090       case REJECTED:
00091         return "REJECTED";
00092       case PREEMPTED:
00093         return "PREEMPTED";
00094       case ABORTED:
00095         return "ABORTED";
00096       case SUCCEEDED:
00097         return "SUCCEEDED";
00098       case LOST:
00099         return "LOST";
00100 
00101       default:
00102         ROS_ERROR_NAMED("actionlib", "BUG: Unhandled TerminalState: %u", state_);
00103         break;
00104     }
00105     return "BUG-UNKNOWN";
00106   }
00107 
00108   StateEnum state_;
00109   std::string text_;
00110 
00111 private:
00112   TerminalState();
00113 };
00114 
00115 }  // namespace actionlib
00116 
00117 #endif  // ACTIONLIB__CLIENT__TERMINAL_STATE_H_


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