QGCAbstractState.h

Go to the documentation of this file.

#pragma once
 
#include <QtStateMachine/QState>
#include <QtCore/QString>
 
#include <functional>
 
class QGCStateMachine;
class Vehicle;
 
class QGCAbstractState : public QState
{
    Q_OBJECT
    Q_DISABLE_COPY(QGCAbstractState)
 
public:
    using EntryCallback = std::function<void()>;
    using ExitCallback = std::function<void()>;
    using EventHandler = std::function<bool(QEvent*)>;
 
    QGCAbstractState(const QString& stateName, QState* parent);
 
    QGCStateMachine* machine() const;
    Vehicle* vehicle() const;
    QString stateName() const;
 
    class StateContext* context() const;
 
    // -------------------------------------------------------------------------
    // Entry/Exit Callbacks
    // -------------------------------------------------------------------------
 
    void setOnEntry(EntryCallback callback) { _entryCallback = std::move(callback); }
 
    void setOnExit(ExitCallback callback) { _exitCallback = std::move(callback); }
 
    void setCallbacks(EntryCallback onEntry, ExitCallback onExit = nullptr);
 
    // -------------------------------------------------------------------------
    // Event Handling
    // -------------------------------------------------------------------------
 
    void setEventHandler(EventHandler handler) { _eventHandler = std::move(handler); }
 
signals:
    void advance();
    void error();
 
protected:
    virtual void onEnter() {}
 
    virtual void onLeave() {}
 
    // QState overrides
    void onEntry(QEvent* event) override;
    void onExit(QEvent* event) override;
    bool event(QEvent* event) override;
 
private:
    EntryCallback _entryCallback;
    ExitCallback _exitCallback;
    EventHandler _eventHandler;
};