Fact.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QMutexLocker>
#include <QtCore/QObject>
#include <QtCore/QRecursiveMutex>
#include <QtCore/QString>
#include <QtCore/QVariant>
#include <QtQmlIntegration/QtQmlIntegration>
 
#include "FactMetaData.h"
 
class Fact : public QObject
{
    Q_OBJECT
    QML_ELEMENT
    Q_PROPERTY(int          componentId             READ componentId                                            CONSTANT)
    Q_PROPERTY(QStringList  bitmaskStrings          READ bitmaskStrings                                         NOTIFY bitmaskStringsChanged)
    Q_PROPERTY(QVariantList bitmaskValues           READ bitmaskValues                                          NOTIFY bitmaskValuesChanged)
    Q_PROPERTY(QStringList  selectedBitmaskStrings  READ selectedBitmaskStrings                                 NOTIFY valueChanged)
    Q_PROPERTY(int          decimalPlaces           READ decimalPlaces                                          NOTIFY cookedValuesChanged)
    Q_PROPERTY(int          maxStringLength         READ maxStringLength                                        CONSTANT)
    Q_PROPERTY(QVariant     defaultValue            READ cookedDefaultValue                                     NOTIFY cookedValuesChanged)
    Q_PROPERTY(QString      defaultValueString      READ cookedDefaultValueString                               NOTIFY cookedValuesChanged)
    Q_PROPERTY(bool         defaultValueAvailable   READ defaultValueAvailable                                  CONSTANT)
    Q_PROPERTY(int          enumIndex               READ enumIndex                  WRITE setEnumIndex          NOTIFY valueChanged)
    Q_PROPERTY(QStringList  enumStrings             READ enumStrings                                            NOTIFY enumsChanged)
    Q_PROPERTY(QString      enumStringValue         READ enumStringValue            WRITE setEnumStringValue    NOTIFY valueChanged)
    Q_PROPERTY(QVariantList enumValues              READ enumValues                                             NOTIFY enumsChanged)
    Q_PROPERTY(QString      category                READ category                                               CONSTANT)
    Q_PROPERTY(QString      group                   READ group                                                  CONSTANT)
    Q_PROPERTY(QString      longDescription         READ longDescription                                        CONSTANT)
    Q_PROPERTY(QVariant     max                     READ cookedMax                                              NOTIFY cookedValuesChanged)
    Q_PROPERTY(QString      maxString               READ cookedMaxString                                        NOTIFY cookedValuesChanged)
    Q_PROPERTY(bool         maxIsDefaultForType     READ maxIsDefaultForType                                    CONSTANT)
    Q_PROPERTY(QVariant     min                     READ cookedMin                                              NOTIFY cookedValuesChanged)
    Q_PROPERTY(QString      minString               READ cookedMinString                                        NOTIFY cookedValuesChanged)
    Q_PROPERTY(bool         minIsDefaultForType     READ minIsDefaultForType                                    CONSTANT)
    Q_PROPERTY(QVariant     userMin                 READ cookedUserMin                                          NOTIFY cookedValuesChanged)
    Q_PROPERTY(QString      userMinString           READ cookedUserMinString                                    NOTIFY cookedValuesChanged)
    Q_PROPERTY(QVariant     userMax                 READ cookedUserMax                                          NOTIFY cookedValuesChanged)
    Q_PROPERTY(QString      userMaxString           READ cookedUserMaxString                                    NOTIFY cookedValuesChanged)
    Q_PROPERTY(QString      name                    READ name                                                   CONSTANT)
    Q_PROPERTY(bool         vehicleRebootRequired   READ vehicleRebootRequired                                  CONSTANT)
    Q_PROPERTY(bool         qgcRebootRequired       READ qgcRebootRequired                                      CONSTANT)
    Q_PROPERTY(QString      shortDescription        READ shortDescription                                       CONSTANT)
    Q_PROPERTY(QString      label                   READ label                                                  CONSTANT)
    Q_PROPERTY(QString      units                   READ cookedUnits                                            NOTIFY cookedValuesChanged)
    Q_PROPERTY(QVariant     value                   READ cookedValue                WRITE setCookedValue        NOTIFY valueChanged)
    Q_PROPERTY(QVariant     rawValue                READ rawValue                   WRITE setRawValue           NOTIFY rawValueChanged)
    Q_PROPERTY(bool         valueEqualsDefault      READ valueEqualsDefault                                     NOTIFY valueChanged)
    Q_PROPERTY(QString      invalidValueString      READ invalidValueString                                     NOTIFY cookedValuesChanged)
    Q_PROPERTY(QString      valueString             READ cookedValueString                                      NOTIFY valueChanged)
    Q_PROPERTY(QString      enumOrValueString       READ enumOrValueString                                      NOTIFY valueChanged)
    Q_PROPERTY(double       increment               READ cookedIncrement                                        NOTIFY cookedValuesChanged)
    Q_PROPERTY(bool         typeIsString            READ typeIsString                                           CONSTANT)
    Q_PROPERTY(bool         typeIsBool              READ typeIsBool                                             CONSTANT)
    Q_PROPERTY(bool         hasControl              READ hasControl                                             CONSTANT)
    Q_PROPERTY(bool         readOnly                READ readOnly                                               CONSTANT)
    Q_PROPERTY(bool         writeOnly               READ writeOnly                                              CONSTANT)
    Q_PROPERTY(bool         volatileValue           READ volatileValue                                          CONSTANT)
 
public:
    explicit Fact(QObject *parent = nullptr);
    explicit Fact(int componentId, const QString &name, FactMetaData::ValueType_t type, QObject *parent = nullptr);
    explicit Fact(const Fact &other, QObject *parent = nullptr);
 
    explicit Fact(const QString &settingsGroup, FactMetaData *metaData, QObject *parent = nullptr);
    virtual ~Fact();
 
    const Fact &operator=(const Fact &other);
 
    Q_INVOKABLE QString validate(const QString &cookedValue, bool convertOnly);
    Q_INVOKABLE QVariant clamp(const QString &cookedValue);
    QVariant cookedValue() const; 
    Q_INVOKABLE QVariant rawToCooked(const QVariant &rawValue) const;
    QVariant rawValue() const
    {
        QMutexLocker<QRecursiveMutex> locker(&_rawValueMutex);
        return _rawValue;
    }
    int componentId() const { return _componentId; }
    int decimalPlaces() const;
    int maxStringLength() const;
    QVariant rawDefaultValue() const;
    QVariant cookedDefaultValue() const;
    bool defaultValueAvailable() const;
    QString cookedDefaultValueString() const;
    QStringList bitmaskStrings() const;
    QVariantList bitmaskValues() const;
    QStringList selectedBitmaskStrings() const;
    int enumIndex(); // This is not const, since an unknown value can modify the enum lists
    QStringList enumStrings() const;
    QString enumStringValue();         // This is not const, since an unknown value can modify the enum lists
    QVariantList enumValues() const;
    QString category() const;
    QString group() const;
    QString longDescription() const;
    QVariant rawMax() const;
    QVariant cookedMax() const;
    QString cookedMaxString() const;
    bool maxIsDefaultForType() const;
    QVariant rawMin() const;
    QVariant cookedMin() const;
    QString cookedMinString() const;
    bool minIsDefaultForType() const;
    QVariant rawUserMin() const;
    QVariant cookedUserMin() const;
    QString cookedUserMinString() const;
    QVariant rawUserMax() const;
    QVariant cookedUserMax() const;
    QString cookedUserMaxString() const;
    QString name() const { return _name; }
    QString label() const;
    QString shortDescription() const;
    FactMetaData::ValueType_t type() const { return _type; }
    QString cookedUnits() const;
    QString rawUnits() const;
    QString invalidValueString(int decimalPlaces) const;
    QString invalidValueString() const { return invalidValueString(decimalPlaces()); }
    QString rawValueString() const;
    QString cookedValueString() const;
    bool valueEqualsDefault() const;
    bool vehicleRebootRequired() const;
    bool qgcRebootRequired() const;
    QString enumOrValueString();         // This is not const, since an unknown value can modify the enum lists
    double rawIncrement() const;
    double cookedIncrement() const;
    bool typeIsString() const { return (type() == FactMetaData::valueTypeString); }
    bool typeIsBool() const { return (type() == FactMetaData::valueTypeBool); }
    bool hasControl() const;
    bool readOnly() const;
    bool writeOnly() const;
    bool volatileValue() const;
 
    QString rawValueStringFullPrecision() const;
 
    void setRawValue(const QVariant &value);
    void setCookedValue(const QVariant &value);
    void setEnumIndex(int index);
    void setEnumStringValue(const QString &value);
    int valueIndex(const QString &value) const;
 
    // The following methods allow you to defer sending of the valueChanged signals in order to implement
    // rate limited signalling for ui performance. Used by FactGroup for example.
    void setSendValueChangedSignals (bool sendValueChangedSignals);
    bool sendValueChangedSignals () const { return _sendValueChangedSignals; }
    bool deferredValueChangeSignal() const { return _deferredValueChangeSignal; }
    void clearDeferredValueChangeSignal() { _deferredValueChangeSignal = false; }
    void sendDeferredValueChangedSignal();
 
    void forceSetRawValue(const QVariant &value);
 
    void setMetaData(FactMetaData *metaData, bool setDefaultFromMetaData = false);
 
    FactMetaData *metaData() { return _metaData; }
 
    void containerSetRawValue(const QVariant &value);
 
    void setName(const QString &name) { _name = name; }
 
    void setEnumInfo(const QStringList &strings, const QVariantList &values);
 
signals:
    void bitmaskStringsChanged();
    void bitmaskValuesChanged();
    void cookedValuesChanged();
    void enumsChanged();
    void sendValueChangedSignalsChanged(bool sendValueChangedSignals);
 
    void valueChanged(const QVariant &value);
    void rawValueChanged(const QVariant &value);
 
    void vehicleUpdated(const QVariant &value);
 
    void containerRawValueChanged(const QVariant &value);
 
protected:
    QString _variantToString(const QVariant &variant, int decimalPlaces) const;
    void _sendValueChangedSignal(const QVariant &value);
 
    QString _name;
    int _componentId = -1;
    QVariant _rawValue{0};
    mutable QRecursiveMutex _rawValueMutex;
    FactMetaData::ValueType_t _type = FactMetaData::valueTypeInt32;
    FactMetaData *_metaData = nullptr;
    bool _sendValueChangedSignals = true;
    bool _deferredValueChangeSignal = false;
 
    static constexpr const char *kMissingMetadata = "Meta data pointer missing";
 
private slots:
    void _appSettingsUnitsChanged();
    void _checkForRebootMessaging();
 
private:
    void _init();
};