QGroundControl
Ground Control Station for MAVLink Drones
Loading...
Searching...
No Matches
NamedEventTransition Class Reference

#include <NamedEventTransition.h>

+ Inheritance diagram for NamedEventTransition:
+ Collaboration diagram for NamedEventTransition:

Public Types

using NamedGuard = std::function< bool(const QGCStateMachineEvent *)>
 

Public Member Functions

 NamedEventTransition (const QString &eventName, QAbstractState *target, QState *sourceState=nullptr)
 
 NamedEventTransition (const QString &eventName, QAbstractState *target, NamedGuard guard, QState *sourceState=nullptr)
 
QString eventName () const
 
- Public Member Functions inherited from QGCAbstractTransition
 QGCAbstractTransition (QState *sourceState=nullptr)
 
 QGCAbstractTransition (QAbstractState *target, QState *sourceState=nullptr)
 
QGCStateMachinemachine () const
 Get the QGCStateMachine this transition belongs to.
 
Vehiclevehicle () const
 Get the Vehicle associated with the state machine.
 

Protected Member Functions

bool eventTest (QEvent *event) override
 
- Protected Member Functions inherited from QGCAbstractTransition
void onTransition (QEvent *event) override
 

Detailed Description

Transition that fires when a named QGCStateMachineEvent is posted to the state machine Uses QAbstractTransition (via QGCAbstractTransition) to intercept events posted via QStateMachine::postEvent() / QGCStateMachine::postEvent().

Definition at line 12 of file NamedEventTransition.h.

Member Typedef Documentation

◆ NamedGuard

using NamedEventTransition::NamedGuard = std::function<bool(const QGCStateMachineEvent*)>

Definition at line 18 of file NamedEventTransition.h.

Constructor & Destructor Documentation

◆ NamedEventTransition() [1/2]

NamedEventTransition::NamedEventTransition ( const QString &  eventName,
QAbstractState *  target,
QState *  sourceState = nullptr 
)

Create transition for named events

Parameters
eventNameThe event name to match
targetTarget state for the transition
sourceStateOptional source state (defaults to nullptr)

Definition at line 4 of file NamedEventTransition.cc.

◆ NamedEventTransition() [2/2]

NamedEventTransition::NamedEventTransition ( const QString &  eventName,
QAbstractState *  target,
NamedGuard  guard,
QState *  sourceState = nullptr 
)

Create transition for named events with a guard

Parameters
eventNameThe event name to match
targetTarget state for the transition
guardPredicate that must return true for transition to fire
sourceStateOptional source state (defaults to nullptr)

Definition at line 10 of file NamedEventTransition.cc.

Member Function Documentation

◆ eventName()

QString NamedEventTransition::eventName ( ) const
inline

Definition at line 33 of file NamedEventTransition.h.

◆ eventTest()

bool NamedEventTransition::eventTest ( QEvent *  event)
overrideprotectedvirtual

Implements QGCAbstractTransition.

Definition at line 17 of file NamedEventTransition.cc.

References QGCStateMachineEvent::EventType.


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