ErrorRecoveryState Class Reference

The state created by ErrorRecoveryBuilder. More...

#include <ErrorRecoveryBuilder.h>

Inheritance diagram for ErrorRecoveryState:

Collaboration diagram for ErrorRecoveryState:

Public Types
using	Action = std::function< bool()>
using	VoidAction = std::function< void()>
Public Types inherited from QGCAbstractState
using	EntryCallback = std::function< void()>
using	ExitCallback = std::function< void()>
using	EventHandler = std::function< bool(QEvent *)>

Signals
void	retrying (int attempt, int maxAttempts)
void	tryingFallback ()
void	rollingBack ()
void	succeeded ()
void	exhausted ()
Signals inherited from QGCAbstractState
void	advance ()
void	error ()

Public Member Functions
	ErrorRecoveryState (const QString &stateName, QState *parent)
void	setAction (Action action)
void	setFallback (Action fallback)
void	setRollback (VoidAction rollback)
void	setRetry (int maxRetries, int delayMsecs)
void	setTimeout (int timeoutMsecs)
void	setExhaustedBehavior (ErrorRecoveryBuilder::ExhaustedBehavior behavior)
QString	successPhase () const
	Get the phase that succeeded (if any)
Public Member Functions inherited from QGCState
	QGCState (const QString &stateName, QState *parentState)
template<typename PointerToMemberFunction >
QSignalTransition *	addThisTransition (PointerToMemberFunction signal, QAbstractState *target)
	Simpler version of QState::addTransition which assumes the sender is this.
void	setLocalErrorState (QAbstractState *errorState)
QAbstractState *	localErrorState () const
	Get the per-state error state (nullptr if using global)
void	setProperty (QObject *object, const char *name, const QVariant &value)
void	setEnabled (QObject *object, bool enabled)
	Convenience overload for setting enabled state on widgets/controls.
void	setVisible (QObject *object, bool visible)
	Convenience overload for setting visible state on widgets/controls.
Public Member Functions inherited from QGCAbstractState
	QGCAbstractState (const QString &stateName, QState *parent)
QGCStateMachine *	machine () const
Vehicle *	vehicle () const
QString	stateName () const
class StateContext *	context () const
void	setOnEntry (EntryCallback callback)
	Set a callback to be invoked when the state is entered.
void	setOnExit (ExitCallback callback)
	Set a callback to be invoked when the state is exited.
void	setCallbacks (EntryCallback onEntry, ExitCallback onExit=nullptr)
	Set both entry and exit callbacks.
void	setEventHandler (EventHandler handler)
	Set a custom event handler for this state.

Protected Member Functions
void	onEnter () override
	Override to perform actions on state entry.
Protected Member Functions inherited from QGCAbstractState
virtual void	onLeave ()
	Override to perform actions on state exit.
void	onEntry (QEvent *event) override
void	onExit (QEvent *event) override
bool	event (QEvent *event) override

Detailed Description

The state created by ErrorRecoveryBuilder.

Definition at line 78 of file ErrorRecoveryBuilder.h.

Member Typedef Documentation

Action

using ErrorRecoveryState::Action = std::function<bool()>

Definition at line 84 of file ErrorRecoveryBuilder.h.

VoidAction

using ErrorRecoveryState::VoidAction = std::function<void()>

Definition at line 85 of file ErrorRecoveryBuilder.h.

Constructor & Destructor Documentation

ErrorRecoveryState()

ErrorRecoveryState::ErrorRecoveryState	(	const QString &	stateName,
		QState *	parent
	)

Definition at line 71 of file ErrorRecoveryBuilder.cc.

Member Function Documentation

exhausted

void ErrorRecoveryState::exhausted ( )

signal

onEnter()

void ErrorRecoveryState::onEnter ( )

overrideprotectedvirtual

Override to perform actions on state entry.

Reimplemented from QGCAbstractState.

Definition at line 97 of file ErrorRecoveryBuilder.cc.

retrying

void ErrorRecoveryState::retrying ( int  attempt, int  maxAttempts  )

signal

rollingBack

void ErrorRecoveryState::rollingBack ( )

signal

setAction()

void ErrorRecoveryState::setAction ( Action  action )

inline

Definition at line 89 of file ErrorRecoveryBuilder.h.

setExhaustedBehavior()

void ErrorRecoveryState::setExhaustedBehavior

(

ErrorRecoveryBuilder::ExhaustedBehavior

behavior

)

Definition at line 92 of file ErrorRecoveryBuilder.cc.

setFallback()

void ErrorRecoveryState::setFallback ( Action  fallback )

inline

Definition at line 90 of file ErrorRecoveryBuilder.h.

setRetry()

void ErrorRecoveryState::setRetry	(	int	maxRetries,
		int	delayMsecs
	)

Definition at line 81 of file ErrorRecoveryBuilder.cc.

setRollback()

void ErrorRecoveryState::setRollback ( VoidAction  rollback )

inline

Definition at line 91 of file ErrorRecoveryBuilder.h.

setTimeout()

void ErrorRecoveryState::setTimeout

(

int

timeoutMsecs

)

Definition at line 87 of file ErrorRecoveryBuilder.cc.

succeeded

void ErrorRecoveryState::succeeded ( )

signal

successPhase()

QString ErrorRecoveryState::successPhase ( ) const

inline

Get the phase that succeeded (if any)

Definition at line 97 of file ErrorRecoveryBuilder.h.

tryingFallback

void ErrorRecoveryState::tryingFallback ( )

signal

---

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

• src/Utilities/StateMachine/Helpers/ErrorRecoveryBuilder.h
• src/Utilities/StateMachine/Helpers/ErrorRecoveryBuilder.cc