FactMetaData.h 13.6 KB
Newer Older
1 2 3 4 5 6 7 8 9
/****************************************************************************
 *
 *   (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
10 11 12 13 14 15 16 17 18 19

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

#ifndef FactMetaData_H
#define FactMetaData_H

#include <QObject>
#include <QString>
#include <QVariant>
20
#include <QJsonObject>
21

Don Gagne's avatar
Don Gagne committed
22 23
/// Holds the meta data associated with a Fact.
///
Ricardo de Almeida Gonzaga's avatar
Ricardo de Almeida Gonzaga committed
24
/// Holds the meta data associated with a Fact. This is kept in a separate object from the Fact itself
Don Gagne's avatar
Don Gagne committed
25 26 27 28 29
/// 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
30

Don Gagne's avatar
Don Gagne committed
31 32 33 34 35 36 37 38 39
public:
    typedef enum {
        valueTypeUint8,
        valueTypeInt8,
        valueTypeUint16,
        valueTypeInt16,
        valueTypeUint32,
        valueTypeInt32,
        valueTypeFloat,
Don Gagne's avatar
Don Gagne committed
40
        valueTypeDouble,
41
        valueTypeString,
42 43
        valueTypeBool,
        valueTypeElapsedTimeInSeconds,  // Internally stored as double, valueString displays as HH:MM:SS
44
        valueTypeCustom,                // Internally stored as a QByteArray
Don Gagne's avatar
Don Gagne committed
45
    } ValueType_t;
46 47

    typedef QVariant (*Translator)(const QVariant& from);
48

Don Gagne's avatar
Don Gagne committed
49
    FactMetaData(QObject* parent = NULL);
50
    FactMetaData(ValueType_t type, QObject* parent = NULL);
51
    FactMetaData(ValueType_t type, const QString name, QObject* parent = NULL);
Don Gagne's avatar
Don Gagne committed
52 53
    FactMetaData(const FactMetaData& other, QObject* parent = NULL);

54
    static QMap<QString, FactMetaData*> createMapFromJsonFile(const QString& jsonFilename, QObject* metaDataParent);
55
    static QMap<QString, FactMetaData*> createMapFromJsonArray(const QJsonArray jsonArray, QObject* metaDataParent);
56

57 58
    static FactMetaData* createFromJsonObject(const QJsonObject& json, QObject* metaDataParent);

Don Gagne's avatar
Don Gagne committed
59
    const FactMetaData& operator=(const FactMetaData& other);
60

61 62 63 64 65 66 67 68 69
    /// 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);

70 71 72 73 74 75 76 77 78
    /// Converts from meters to the user specified distance unit
    static QVariant squareMetersToAppSettingsAreaUnits(const QVariant& squareMeters);

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

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

79 80 81
    static const QString defaultCategory    ();
    static const QString defaultGroup       ();

82
    int             decimalPlaces           (void) const;
83 84
    QVariant        rawDefaultValue         (void) const;
    QVariant        cookedDefaultValue      (void) const { return _rawTranslator(rawDefaultValue()); }
85
    bool            defaultValueAvailable   (void) const { return _defaultValueAvailable; }
86 87
    QStringList     bitmaskStrings          (void) const { return _bitmaskStrings; }
    QVariantList    bitmaskValues           (void) const { return _bitmaskValues; }
88 89
    QStringList     enumStrings             (void) const { return _enumStrings; }
    QVariantList    enumValues              (void) const { return _enumValues; }
90
    QString         category                (void) const { return _category; }
91 92
    QString         group                   (void) const { return _group; }
    QString         longDescription         (void) const { return _longDescription;}
93
    QVariant        rawMax                  (void) const { return _rawMax; }
94
    QVariant        cookedMax               (void) const;
95
    bool            maxIsDefaultForType     (void) const { return _maxIsDefaultForType; }
96
    QVariant        rawMin                  (void) const { return _rawMin; }
97
    QVariant        cookedMin               (void) const;
98 99 100 101
    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; }
102 103
    QString         rawUnits                (void) const { return _rawUnits; }
    QString         cookedUnits             (void) const { return _cookedUnits; }
104
    bool            rebootRequired          (void) const { return _rebootRequired; }
105
    bool            hasControl              (void) const { return _hasControl; }
106
    bool            readOnly                (void) const { return _readOnly; }
107
    bool            writeOnly               (void) const { return _writeOnly; }
108
    bool            volatileValue           (void) const { return _volatile; }
109

Don Gagne's avatar
Don Gagne committed
110 111 112 113
    /// 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; }

114 115
    Translator      rawTranslator           (void) const { return _rawTranslator; }
    Translator      cookedTranslator        (void) const { return _cookedTranslator; }
116

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

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

123
    void setDecimalPlaces   (int decimalPlaces)                 { _decimalPlaces = decimalPlaces; }
124
    void setRawDefaultValue (const QVariant& rawDefaultValue);
125
    void setBitmaskInfo     (const QStringList& strings, const QVariantList& values);
126
    void setEnumInfo        (const QStringList& strings, const QVariantList& values);
127
    void setCategory        (const QString& category)           { _category = category; }
128 129
    void setGroup           (const QString& group)              { _group = group; }
    void setLongDescription (const QString& longDescription)    { _longDescription = longDescription;}
130 131
    void setRawMax          (const QVariant& rawMax);
    void setRawMin          (const QVariant& rawMin);
132
    void setName            (const QString& name)               { _name = name; }
133
    void setShortDescription(const QString& shortDescription)   { _shortDescription = shortDescription; }
134
    void setRawUnits        (const QString& rawUnits);
135
    void setRebootRequired  (bool rebootRequired)               { _rebootRequired = rebootRequired; }
Don Gagne's avatar
Don Gagne committed
136
    void setIncrement       (double increment)                  { _increment = increment; }
137
    void setHasControl      (bool bValue)                       { _hasControl = bValue; }
138
    void setReadOnly        (bool bValue)                       { _readOnly = bValue; }
139
    void setWriteOnly       (bool bValue)                       { _writeOnly = bValue; }
140
    void setVolatileValue   (bool bValue);
141 142 143

    void setTranslators(Translator rawTranslator, Translator cookedTranslator);

144 145 146
    /// Set the translators to the standard built in versions
    void setBuiltInTranslator(void);

147 148
    /// Converts the specified raw value, validating against meta data
    ///     @param rawValue Value to convert, can be string
Don Gagne's avatar
Don Gagne committed
149 150
    ///     @param convertOnly true: convert to correct type only, do not validate against meta data
    ///     @param typeValue Converted value, correctly typed
151
    ///     @param errorString Error string if convert fails, values are cooked values since user visible
Don Gagne's avatar
Don Gagne committed
152
    /// @returns false: Convert failed, errorString set
153 154 155 156
    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
157

158 159 160 161 162 163
    /// Converts the specified cooked value and clamps it (max/min)
    ///     @param cookedValue Value to convert, can be string
    ///     @param typeValue Converted value, correctly typed and clamped
    /// @returns false: Convertion failed
    bool clampValue(const QVariant& cookedValue, QVariant& typedValue);

164 165
    static const int defaultDecimalPlaces = 3;  ///< Default value for decimal places if not specified/known
    static const int unknownDecimalPlaces = -1; ///< Number of decimal places to specify is not known
166

Don Gagne's avatar
Don Gagne committed
167
    static ValueType_t stringToType(const QString& typeString, bool& unknownType);
168
    static size_t typeToSize(ValueType_t type);
Don Gagne's avatar
Don Gagne committed
169

170
private:
171 172
    QVariant _minForType(void) const;
    QVariant _maxForType(void) const;
173
    void _setAppSettingsTranslators(void);
174 175 176 177 178 179 180

    // 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);
181 182
    static QVariant _userGimbalDegreesToMavlinkGimbalDegrees(const QVariant& userGimbalDegrees);
    static QVariant _mavlinkGimbalDegreesToUserGimbalDegrees(const QVariant& mavlinkGimbalDegrees);
183 184
    static QVariant _metersToFeet(const QVariant& meters);
    static QVariant _feetToMeters(const QVariant& feet);
185 186 187 188 189 190 191 192 193 194
    static QVariant _squareMetersToSquareKilometers(const QVariant& squareMeters);
    static QVariant _squareKilometersToSquareMeters(const QVariant& squareKilometers);
    static QVariant _squareMetersToHectares(const QVariant& squareMeters);
    static QVariant _hectaresToSquareMeters(const QVariant& hectares);
    static QVariant _squareMetersToSquareFeet(const QVariant& squareMeters);
    static QVariant _squareFeetToSquareMeters(const QVariant& squareFeet);
    static QVariant _squareMetersToAcres(const QVariant& squareMeters);
    static QVariant _acresToSquareMeters(const QVariant& acres);
    static QVariant _squareMetersToSquareMiles(const QVariant& squareMeters);
    static QVariant _squareMilesToSquareMeters(const QVariant& squareMiles);
195 196 197 198 199 200
    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);
201 202
    static QVariant _percentToNorm(const QVariant& percent);
    static QVariant _normToPercent(const QVariant& normalized);
203 204
    static QVariant _centimetersToInches(const QVariant& centimeters);
    static QVariant _inchesToCentimeters(const QVariant& inches);
205 206
    static QVariant _celsiusToFarenheit(const QVariant& celsius);
    static QVariant _farenheitToCelsius(const QVariant& farenheit);
207

208 209 210 211 212 213 214 215 216 217 218
    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);
219
    static const AppSettingsTranslation_s* _findAppSettingsAreaUnitsTranslation(const QString& rawUnits);
220

221 222
    ValueType_t     _type;                  // must be first for correct constructor init
    int             _decimalPlaces;
223
    QVariant        _rawDefaultValue;
224
    bool            _defaultValueAvailable;
225 226
    QStringList     _bitmaskStrings;
    QVariantList    _bitmaskValues;
227 228
    QStringList     _enumStrings;
    QVariantList    _enumValues;
229
    QString         _category;
230 231
    QString         _group;
    QString         _longDescription;
232
    QVariant        _rawMax;
233
    bool            _maxIsDefaultForType;
234
    QVariant        _rawMin;
235 236 237
    bool            _minIsDefaultForType;
    QString         _name;
    QString         _shortDescription;
238 239
    QString         _rawUnits;
    QString         _cookedUnits;
240 241
    Translator      _rawTranslator;
    Translator      _cookedTranslator;
242
    bool            _rebootRequired;
Don Gagne's avatar
Don Gagne committed
243
    double          _increment;
244
    bool            _hasControl;
245
    bool            _readOnly;
246
    bool            _writeOnly;
247
    bool            _volatile;
248

249 250 251 252 253 254
    // Exact conversion constants
    static const struct UnitConsts_s {
        static const qreal secondsPerHour;
        static const qreal knotsToKPH;
        static const qreal milesToMeters;
        static const qreal feetToMeters;
255
        static const qreal inchesToCentimeters;
256 257
    } constants;

258 259 260 261 262 263 264
    struct BuiltInTranslation_s {
        const char* rawUnits;
        const char* cookedUnits;
        Translator  rawTranslator;
        Translator  cookedTranslator;

    };
265

266
    static const BuiltInTranslation_s _rgBuiltInTranslations[];
267

268
    static const AppSettingsTranslation_s _rgAppSettingsTranslations[];
269 270 271 272 273 274 275 276

    static const char*  _nameJsonKey;
    static const char*  _decimalPlacesJsonKey;
    static const char*  _typeJsonKey;
    static const char*  _shortDescriptionJsonKey;
    static const char*  _longDescriptionJsonKey;
    static const char*  _unitsJsonKey;
    static const char*  _defaultValueJsonKey;
277
    static const char*  _mobileDefaultValueJsonKey;
278 279
    static const char*  _minJsonKey;
    static const char*  _maxJsonKey;
280
    static const char* _hasControlJsonKey;
Don Gagne's avatar
Don Gagne committed
281 282
};

283
#endif