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

State being active while the robot is teleoperated. More...

#include <TeleoperationState.h>

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

Public Member Functions

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)
 
 TeleoperationState ()
 
 ~TeleoperationState ()
 
- 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 while the robot is teleoperated.

Definition at line 15 of file TeleoperationState.h.

Constructor & Destructor Documentation

rsm::TeleoperationState::TeleoperationState ( )

Constructor

Definition at line 5 of file TeleoperationState.cpp.

rsm::TeleoperationState::~TeleoperationState ( )

Destructor

Definition at line 8 of file TeleoperationState.cpp.

Member Function Documentation

void rsm::TeleoperationState::onActive ( )
virtual

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

Implements rsm::BaseState.

Definition at line 18 of file TeleoperationState.cpp.

void rsm::TeleoperationState::onEntry ( )
virtual

Called once when activated

Reimplemented from rsm::BaseState.

Definition at line 15 of file TeleoperationState.cpp.

void rsm::TeleoperationState::onExit ( )
virtual

Called once when left

Reimplemented from rsm::BaseState.

Definition at line 21 of file TeleoperationState.cpp.

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

Called when exploration was started manually

Reimplemented from rsm::BaseState.

Definition at line 24 of file TeleoperationState.cpp.

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

Called when exploration was stopped manually

Reimplemented from rsm::BaseState.

Definition at line 30 of file TeleoperationState.cpp.

void rsm::TeleoperationState::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 48 of file TeleoperationState.cpp.

void rsm::TeleoperationState::onSetup ( )
virtual

Called once when registered at StateInterface

Reimplemented from rsm::BaseState.

Definition at line 11 of file TeleoperationState.cpp.

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

Called when waypoint following was started/paused manually

Reimplemented from rsm::BaseState.

Definition at line 36 of file TeleoperationState.cpp.

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

Called when waypoint following was stopped manually

Reimplemented from rsm::BaseState.

Definition at line 42 of file TeleoperationState.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