Public Member Functions | List of all members
rsm::EmergencyStopState Class Reference

State being active when the software emergency stop was pushed in the GUI. More...

#include <EmergencyStopState.h>

Inheritance diagram for rsm::EmergencyStopState:
Inheritance graph
[legend]

Public Member Functions

 EmergencyStopState ()
 
void onActive ()
 
void onEntry ()
 
void onExit ()
 
void onExplorationStart (bool &success, std::string &message)
 
void onExplorationStop (bool &success, std::string &message)
 
void onInterrupt (int interrupt)
 Called when an operation mode interrupt was received. More...
 
void onSetup ()
 
void onWaypointFollowingStart (bool &success, std::string &message)
 
void onWaypointFollowingStop (bool &success, std::string &message)
 
 ~EmergencyStopState ()
 
- Public Member Functions inherited from rsm::BaseState
 BaseState ()
 
std::string getName ()
 
StateInterfacegetStateInterface ()
 
void setStateInterface (StateInterface *stateinterface)
 
virtual ~BaseState ()
 

Additional Inherited Members

- Protected Attributes inherited from rsm::BaseState
bool _interrupt_occured
 Shows if an interupt occured. More...
 
std::string _name
 Name of the state. More...
 
StateInterface_stateinterface
 Pointer to State Interface handling all state transitions. More...
 

Detailed Description

State being active when the software emergency stop was pushed in the GUI.

Definition at line 14 of file EmergencyStopState.h.

Constructor & Destructor Documentation

rsm::EmergencyStopState::EmergencyStopState ( )

Constructor

Definition at line 4 of file EmergencyStopState.cpp.

rsm::EmergencyStopState::~EmergencyStopState ( )

Destructor

Definition at line 7 of file EmergencyStopState.cpp.

Member Function Documentation

void rsm::EmergencyStopState::onActive ( )
virtual

Process method (step-wise, never block this method)

Implements rsm::BaseState.

Definition at line 17 of file EmergencyStopState.cpp.

void rsm::EmergencyStopState::onEntry ( )
virtual

Called once when activated

Reimplemented from rsm::BaseState.

Definition at line 14 of file EmergencyStopState.cpp.

void rsm::EmergencyStopState::onExit ( )
virtual

Called once when left

Reimplemented from rsm::BaseState.

Definition at line 20 of file EmergencyStopState.cpp.

void rsm::EmergencyStopState::onExplorationStart ( bool &  success,
std::string &  message 
)
virtual

Called when exploration was started manually

Reimplemented from rsm::BaseState.

Definition at line 23 of file EmergencyStopState.cpp.

void rsm::EmergencyStopState::onExplorationStop ( bool &  success,
std::string &  message 
)
virtual

Called when exploration was stopped manually

Reimplemented from rsm::BaseState.

Definition at line 29 of file EmergencyStopState.cpp.

void rsm::EmergencyStopState::onInterrupt ( int  interrupt)
virtual

Called when an operation mode interrupt was received.

Parameters
interruptKind of interrupt (0=EmergencyStop, 1=TeleoperationInterupt)

Reimplemented from rsm::BaseState.

Definition at line 47 of file EmergencyStopState.cpp.

void rsm::EmergencyStopState::onSetup ( )
virtual

Called once when registered at StateInterface

Reimplemented from rsm::BaseState.

Definition at line 10 of file EmergencyStopState.cpp.

void rsm::EmergencyStopState::onWaypointFollowingStart ( bool &  success,
std::string &  message 
)
virtual

Called when waypoint following was started/paused manually

Reimplemented from rsm::BaseState.

Definition at line 35 of file EmergencyStopState.cpp.

void rsm::EmergencyStopState::onWaypointFollowingStop ( bool &  success,
std::string &  message 
)
virtual

Called when waypoint following was stopped manually

Reimplemented from rsm::BaseState.

Definition at line 41 of file EmergencyStopState.cpp.


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


rsm_core
Author(s): Marco Steinbrink
autogenerated on Tue Mar 16 2021 02:44:31