State being active when waiting for new inout. More...

#include <IdleState.h>

Inheritance diagram for rsm::IdleState:

Public Member Functions
	IdleState ()

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)

	~IdleState ()

Public Member Functions inherited from rsm::BaseState
	BaseState ()

std::string	getName ()

StateInterface *	getStateInterface ()

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 waiting for new inout.

Definition at line 16 of file IdleState.h.

Constructor & Destructor Documentation

rsm::IdleState::IdleState ( )

Constructor

Definition at line 5 of file IdleState.cpp.

rsm::IdleState::~IdleState ( )

Destructor

Definition at line 8 of file IdleState.cpp.

Member Function Documentation

void rsm::IdleState::onActive ( )

virtual

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

Implements rsm::BaseState.

Definition at line 18 of file IdleState.cpp.

void rsm::IdleState::onEntry ( )

virtual

Called once when activated

Reimplemented from rsm::BaseState.

Definition at line 15 of file IdleState.cpp.

void rsm::IdleState::onExit ( )

virtual

Called once when left

Reimplemented from rsm::BaseState.

Definition at line 21 of file IdleState.cpp.

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

virtual

Called when exploration was started manually

Reimplemented from rsm::BaseState.

Definition at line 24 of file IdleState.cpp.

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

virtual

Called when exploration was stopped manually

Reimplemented from rsm::BaseState.

Definition at line 33 of file IdleState.cpp.

void rsm::IdleState::onInterrupt ( int interrupt )

virtual

Called when an operation mode interrupt was received.

Parameters

interrupt Kind of interrupt (0=EmergencyStop, 1=TeleoperationInterupt)

Reimplemented from rsm::BaseState.

Definition at line 50 of file IdleState.cpp.

void rsm::IdleState::onSetup ( )

virtual

Called once when registered at StateInterface

Reimplemented from rsm::BaseState.

Definition at line 11 of file IdleState.cpp.

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

virtual

Called when waypoint following was started/paused manually

Reimplemented from rsm::BaseState.

Definition at line 38 of file IdleState.cpp.

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

virtual

Called when waypoint following was stopped manually

Reimplemented from rsm::BaseState.

Definition at line 45 of file IdleState.cpp.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation