Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
actionlib::ClientGoalStatus Class Reference

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 (StateEnum state)
 
 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}. More...
 
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}. More...
 
bool isDone () const
 Check if the goal is in a terminal state. More...
 
bool operator!= (const ClientGoalStatus &rhs) const
 Straightforward enum inequality check. More...
 
const StateEnumoperator= (const StateEnum &state)
 Copy the raw enum into the object. More...
 
bool operator== (const ClientGoalStatus &rhs) const
 Straightforward enum equality check. More...
 
std::string toString () const
 Stringify the enum. More...
 

Private Member Functions

 ClientGoalStatus ()
 Need to always specific an initial state. Thus, no empty constructor. More...
 

Private Attributes

StateEnum state_
 

Detailed Description

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 51 of file client_goal_status.h.

Member Enumeration Documentation

Defines the various states the Goal can be in, as perceived by the client.

Enumerator
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 55 of file client_goal_status.h.

Constructor & Destructor Documentation

actionlib::ClientGoalStatus::ClientGoalStatus ( StateEnum  state)
inline

Definition at line 66 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}.

Parameters
goal_statusThe GoalStatus msg that we want to convert

Definition at line 77 of file client_goal_status.h.

actionlib::ClientGoalStatus::ClientGoalStatus ( )
private

Need to always specific an initial state. Thus, no empty constructor.

Member Function Documentation

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}.

Parameters
goal_statusThe GoalStatus msg that we want to convert

Definition at line 125 of file client_goal_status.h.

bool actionlib::ClientGoalStatus::isDone ( ) const
inline

Check if the goal is in a terminal state.

Returns
TRUE if in PREEMPTED, SUCCEDED, ABORTED, REJECTED, or LOST

Definition at line 86 of file client_goal_status.h.

bool actionlib::ClientGoalStatus::operator!= ( const ClientGoalStatus rhs) const
inline

Straightforward enum inequality check.

Definition at line 114 of file client_goal_status.h.

const StateEnum& actionlib::ClientGoalStatus::operator= ( const StateEnum state)
inline

Copy the raw enum into the object.

Definition at line 97 of file client_goal_status.h.

bool actionlib::ClientGoalStatus::operator== ( const ClientGoalStatus rhs) const
inline

Straightforward enum equality check.

Definition at line 106 of file client_goal_status.h.

std::string actionlib::ClientGoalStatus::toString ( ) const
inline

Stringify the enum.

Returns
String that has the name of the enum

Definition at line 147 of file client_goal_status.h.

Member Data Documentation

StateEnum actionlib::ClientGoalStatus::state_
private

Definition at line 172 of file client_goal_status.h.


The documentation for this class was generated from the following file:


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Sat Aug 18 2018 02:45:49