Public Types | Public Member Functions | Public Attributes
actionlib::SimpleClientGoalState Class Reference

#include <simple_client_goal_state.h>

List of all members.

Public Types

enum  StateEnum {
  PENDING, ACTIVE, RECALLED, REJECTED,
  PREEMPTED, ABORTED, SUCCEEDED, LOST
}
 Defines the various states the goal can be in. More...

Public Member Functions

std::string getText () const
bool isDone () const
 Determine if goal is done executing (ie. reached a terminal state)
bool operator!= (const SimpleClientGoalState::StateEnum &rhs) const
bool operator!= (const SimpleClientGoalState &rhs) const
bool operator== (const SimpleClientGoalState &rhs) const
bool operator== (const SimpleClientGoalState::StateEnum &rhs) const
 SimpleClientGoalState (const StateEnum &state, const std::string &text=std::string(""))
std::string toString () const
 Convert the state to a string. Useful when printing debugging information.

Public Attributes

StateEnum state_
std::string text_

Detailed Description

Definition at line 43 of file simple_client_goal_state.h.


Member Enumeration Documentation

Defines the various states the goal can be in.

Enumerator:
PENDING 
ACTIVE 
RECALLED 
REJECTED 
PREEMPTED 
ABORTED 
SUCCEEDED 
LOST 

Definition at line 47 of file simple_client_goal_state.h.


Constructor & Destructor Documentation

actionlib::SimpleClientGoalState::SimpleClientGoalState ( const StateEnum state,
const std::string &  text = std::string("") 
) [inline]

Definition at line 62 of file simple_client_goal_state.h.


Member Function Documentation

std::string actionlib::SimpleClientGoalState::getText ( ) const [inline]

Definition at line 105 of file simple_client_goal_state.h.

Determine if goal is done executing (ie. reached a terminal state)

Returns:
True if in RECALLED, REJECTED, PREEMPTED, ABORTED, SUCCEEDED, or LOST. False otherwise

Definition at line 90 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::operator!= ( const SimpleClientGoalState::StateEnum rhs) const [inline]

Definition at line 76 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::operator!= ( const SimpleClientGoalState rhs) const [inline]

Definition at line 81 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::operator== ( const SimpleClientGoalState rhs) const [inline]

Definition at line 66 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::operator== ( const SimpleClientGoalState::StateEnum rhs) const [inline]

Definition at line 71 of file simple_client_goal_state.h.

std::string actionlib::SimpleClientGoalState::toString ( ) const [inline]

Convert the state to a string. Useful when printing debugging information.

Definition at line 111 of file simple_client_goal_state.h.


Member Data Documentation

Definition at line 59 of file simple_client_goal_state.h.

Definition at line 60 of file simple_client_goal_state.h.


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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Tue May 22 2018 02:25:39