MultiSignalSpy.h 2.7 KB
Newer Older
1 2
/****************************************************************************
 *
Gus Grubba's avatar
Gus Grubba committed
3
 * (c) 2009-2020 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
4 5 6 7 8 9
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

Don Gagne's avatar
Don Gagne committed
10

11
#pragma once
Don Gagne's avatar
Don Gagne committed
12 13 14

#include <QObject>
#include <QSignalSpy>
Don Gagne's avatar
Don Gagne committed
15
#include <QGeoCoordinate>
Don Gagne's avatar
Don Gagne committed
16 17 18 19 20 21 22 23 24 25 26 27

/// @file
///     @brief This class allows you to keep track of signal counts on a set of signals associated with an object.
///     Mainly used for writing object unit tests.
///
///     @author Don Gagne <don@thegagnes.com>

class MultiSignalSpy : public QObject
{
    Q_OBJECT
    
public:
28
    MultiSignalSpy(QObject* parent = nullptr);
Don Gagne's avatar
Don Gagne committed
29 30 31 32
    ~MultiSignalSpy();

    bool init(QObject* signalEmitter, const char** rgSignals, size_t cSignals);

33 34 35
    /// @param mask bit mask specifying which signals to check. The lowest order bit represents
    ///     index 0 into the rgSignals array and so on up the bit mask.
    /// @return true if signal count = 1 for the specified signals
Don Gagne's avatar
Don Gagne committed
36
    bool checkSignalByMask(quint32 mask);
37 38 39

    /// @return true if signal count = 1 for specified signals and signal count of 0
    ///     for all other signals
Don Gagne's avatar
Don Gagne committed
40
    bool checkOnlySignalByMask(quint32 mask);
41 42 43 44

    /// @param mask bit mask specifying which signals to check. The lowest order bit represents
    ///     index 0 into the rgSignals array and so on up the bit mask.
    /// @return true if signal count >= 1 for the specified signals
Don Gagne's avatar
Don Gagne committed
45
    bool checkSignalsByMask(quint32 mask);
46 47 48

    /// @return true if signal count >= 1 for specified signals and signal count of 0
    ///     for all other signals
Don Gagne's avatar
Don Gagne committed
49
    bool checkOnlySignalsByMask(quint32 mask);
50

Don Gagne's avatar
Don Gagne committed
51
    bool checkNoSignalByMask(quint32 mask);
Don Gagne's avatar
Don Gagne committed
52 53
    bool checkNoSignals(void);

Don Gagne's avatar
Don Gagne committed
54 55
    void clearSignalByIndex(quint32 index);
    void clearSignalsByMask(quint32 mask);
Don Gagne's avatar
Don Gagne committed
56 57
    void clearAllSignals(void);

Don Gagne's avatar
Don Gagne committed
58
    bool waitForSignalByIndex(quint32 index, int msec);
Don Gagne's avatar
Don Gagne committed
59
    
Don Gagne's avatar
Don Gagne committed
60 61 62 63 64 65
    QSignalSpy* getSpyByIndex(quint32 index);

    // Returns the value type for the first parameter of the signal
    bool pullBoolFromSignalIndex(quint32 index);
    int pullIntFromSignalIndex(quint32 index);
    QGeoCoordinate pullQGeoCoordinateFromSignalIndex(quint32 index);
Don Gagne's avatar
Don Gagne committed
66

Don Gagne's avatar
Don Gagne committed
67 68 69
private:
    // QObject overrides
    void timerEvent(QTimerEvent * event);
70
    
Don Gagne's avatar
Don Gagne committed
71 72 73
    void _printSignalState(quint32 mask);
    bool _checkSignalByMaskWorker(quint32 mask, bool multipleSignalsAllowed);
    bool _checkOnlySignalByMaskWorker(quint32 mask, bool multipleSignalsAllowed);
Don Gagne's avatar
Don Gagne committed
74 75 76 77 78 79 80 81

    QObject*        _signalEmitter;
    const char**    _rgSignals;
    QSignalSpy**    _rgSpys;
    size_t          _cSignals;
    bool            _timeout;
};