comm_state.h
Go to the documentation of this file.
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2008, Willow Garage, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the Willow Garage nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 #ifndef ACTIONLIB__CLIENT__COMM_STATE_H_
36 #define ACTIONLIB__CLIENT__COMM_STATE_H_
37 
38 #include <string>
39 #include "ros/console.h"
40 
41 namespace actionlib
42 {
43 
47 class CommState
48 {
49 public:
51  enum StateEnum
52  {
54  PENDING = 1,
55  ACTIVE = 2,
58  RECALLING = 5,
60  DONE = 7
61  };
62 
63  CommState(const StateEnum & state)
64  : state_(state) {}
65 
66  inline bool operator==(const CommState & rhs) const
67  {
68  return state_ == rhs.state_;
69  }
70 
71  inline bool operator==(const CommState::StateEnum & rhs) const
72  {
73  return state_ == rhs;
74  }
75 
76  inline bool operator!=(const CommState::StateEnum & rhs) const
77  {
78  return !(*this == rhs);
79  }
80 
81  inline bool operator!=(const CommState & rhs) const
82  {
83  return !(*this == rhs);
84  }
85 
86  std::string toString() const
87  {
88  switch (state_) {
90  return "WAITING_FOR_GOAL_ACK";
91  case PENDING:
92  return "PENDING";
93  case ACTIVE:
94  return "ACTIVE";
95  case WAITING_FOR_RESULT:
96  return "WAITING_FOR_RESULT";
98  return "WAITING_FOR_CANCEL_ACK";
99  case RECALLING:
100  return "RECALLING";
101  case PREEMPTING:
102  return "PREEMPTING";
103  case DONE:
104  return "DONE";
105  default:
106  ROS_ERROR_NAMED("actionlib", "BUG: Unhandled CommState: %u", state_);
107  break;
108  }
109  return "BUG-UNKNOWN";
110  }
111 
113 
114 private:
115  CommState();
116 };
117 
118 } // namespace actionlib
119 
120 #endif // ACTIONLIB__CLIENT__COMM_STATE_H_
bool operator!=(const CommState::StateEnum &rhs) const
Definition: comm_state.h:76
CommState(const StateEnum &state)
Definition: comm_state.h:63
bool operator!=(const CommState &rhs) const
Definition: comm_state.h:81
StateEnum
Defines the various states the Communication State Machine can be in.
Definition: comm_state.h:51
std::string toString() const
Definition: comm_state.h:86
Thin wrapper around an enum in order to help interpret the state of the communication state machine...
Definition: comm_state.h:47
bool operator==(const CommState &rhs) const
Definition: comm_state.h:66
#define ROS_ERROR_NAMED(name,...)
bool operator==(const CommState::StateEnum &rhs) const
Definition: comm_state.h:71


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep, Mikael Arguedas
autogenerated on Tue Sep 3 2019 03:41:41