#include <WaitForSignalState.h>

Inheritance diagram for WaitForSignalState:

Collaboration diagram for WaitForSignalState:

Public Member Functions
template<typename Func >
	WaitForSignalState (const QString &stateName, QState parent, typename QtPrivate::FunctionPointer< Func >::Object sender, Func signal, int timeoutMsecs=0)

Public Member Functions inherited from WaitStateBase
	WaitStateBase (const QString &stateName, QState *parent, int timeoutMsecs=0)

void	restartWait ()

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	connectWaitSignal () override
	Subclasses override to set up their signal connections.

void	disconnectWaitSignal () override
	Subclasses override to tear down their signal connections.

Protected Member Functions inherited from WaitStateBase
virtual void	onWaitEntered ()
	Called when the state is entered - subclasses should call base implementation.

virtual void	onWaitExited ()
	Called when the state is exited - subclasses should call base implementation.

virtual void	onWaitTimeout ()
	Called when the timeout expires - default emits timeout(), subclasses can override.

void	waitComplete ()

void	waitFailed ()

int	timeoutMsecs () const

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

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 WaitStateBase
void	completed ()

void	timeout ()

void	timedOut ()

Signals inherited from QGCAbstractState
void	advance ()

void	error ()

Detailed Description

Waits for a signal from a QObject before advancing Can optionally timeout if the signal is not received within a specified time

Definition at line 11 of file WaitForSignalState.h.

Constructor & Destructor Documentation

◆ WaitForSignalState()

template<typename Func >

WaitForSignalState::WaitForSignalState	(	const QString &	stateName,
		QState *	parent,
		typename QtPrivate::FunctionPointer< Func >::Object *	sender,
		Func	signal,
		int	timeoutMsecs = `0`
	)

inline

Parameters

stateName	Name for this state (for logging)
parent	Parent state
sender	The QObject to wait for a signal from
signal	Pointer to member signal
timeoutMsecs	Timeout in milliseconds, 0 for no timeout

Definition at line 23 of file WaitForSignalState.h.

Member Function Documentation

◆ connectWaitSignal()

void WaitForSignalState::connectWaitSignal ( )

overrideprotectedvirtual

Subclasses override to set up their signal connections.

Implements WaitStateBase.

Definition at line 4 of file WaitForSignalState.cc.

◆ disconnectWaitSignal()

void WaitForSignalState::disconnectWaitSignal ( )

overrideprotectedvirtual

Subclasses override to tear down their signal connections.

Implements WaitStateBase.

Definition at line 11 of file WaitForSignalState.cc.

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

src/Utilities/StateMachine/States/WaitForSignalState.h
src/Utilities/StateMachine/States/WaitForSignalState.cc

Public Member Functions