Public Types | Public Member Functions | Public Attributes | Private Member Functions
actionlib::CommState Class Reference

Thin wrapper around an enum in order to help interpret the state of the communication state machine. More...

#include <comm_state.h>

List of all members.

Public Types

enum  StateEnum {
  WAITING_FOR_GOAL_ACK = 0, PENDING = 1, ACTIVE = 2, WAITING_FOR_RESULT = 3,
  WAITING_FOR_CANCEL_ACK = 4, RECALLING = 5, PREEMPTING = 6, DONE = 7
}
 Defines the various states the Communication State Machine can be in. More...

Public Member Functions

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

Public Attributes

StateEnum state_

Private Member Functions

 CommState ()

Detailed Description

Thin wrapper around an enum in order to help interpret the state of the communication state machine.

Definition at line 47 of file comm_state.h.


Member Enumeration Documentation

Defines the various states the Communication State Machine can be in.

Enumerator:
WAITING_FOR_GOAL_ACK 
PENDING 
ACTIVE 
WAITING_FOR_RESULT 
WAITING_FOR_CANCEL_ACK 
RECALLING 
PREEMPTING 
DONE 

Definition at line 52 of file comm_state.h.


Constructor & Destructor Documentation

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

Definition at line 64 of file comm_state.h.


Member Function Documentation

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

Definition at line 76 of file comm_state.h.

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

Definition at line 81 of file comm_state.h.

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

Definition at line 66 of file comm_state.h.

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

Definition at line 71 of file comm_state.h.

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

Definition at line 86 of file comm_state.h.


Member Data Documentation

Definition at line 113 of file comm_state.h.


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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Sun Oct 5 2014 22:02:55