Public Member Functions | Private Attributes | List of all members
rsm::BootState Class Reference

State being active until all vital systems are running and ready. More...

#include <BootState.h>

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

Public Member Functions

 BootState ()
 Constructor. More...
 
void onActive ()
 Process method (step-wise, never block this method) More...
 
void onEntry ()
 Called once when activated. More...
 
void onExit ()
 Called once when left. More...
 
void onExplorationStart (bool &success, std::string &message)
 
void onExplorationStop (bool &success, std::string &message)
 Called when exploration was stopped manually. More...
 
void onInterrupt (int interrupt)
 Called when an operation mode interrupt was received. More...
 
void onSetup ()
 Called once when registered at StateInterface. More...
 
void onWaypointFollowingStartStop (bool &success, std::string &message)
 
 ~BootState ()
 Destructor. More...
 
- Public Member Functions inherited from rsm::BaseState
 BaseState ()
 
std::string getName ()
 
StateInterfacegetStateInterface ()
 
virtual void onWaypointFollowingStart (bool &success, std::string &message)
 
virtual void onWaypointFollowingStop (bool &success, std::string &message)
 
void setStateInterface (StateInterface *stateinterface)
 
virtual ~BaseState ()
 

Private Attributes

ros::ServiceClient _bootupClient
 

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 until all vital systems are running and ready.

Definition at line 16 of file BootState.h.

Constructor & Destructor Documentation

rsm::BootState::BootState ( )

Constructor.

Definition at line 5 of file BootState.cpp.

rsm::BootState::~BootState ( )

Destructor.

Definition at line 8 of file BootState.cpp.

Member Function Documentation

void rsm::BootState::onActive ( )
virtual

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

Implements rsm::BaseState.

Definition at line 22 of file BootState.cpp.

void rsm::BootState::onEntry ( )
virtual

Called once when activated.

Reimplemented from rsm::BaseState.

Definition at line 19 of file BootState.cpp.

void rsm::BootState::onExit ( )
virtual

Called once when left.

Reimplemented from rsm::BaseState.

Definition at line 36 of file BootState.cpp.

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

Called when exploration was started manually

Reimplemented from rsm::BaseState.

Definition at line 39 of file BootState.cpp.

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

Called when exploration was stopped manually.

Reimplemented from rsm::BaseState.

Definition at line 44 of file BootState.cpp.

void rsm::BootState::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 55 of file BootState.cpp.

void rsm::BootState::onSetup ( )
virtual

Called once when registered at StateInterface.

Reimplemented from rsm::BaseState.

Definition at line 11 of file BootState.cpp.

void rsm::BootState::onWaypointFollowingStartStop ( bool &  success,
std::string &  message 
)

Called when waypoint following was started/paused manually

Definition at line 49 of file BootState.cpp.

Member Data Documentation

ros::ServiceClient rsm::BootState::_bootupClient
private

Definition at line 72 of file BootState.h.


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