actionlib::SimpleGoalState Class Reference

Thin wrapper around an enum in order providing a simplified version of the communication state, but with less states than CommState. More...

#include <simple_goal_state.h>

List of all members.

Public Types

enum  StateEnum { PENDING, ACTIVE, DONE }
 

Defines the various states the SimpleGoalState can be in.

More...

Public Member Functions

bool operator!= (const SimpleGoalState &rhs) const
bool operator!= (const SimpleGoalState::StateEnum &rhs) const
bool operator== (const SimpleGoalState::StateEnum &rhs) const
bool operator== (const SimpleGoalState &rhs) const
 SimpleGoalState (const StateEnum &state)
std::string toString () const

Public Attributes

StateEnum state_

Private Member Functions

 SimpleGoalState ()

Detailed Description

Thin wrapper around an enum in order providing a simplified version of the communication state, but with less states than CommState.

Definition at line 48 of file simple_goal_state.h.


Member Enumeration Documentation

Defines the various states the SimpleGoalState can be in.

Enumerator:
PENDING 
ACTIVE 
DONE 

Definition at line 53 of file simple_goal_state.h.


Constructor & Destructor Documentation

actionlib::SimpleGoalState::SimpleGoalState ( const StateEnum state  )  [inline]

Definition at line 60 of file simple_goal_state.h.

actionlib::SimpleGoalState::SimpleGoalState (  )  [private]

Member Function Documentation

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

Definition at line 77 of file simple_goal_state.h.

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

Definition at line 72 of file simple_goal_state.h.

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

Definition at line 67 of file simple_goal_state.h.

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

Definition at line 62 of file simple_goal_state.h.

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

Definition at line 82 of file simple_goal_state.h.


Member Data Documentation

Definition at line 99 of file simple_goal_state.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Fri Jan 11 09:41:44 2013