Thin wrapper around an enum in order to help interpret the client-side status of a goal request The possible states are defined the ClientGoalStatus::StateEnum. They are also defined in StateEnum. we can also get there from here . More...
#include <client_goal_status.h>
Public Types | |
| enum | StateEnum { PENDING, ACTIVE, PREEMPTED, SUCCEEDED, ABORTED, REJECTED, LOST } |
Defines the various states the Goal can be in, as perceived by the client. More... | |
Public Member Functions | |
| ClientGoalStatus (const GoalStatus &goal_status) | |
| Build a ClientGoalStatus from a GoalStatus. Note that the only GoalStatuses that can be converted into a ClientGoalStatus are {PREEMPTED, SUCCEEDED, ABORTED, REJECTED}. | |
| ClientGoalStatus (StateEnum state) | |
| void | fromGoalStatus (const GoalStatus &goal_status) |
| Store a GoalStatus in a ClientGoalStatus Note that the only GoalStatuses that can be converted into a ClientGoalStatus are {PREEMPTED, SUCCEEDED, ABORTED, REJECTED}. | |
| bool | isDone () const |
| Check if the goal is in a terminal state. | |
| bool | operator!= (const ClientGoalStatus &rhs) |
| Straightforward enum inequality check. | |
| const StateEnum & | operator= (const StateEnum &state) |
| Copy the raw enum into the object. | |
| bool | operator== (const ClientGoalStatus &rhs) |
| Straightforward enum equality check. | |
| std::string | toString () const |
| Stringify the enum. | |
Private Member Functions | |
| ClientGoalStatus () | |
| Need to always specific an initial state. Thus, no empty constructor. | |
Private Attributes | |
| StateEnum | state_ |
Thin wrapper around an enum in order to help interpret the client-side status of a goal request The possible states are defined the ClientGoalStatus::StateEnum. They are also defined in StateEnum. we can also get there from here .
Definition at line 50 of file client_goal_status.h.
Defines the various states the Goal can be in, as perceived by the client.
| PENDING |
The goal has yet to be processed by the action server. |
| ACTIVE |
The goal is currently being processed by the action server. |
| PREEMPTED |
The goal was preempted by either another goal, or a preempt message being sent to the action server. |
| SUCCEEDED |
The goal was achieved successfully by the action server. |
| ABORTED |
The goal was aborted by the action server. |
| REJECTED |
The ActionServer refused to start processing the goal, possibly because a goal is infeasible. |
| LOST |
The goal was sent by the ActionClient, but disappeared due to some communication error. |
Definition at line 54 of file client_goal_status.h.
| actionlib::ClientGoalStatus::ClientGoalStatus | ( | StateEnum | state | ) | [inline] |
Definition at line 65 of file client_goal_status.h.
| actionlib::ClientGoalStatus::ClientGoalStatus | ( | const GoalStatus & | goal_status | ) | [inline] |
Build a ClientGoalStatus from a GoalStatus. Note that the only GoalStatuses that can be converted into a ClientGoalStatus are {PREEMPTED, SUCCEEDED, ABORTED, REJECTED}.
| goal_status | The GoalStatus msg that we want to convert |
Definition at line 76 of file client_goal_status.h.
| actionlib::ClientGoalStatus::ClientGoalStatus | ( | ) | [private] |
Need to always specific an initial state. Thus, no empty constructor.
| void actionlib::ClientGoalStatus::fromGoalStatus | ( | const GoalStatus & | goal_status | ) | [inline] |
Store a GoalStatus in a ClientGoalStatus Note that the only GoalStatuses that can be converted into a ClientGoalStatus are {PREEMPTED, SUCCEEDED, ABORTED, REJECTED}.
| goal_status | The GoalStatus msg that we want to convert |
Definition at line 123 of file client_goal_status.h.
| bool actionlib::ClientGoalStatus::isDone | ( | ) | const [inline] |
Check if the goal is in a terminal state.
Definition at line 85 of file client_goal_status.h.
| bool actionlib::ClientGoalStatus::operator!= | ( | const ClientGoalStatus & | rhs | ) | [inline] |
Straightforward enum inequality check.
Definition at line 112 of file client_goal_status.h.
Copy the raw enum into the object.
Definition at line 95 of file client_goal_status.h.
| bool actionlib::ClientGoalStatus::operator== | ( | const ClientGoalStatus & | rhs | ) | [inline] |
Straightforward enum equality check.
Definition at line 104 of file client_goal_status.h.
| std::string actionlib::ClientGoalStatus::toString | ( | ) | const [inline] |
Stringify the enum.
Definition at line 145 of file client_goal_status.h.
StateEnum actionlib::ClientGoalStatus::state_ [private] |
Definition at line 171 of file client_goal_status.h.
