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 45 of file simple_client_goal_state.h.

---

Member Enumeration Documentation

enum actionlib::SimpleClientGoalState::StateEnum

Defines the various states the goal can be in.

Enumerator:

PENDING
ACTIVE
RECALLED
REJECTED
PREEMPTED
ABORTED
SUCCEEDED
LOST

Definition at line 49 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 64 of file simple_client_goal_state.h.

---

Member Function Documentation

std::string actionlib::SimpleClientGoalState::getText

(

)

const [inline]

Definition at line 107 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::isDone

(

)

const [inline]

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 92 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::operator!=

(

const SimpleClientGoalState::StateEnum &

rhs

)

const [inline]

Definition at line 78 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::operator!=

(

const SimpleClientGoalState &

rhs

)

const [inline]

Definition at line 83 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::operator==

(

const SimpleClientGoalState &

rhs

)

const [inline]

Definition at line 68 of file simple_client_goal_state.h.

bool actionlib::SimpleClientGoalState::operator==

(

const SimpleClientGoalState::StateEnum &

rhs

)

const [inline]

Definition at line 73 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 113 of file simple_client_goal_state.h.

---

Member Data Documentation

StateEnum actionlib::SimpleClientGoalState::state_

Definition at line 61 of file simple_client_goal_state.h.

std::string actionlib::SimpleClientGoalState::text_

Definition at line 62 of file simple_client_goal_state.h.

---

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

• simple_client_goal_state.h