Skip to content
Snippets Groups Projects
Fact.h 12.5 KiB
Newer Older
  • Learn to ignore specific revisions
  • /****************************************************************************
     *
     *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
     *
     * 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
    
    /// @file
    ///     @author Don Gagne <don@thegagnes.com>
    
    #ifndef Fact_H
    #define Fact_H
    
    #include "FactMetaData.h"
    
    #include <QObject>
    #include <QString>
    #include <QVariant>
    
    #include <QDebug>
    
    #include <QAbstractListModel>
    
    class FactValueSliderListModel;
    
    Don Gagne's avatar
    Don Gagne committed
    
    /// @brief A Fact is used to hold a single value within the system.
    class Fact : public QObject
    {
        Q_OBJECT
        
    public:
    
    Don Gagne's avatar
    Don Gagne committed
        Fact(QObject* parent = NULL);
    
        Fact(int componentId, QString name, FactMetaData::ValueType_t type, QObject* parent = NULL);
    
    Don Gagne's avatar
    Don Gagne committed
        Fact(const Fact& other, QObject* parent = NULL);
    
    
        /// Creates a Fact using the name and type from metaData. Also calls QGCCorePlugin::adjustSettingsMetaData allowing
        /// custom builds to override the metadata.
    
        Fact(const QString& settingsGroup, FactMetaData* metaData, QObject* parent = NULL);
    
    Don Gagne's avatar
    Don Gagne committed
        const Fact& operator=(const Fact& other);
    
    
        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(int          decimalPlaces           READ decimalPlaces                                      CONSTANT)
    
        Q_PROPERTY(QVariant     defaultValue            READ cookedDefaultValue                                 CONSTANT)
        Q_PROPERTY(QString      defaultValueString      READ cookedDefaultValueString                           CONSTANT)
    
        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                                          CONSTANT)
        Q_PROPERTY(QString      maxString               READ cookedMaxString                                    CONSTANT)
    
        Q_PROPERTY(bool         maxIsDefaultForType     READ maxIsDefaultForType                                CONSTANT)
    
        Q_PROPERTY(QVariant     min                     READ cookedMin                                          CONSTANT)
        Q_PROPERTY(QString      minString               READ cookedMinString                                    CONSTANT)
    
        Q_PROPERTY(bool         minIsDefaultForType     READ minIsDefaultForType                                CONSTANT)
        Q_PROPERTY(QString      name                    READ name                                               CONSTANT)
    
    Don Gagne's avatar
     
    Don Gagne committed
        Q_PROPERTY(bool         vehicleRebootRequired   READ vehicleRebootRequired                              CONSTANT)
        Q_PROPERTY(bool         qgcRebootRequired       READ qgcRebootRequired                                  CONSTANT)
    
        Q_PROPERTY(QString      shortDescription        READ shortDescription                                   CONSTANT)
    
        Q_PROPERTY(QString      units                   READ cookedUnits                                        CONSTANT)
    
    Don Gagne's avatar
    Don Gagne committed
        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      valueString             READ cookedValueString                                  NOTIFY valueChanged)
        Q_PROPERTY(QString      enumOrValueString       READ enumOrValueString                                  NOTIFY valueChanged)
    
        Q_PROPERTY(double       increment               READ cookedIncrement                                    CONSTANT)
    
        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)
    
    Don Gagne's avatar
    Don Gagne committed
        /// Convert and validate value
        ///     @param convertOnly true: validate type conversion only, false: validate against meta data as well
    
        Q_INVOKABLE QString validate(const QString& cookedValue, bool convertOnly);
    
        /// Convert and clamp value
        Q_INVOKABLE QVariant clamp(const QString& cookedValue);
    
    Don Gagne's avatar
    Don Gagne committed
        QVariant        cookedValue             (void) const;   /// Value after translation
    
        QVariant        rawValue                (void) const { return _rawValue; }  /// value prior to translation, careful
    
        int             componentId             (void) const;
        int             decimalPlaces           (void) const;
    
        QVariant        rawDefaultValue         (void) const;
        QVariant        cookedDefaultValue      (void) const;
    
        bool            defaultValueAvailable   (void) const;
    
        QString         cookedDefaultValueString(void) const;
    
    Don Gagne's avatar
    Don Gagne committed
        QStringList     bitmaskStrings          (void) const;
        QVariantList    bitmaskValues           (void) const;
    
        int             enumIndex               (void);         // This is not const, since an unknown value can modify the enum lists
    
        QStringList     enumStrings             (void) const;
    
        QString         enumStringValue         (void);         // This is not const, since an unknown value can modify the enum lists
    
        QVariantList    enumValues              (void) const;
    
        QString         category                (void) const;
    
        QString         group                   (void) const;
        QString         longDescription         (void) const;
    
        QVariant        rawMax                  (void) const;
        QVariant        cookedMax               (void) const;
        QString         cookedMaxString         (void) const;
    
        bool            maxIsDefaultForType     (void) const;
    
        QVariant        rawMin                  (void) const;
        QVariant        cookedMin               (void) const;
        QString         cookedMinString         (void) const;
    
        bool            minIsDefaultForType     (void) const;
        QString         name                    (void) const;
        QString         shortDescription        (void) const;
        FactMetaData::ValueType_t type          (void) const;
    
        QString         cookedUnits             (void) const;
        QString         rawUnits                (void) const;
        QString         rawValueString          (void) const;
        QString         cookedValueString       (void) const;
    
        bool            valueEqualsDefault      (void) const;
    
    Don Gagne's avatar
     
    Don Gagne committed
        bool            vehicleRebootRequired   (void) const;
        bool            qgcRebootRequired       (void) const;
    
        QString         enumOrValueString       (void);         // This is not const, since an unknown value can modify the enum lists
    
        double          rawIncrement            (void) const;
    
        double          cookedIncrement         (void) const;
    
        bool            typeIsString            (void) const { return type() == FactMetaData::valueTypeString; }
        bool            typeIsBool              (void) const { return type() == FactMetaData::valueTypeBool; }
    
        bool            hasControl              (void) const;
    
        bool            readOnly                (void) const;
    
        bool            writeOnly               (void) const;
        bool            volatileValue           (void) const;
    
    DonLakeFlyer's avatar
     
    DonLakeFlyer committed
        // Internal hack to allow changes to fact which do not signal reboot. Currently used by font point size
        // code in ScreenTools.qml to set initial sizing at first boot.
        Q_INVOKABLE void _setIgnoreQGCRebootRequired(bool ignore);
    
    
        Q_INVOKABLE FactValueSliderListModel* valueSliderModel(void);
    
    
        /// Returns the values as a string with full 18 digit precision if float/double.
        QString rawValueStringFullPrecision(void) const;
    
    
    Gus Grubba's avatar
    Gus Grubba committed
        void setRawValue        (const QVariant& value);
    
    Don Gagne's avatar
    Don Gagne committed
        void setCookedValue     (const QVariant& value);
    
        void setEnumIndex       (int index);
        void setEnumStringValue (const QString& value);
    
    Gus Grubba's avatar
    Gus Grubba committed
        int  valueIndex         (const QString& value);
    
    Don Gagne's avatar
    Don Gagne committed
        // 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 (void) const { return _sendValueChangedSignals; }
        bool deferredValueChangeSignal(void) const { return _deferredValueChangeSignal; }
        void clearDeferredValueChangeSignal(void) { _deferredValueChangeSignal = false; }
        void sendDeferredValueChangedSignal(void);
    
    
        // C++ methods
    
        /// Sets and sends new value to vehicle even if value is the same
    
    Don Gagne's avatar
    Don Gagne committed
        void forceSetRawValue(const QVariant& value);
    
    Don Gagne's avatar
    Don Gagne committed
        /// Sets the meta data associated with the Fact.
    
        ///     @param metaData FactMetaData for Fact
        ///     @param setDefaultFromMetaData true: set the fact value to the default specified in the meta data
        void setMetaData(FactMetaData* metaData, bool setDefaultFromMetaData = false);
    
    Don Gagne's avatar
    Don Gagne committed
        
    
        FactMetaData* metaData() { return _metaData; }
    
    Gus Grubba's avatar
    Gus Grubba committed
    
        //-- Value coming from Vehicle. This does NOT send a _containerRawValueChanged signal.
    
    Don Gagne's avatar
    Don Gagne committed
        void _containerSetRawValue(const QVariant& value);
    
    Don Gagne's avatar
    Don Gagne committed
        /// Generally you should not change the name of a fact. But if you know what you are doing, you can.
        void _setName(const QString& name) { _name = name; }
    
        /// Generally this is done during parsing. But if you know what you are doing, you can.
        void setEnumInfo(const QStringList& strings, const QVariantList& values);
    
    
    Don Gagne's avatar
    Don Gagne committed
    signals:
    
        void bitmaskStringsChanged(void);
        void bitmaskValuesChanged(void);
    
        void enumsChanged(void);
    
    Don Gagne's avatar
    Don Gagne committed
        void sendValueChangedSignalsChanged(bool sendValueChangedSignals);
    
    Don Gagne's avatar
    Don Gagne committed
        /// QObject Property System signal for value property changes
        ///
        /// This signal is only meant for use by the QT property system. It should not be connected to by client code.
    
        void valueChanged(QVariant value);
    
        void rawValueChanged(QVariant value);
    
    Don Gagne's avatar
    Don Gagne committed
        
    
        /// Signalled when the param write ack comes back from the vehicle
        void vehicleUpdated(QVariant value);
        
    
    Don Gagne's avatar
    Don Gagne committed
        /// Signalled when property has been changed by a call to the property write accessor
        ///
    
    Gus Grubba's avatar
    Gus Grubba committed
        /// This signal is meant for use by Fact container implementations. Used to send changed values to vehicle.
    
    Don Gagne's avatar
    Don Gagne committed
        void _containerRawValueChanged(const QVariant& value);
    
    Don Gagne's avatar
     
    Don Gagne committed
    
    private slots:
        void _checkForRebootMessaging(void);
    
    private:
        void _init(void);
    
    Don Gagne's avatar
    Don Gagne committed
        
    
    Don Gagne's avatar
    Don Gagne committed
    protected:
    
        QString _variantToString(const QVariant& variant, int decimalPlaces) const;
    
    Don Gagne's avatar
    Don Gagne committed
        void _sendValueChangedSignal(QVariant value);
    
        QVariant                    _rawValue;
    
        FactMetaData::ValueType_t   _type;
        FactMetaData*               _metaData;
    
    Don Gagne's avatar
    Don Gagne committed
        bool                        _sendValueChangedSignals;
        bool                        _deferredValueChangeSignal;
    
        FactValueSliderListModel*   _valueSliderModel;
    
    DonLakeFlyer's avatar
     
    DonLakeFlyer committed
        bool                        _ignoreQGCRebootRequired;
    
    Don Gagne's avatar
    Don Gagne committed
    };