FactMetaData.h 9.61 KB
Newer Older
Don Gagne's avatar
Don Gagne committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
/*=====================================================================
 
 QGroundControl Open Source Ground Control Station
 
 (c) 2009 - 2014 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 
 This file is part of the QGROUNDCONTROL project
 
 QGROUNDCONTROL is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 
 QGROUNDCONTROL is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
 
 ======================================================================*/

/// @file
///     @author Don Gagne <don@thegagnes.com>

#ifndef FactMetaData_H
#define FactMetaData_H

#include <QObject>
#include <QString>
#include <QVariant>

34

Don Gagne's avatar
Don Gagne committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/// Holds the meta data associated with a Fact.
///
/// Holds the meta data associated with a Fact. This is kept in a seperate object from the Fact itself
/// since you may have multiple instances of the same Fact. But there is only ever one FactMetaData
/// instance or each Fact.
class FactMetaData : public QObject
{
    Q_OBJECT
    
public:
    typedef enum {
        valueTypeUint8,
        valueTypeInt8,
        valueTypeUint16,
        valueTypeInt16,
        valueTypeUint32,
        valueTypeInt32,
        valueTypeFloat,
        valueTypeDouble
    } ValueType_t;
55 56

    typedef QVariant (*Translator)(const QVariant& from);
Don Gagne's avatar
Don Gagne committed
57
    
Don Gagne's avatar
Don Gagne committed
58
    FactMetaData(QObject* parent = NULL);
59
    FactMetaData(ValueType_t type, QObject* parent = NULL);
Don Gagne's avatar
Don Gagne committed
60 61 62
    FactMetaData(const FactMetaData& other, QObject* parent = NULL);

    const FactMetaData& operator=(const FactMetaData& other);
63

64 65 66 67 68 69 70 71 72
    /// Converts from meters to the user specified distance unit
    static QVariant metersToAppSettingsDistanceUnits(const QVariant& meters);

    /// Converts from user specified distance unit to meters
    static QVariant appSettingsDistanceUnitsToMeters(const QVariant& distance);

    /// Returns the string for distance units which has configued by user
    static QString appSettingsDistanceUnitsString(void);

73
    int             decimalPlaces           (void) const { return _decimalPlaces; }
74 75
    QVariant        rawDefaultValue         (void) const;
    QVariant        cookedDefaultValue      (void) const { return _rawTranslator(rawDefaultValue()); }
76
    bool            defaultValueAvailable   (void) const { return _defaultValueAvailable; }
77 78
    QStringList     bitmaskStrings          (void) const { return _bitmaskStrings; }
    QVariantList    bitmaskValues           (void) const { return _bitmaskValues; }
79 80 81 82
    QStringList     enumStrings             (void) const { return _enumStrings; }
    QVariantList    enumValues              (void) const { return _enumValues; }
    QString         group                   (void) const { return _group; }
    QString         longDescription         (void) const { return _longDescription;}
83 84
    QVariant        rawMax                  (void) const { return _rawMax; }
    QVariant        cookedMax               (void) const { return _rawTranslator(_rawMax); }
85
    bool            maxIsDefaultForType     (void) const { return _maxIsDefaultForType; }
86 87
    QVariant        rawMin                  (void) const { return _rawMin; }
    QVariant        cookedMin               (void) const { return _rawTranslator(_rawMin); }
88 89 90 91
    bool            minIsDefaultForType     (void) const { return _minIsDefaultForType; }
    QString         name                    (void) const { return _name; }
    QString         shortDescription        (void) const { return _shortDescription; }
    ValueType_t     type                    (void) const { return _type; }
92 93
    QString         rawUnits                (void) const { return _rawUnits; }
    QString         cookedUnits             (void) const { return _cookedUnits; }
94
    bool            rebootRequired          (void) const { return _rebootRequired; }
95

Don Gagne's avatar
Don Gagne committed
96 97 98 99
    /// Amount to increment value when used in controls such as spin button or slider with detents.
    /// NaN for no increment available.
    double          increment               (void) const { return _increment; }

100 101
    Translator      rawTranslator           (void) const { return _rawTranslator; }
    Translator      cookedTranslator        (void) const { return _cookedTranslator; }
102

103 104 105
    /// Used to add new values to the bitmask lists after the meta data has been loaded
    void addBitmaskInfo(const QString& name, const QVariant& value);

106 107 108
    /// Used to add new values to the enum lists after the meta data has been loaded
    void addEnumInfo(const QString& name, const QVariant& value);

109
    void setDecimalPlaces   (int decimalPlaces)                 { _decimalPlaces = decimalPlaces; }
110
    void setRawDefaultValue (const QVariant& rawDefaultValue);
111
    void setBitmaskInfo     (const QStringList& strings, const QVariantList& values);
112 113 114
    void setEnumInfo        (const QStringList& strings, const QVariantList& values);
    void setGroup           (const QString& group)              { _group = group; }
    void setLongDescription (const QString& longDescription)    { _longDescription = longDescription;}
115 116
    void setRawMax          (const QVariant& rawMax);
    void setRawMin          (const QVariant& rawMin);
117
    void setName            (const QString& name)               { _name = name; }
118
    void setShortDescription(const QString& shortDescription)   { _shortDescription = shortDescription; }
119
    void setRawUnits        (const QString& rawUnits);
120
    void setRebootRequired  (bool rebootRequired)               { _rebootRequired = rebootRequired; }
Don Gagne's avatar
Don Gagne committed
121
    void setIncrement       (double increment)                  { _increment = increment; }
122 123 124

    void setTranslators(Translator rawTranslator, Translator cookedTranslator);

125 126 127 128 129 130
    /// Set the translators to the standard built in versions
    void setBuiltInTranslator(void);

    /// Set translators according to app settings
    void setAppSettingsTranslators(void);

131 132
    /// Converts the specified raw value, validating against meta data
    ///     @param rawValue Value to convert, can be string
Don Gagne's avatar
Don Gagne committed
133 134
    ///     @param convertOnly true: convert to correct type only, do not validate against meta data
    ///     @param typeValue Converted value, correctly typed
135
    ///     @param errorString Error string if convert fails, values are cooked values since user visible
Don Gagne's avatar
Don Gagne committed
136
    /// @returns false: Convert failed, errorString set
137 138 139 140
    bool convertAndValidateRaw(const QVariant& rawValue, bool convertOnly, QVariant& typedValue, QString& errorString);

    /// Same as convertAndValidateRaw except for cookedValue input
    bool convertAndValidateCooked(const QVariant& cookedValue, bool convertOnly, QVariant& typedValue, QString& errorString);
Don Gagne's avatar
Don Gagne committed
141

142 143
    static const int defaultDecimalPlaces = 3;

Don Gagne's avatar
Don Gagne committed
144
    static ValueType_t stringToType(const QString& typeString, bool& unknownType);
145
    static size_t typeToSize(ValueType_t type);
Don Gagne's avatar
Don Gagne committed
146

147
private:
148 149
    QVariant _minForType(void) const;
    QVariant _maxForType(void) const;
150 151 152 153 154 155 156

    // Built in translators
    static QVariant _defaultTranslator(const QVariant& from) { return from; }
    static QVariant _degreesToRadians(const QVariant& degrees);
    static QVariant _radiansToDegrees(const QVariant& radians);
    static QVariant _centiDegreesToDegrees(const QVariant& centiDegrees);
    static QVariant _degreesToCentiDegrees(const QVariant& degrees);
157 158 159 160 161 162 163 164
    static QVariant _metersToFeet(const QVariant& meters);
    static QVariant _feetToMeters(const QVariant& feet);
    static QVariant _metersPerSecondToMilesPerHour(const QVariant& metersPerSecond);
    static QVariant _milesPerHourToMetersPerSecond(const QVariant& milesPerHour);
    static QVariant _metersPerSecondToKilometersPerHour(const QVariant& metersPerSecond);
    static QVariant _kilometersPerHourToMetersPerSecond(const QVariant& kilometersPerHour);
    static QVariant _metersPerSecondToKnots(const QVariant& metersPerSecond);
    static QVariant _knotsToMetersPerSecond(const QVariant& knots);
165

166 167 168 169 170 171 172 173 174 175 176 177
    struct AppSettingsTranslation_s {
        const char* rawUnits;
        const char* cookedUnits;
        bool        speed;
        uint32_t    speedOrDistanceUnits;
        Translator  rawTranslator;
        Translator  cookedTranslator;

    };

    static const AppSettingsTranslation_s* _findAppSettingsDistanceUnitsTranslation(const QString& rawUnits);

178 179
    ValueType_t     _type;                  // must be first for correct constructor init
    int             _decimalPlaces;
180
    QVariant        _rawDefaultValue;
181
    bool            _defaultValueAvailable;
182 183
    QStringList     _bitmaskStrings;
    QVariantList    _bitmaskValues;
184 185 186 187
    QStringList     _enumStrings;
    QVariantList    _enumValues;
    QString         _group;
    QString         _longDescription;
188
    QVariant        _rawMax;
189
    bool            _maxIsDefaultForType;
190
    QVariant        _rawMin;
191 192 193
    bool            _minIsDefaultForType;
    QString         _name;
    QString         _shortDescription;
194 195
    QString         _rawUnits;
    QString         _cookedUnits;
196 197
    Translator      _rawTranslator;
    Translator      _cookedTranslator;
198
    bool            _rebootRequired;
Don Gagne's avatar
Don Gagne committed
199
    double          _increment;
200 201 202 203 204 205 206 207

    struct BuiltInTranslation_s {
        const char* rawUnits;
        const char* cookedUnits;
        Translator  rawTranslator;
        Translator  cookedTranslator;

    };
208
    static const BuiltInTranslation_s _rgBuiltInTranslations[];
209

210
    static const AppSettingsTranslation_s _rgAppSettingsTranslations[];
Don Gagne's avatar
Don Gagne committed
211 212
};

213
#endif