FunctionState Class Reference

#include <FunctionState.h>

Inheritance diagram for FunctionState:

Collaboration diagram for FunctionState:

Public Member Functions
	FunctionState (const QString &stateName, QState *parentState, std::function< void()>)
	Executes a function when the state is entered.
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.

Additional Inherited Members
Public Types inherited from QGCAbstractState
using	EntryCallback = std::function< void()>
using	ExitCallback = std::function< void()>
using	EventHandler = std::function< bool(QEvent *)>
Signals inherited from QGCAbstractState
void	advance ()
void	error ()
Protected Member Functions inherited from QGCAbstractState
virtual void	onEnter ()
	Override to perform actions on state entry.
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

Definition at line 7 of file FunctionState.h.

Constructor & Destructor Documentation

FunctionState()

FunctionState::FunctionState	(	const QString &	stateName,
		QState *	parentState,
		std::function< void()>	function
	)

Executes a function when the state is entered.

Definition at line 6 of file FunctionState.cc.

References QGCAbstractState::advance().

---

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

• src/Utilities/StateMachine/States/FunctionState.h
• src/Utilities/StateMachine/States/FunctionState.cc