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

#include <terminal_state.h>

Public Types

enum  StateEnum {
  RECALLED, REJECTED, PREEMPTED, ABORTED,
  SUCCEEDED, LOST
}
 

Public Member Functions

std::string getText () const
 
bool operator!= (const TerminalState::StateEnum &rhs) const
 
bool operator!= (const TerminalState &rhs) const
 
bool operator== (const TerminalState &rhs) const
 
bool operator== (const TerminalState::StateEnum &rhs) const
 
 TerminalState (const StateEnum &state, const std::string &text=std::string(""))
 
std::string toString () const
 

Public Attributes

StateEnum state_
 
std::string text_
 

Private Member Functions

 TerminalState ()
 

Detailed Description

Definition at line 44 of file terminal_state.h.

Member Enumeration Documentation

◆ StateEnum

Enumerator
RECALLED 
REJECTED 
PREEMPTED 
ABORTED 
SUCCEEDED 
LOST 

Definition at line 47 of file terminal_state.h.

Constructor & Destructor Documentation

◆ TerminalState() [1/2]

actionlib::TerminalState::TerminalState ( const StateEnum state,
const std::string &  text = std::string("") 
)
inline

Definition at line 57 of file terminal_state.h.

◆ TerminalState() [2/2]

actionlib::TerminalState::TerminalState ( )
private

Member Function Documentation

◆ getText()

std::string actionlib::TerminalState::getText ( ) const
inline

Definition at line 80 of file terminal_state.h.

◆ operator!=() [1/2]

bool actionlib::TerminalState::operator!= ( const TerminalState::StateEnum rhs) const
inline

Definition at line 70 of file terminal_state.h.

◆ operator!=() [2/2]

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

Definition at line 75 of file terminal_state.h.

◆ operator==() [1/2]

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

Definition at line 60 of file terminal_state.h.

◆ operator==() [2/2]

bool actionlib::TerminalState::operator== ( const TerminalState::StateEnum rhs) const
inline

Definition at line 65 of file terminal_state.h.

◆ toString()

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

Definition at line 85 of file terminal_state.h.

Member Data Documentation

◆ state_

StateEnum actionlib::TerminalState::state_

Definition at line 108 of file terminal_state.h.

◆ text_

std::string actionlib::TerminalState::text_

Definition at line 109 of file terminal_state.h.


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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep, Mikael Arguedas
autogenerated on Mon Feb 28 2022 21:34:39