FactMetaData.h 14.4 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
public:
    typedef enum {
        valueTypeUint8,
        valueTypeInt8,
        valueTypeUint16,
        valueTypeInt16,
        valueTypeUint32,
        valueTypeInt32,
39 40
        valueTypeUint64,
        valueTypeInt64,
Don Gagne's avatar
Don Gagne committed
41
        valueTypeFloat,
Don Gagne's avatar
Don Gagne committed
42
        valueTypeDouble,
43
        valueTypeString,
44 45
        valueTypeBool,
        valueTypeElapsedTimeInSeconds,  // Internally stored as double, valueString displays as HH:MM:SS
46
        valueTypeCustom,                // Internally stored as a QByteArray
Don Gagne's avatar
Don Gagne committed
47
    } ValueType_t;
48 49

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

Gus Grubba's avatar
Gus Grubba committed
51 52 53 54
    FactMetaData(QObject* parent = nullptr);
    FactMetaData(ValueType_t type, QObject* parent = nullptr);
    FactMetaData(ValueType_t type, const QString name, QObject* parent = nullptr);
    FactMetaData(const FactMetaData& other, QObject* parent = nullptr);
Don Gagne's avatar
Don Gagne committed
55

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

59 60
    static FactMetaData* createFromJsonObject(const QJsonObject& json, QObject* metaDataParent);

Don Gagne's avatar
Don Gagne committed
61
    const FactMetaData& operator=(const FactMetaData& other);
62

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

72 73 74 75 76 77 78 79 80
    /// 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);

81 82 83
    static const QString defaultCategory    ();
    static const QString defaultGroup       ();

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

Don Gagne's avatar
Don Gagne committed
113 114
    /// Amount to increment value when used in controls such as spin button or slider with detents.
    /// NaN for no increment available.
115
    double          rawIncrement            (void) const { return _rawIncrement; }
116
    double          cookedIncrement         (void) const;
Don Gagne's avatar
Don Gagne committed
117

118 119
    Translator      rawTranslator           (void) const { return _rawTranslator; }
    Translator      cookedTranslator        (void) const { return _cookedTranslator; }
120

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

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

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
    void setDecimalPlaces           (int decimalPlaces)                 { _decimalPlaces = decimalPlaces; }
    void setRawDefaultValue         (const QVariant& rawDefaultValue);
    void setBitmaskInfo             (const QStringList& strings, const QVariantList& values);
    void setEnumInfo                (const QStringList& strings, const QVariantList& values);
    void setCategory                (const QString& category)           { _category = category; }
    void setGroup                   (const QString& group)              { _group = group; }
    void setLongDescription         (const QString& longDescription)    { _longDescription = longDescription;}
    void setRawMax                  (const QVariant& rawMax);
    void setRawMin                  (const QVariant& rawMin);
    void setName                    (const QString& name)               { _name = name; }
    void setShortDescription        (const QString& shortDescription)   { _shortDescription = shortDescription; }
    void setRawUnits                (const QString& rawUnits);
    void setVehicleRebootRequired   (bool rebootRequired)               { _vehicleRebootRequired = rebootRequired; }
    void setQGCRebootRequired       (bool rebootRequired)               { _qgcRebootRequired = rebootRequired; }
    void setRawIncrement            (double increment)                  { _rawIncrement = increment; }
    void setHasControl              (bool bValue)                       { _hasControl = bValue; }
    void setReadOnly                (bool bValue)                       { _readOnly = bValue; }
    void setWriteOnly               (bool bValue)                       { _writeOnly = bValue; }
    void setVolatileValue           (bool bValue);
146 147 148

    void setTranslators(Translator rawTranslator, Translator cookedTranslator);

149 150 151
    /// Set the translators to the standard built in versions
    void setBuiltInTranslator(void);

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

163 164 165 166 167 168
    /// 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);

169 170
    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
171

Don Gagne's avatar
Don Gagne committed
172
    static ValueType_t stringToType(const QString& typeString, bool& unknownType);
173
    static size_t typeToSize(ValueType_t type);
Don Gagne's avatar
Don Gagne committed
174

175
private:
176 177
    QVariant _minForType(void) const;
    QVariant _maxForType(void) const;
178
    void _setAppSettingsTranslators(void);
179 180 181 182 183 184 185

    // 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);
186 187
    static QVariant _userGimbalDegreesToMavlinkGimbalDegrees(const QVariant& userGimbalDegrees);
    static QVariant _mavlinkGimbalDegreesToUserGimbalDegrees(const QVariant& mavlinkGimbalDegrees);
188 189
    static QVariant _metersToFeet(const QVariant& meters);
    static QVariant _feetToMeters(const QVariant& feet);
190 191 192 193 194 195 196 197 198 199
    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);
200 201 202 203 204 205
    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);
206 207
    static QVariant _percentToNorm(const QVariant& percent);
    static QVariant _normToPercent(const QVariant& normalized);
208 209
    static QVariant _centimetersToInches(const QVariant& centimeters);
    static QVariant _inchesToCentimeters(const QVariant& inches);
210 211
    static QVariant _celsiusToFarenheit(const QVariant& celsius);
    static QVariant _farenheitToCelsius(const QVariant& farenheit);
212

Gus Grubba's avatar
Gus Grubba committed
213 214 215 216 217 218
    enum UnitTypes {
        UnitDistance = 0,
        UnitArea,
        UnitSpeed,
        UnitTemperature
    };
219

Gus Grubba's avatar
Gus Grubba committed
220
    struct AppSettingsTranslation_s {
221
        QString     rawUnits;
Gus Grubba's avatar
Gus Grubba committed
222 223 224 225 226
        const char*     cookedUnits;
        UnitTypes       unitType;
        uint32_t        unitOption;
        Translator      rawTranslator;
        Translator      cookedTranslator;
227 228 229
    };

    static const AppSettingsTranslation_s* _findAppSettingsDistanceUnitsTranslation(const QString& rawUnits);
230
    static const AppSettingsTranslation_s* _findAppSettingsAreaUnitsTranslation(const QString& rawUnits);
231

232 233
    ValueType_t     _type;                  // must be first for correct constructor init
    int             _decimalPlaces;
234
    QVariant        _rawDefaultValue;
235
    bool            _defaultValueAvailable;
236 237
    QStringList     _bitmaskStrings;
    QVariantList    _bitmaskValues;
238 239
    QStringList     _enumStrings;
    QVariantList    _enumValues;
240
    QString         _category;
241 242
    QString         _group;
    QString         _longDescription;
243
    QVariant        _rawMax;
244
    bool            _maxIsDefaultForType;
245
    QVariant        _rawMin;
246 247 248
    bool            _minIsDefaultForType;
    QString         _name;
    QString         _shortDescription;
249 250
    QString         _rawUnits;
    QString         _cookedUnits;
251 252
    Translator      _rawTranslator;
    Translator      _cookedTranslator;
253 254
    bool            _vehicleRebootRequired;
    bool            _qgcRebootRequired;
255
    double          _rawIncrement;
256
    bool            _hasControl;
257
    bool            _readOnly;
258
    bool            _writeOnly;
259
    bool            _volatile;
260

261 262 263 264 265 266
    // Exact conversion constants
    static const struct UnitConsts_s {
        static const qreal secondsPerHour;
        static const qreal knotsToKPH;
        static const qreal milesToMeters;
        static const qreal feetToMeters;
267
        static const qreal inchesToCentimeters;
268 269
    } constants;

270
    struct BuiltInTranslation_s {
271
        QString rawUnits;
272 273 274 275 276
        const char* cookedUnits;
        Translator  rawTranslator;
        Translator  cookedTranslator;

    };
277

278
    static const BuiltInTranslation_s _rgBuiltInTranslations[];
279

280
    static const AppSettingsTranslation_s _rgAppSettingsTranslations[];
281

282 283 284 285 286 287 288 289 290 291 292
    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;
    static const char* _mobileDefaultValueJsonKey;
    static const char* _minJsonKey;
    static const char* _maxJsonKey;
    static const char* _incrementJsonKey;
293
    static const char* _hasControlJsonKey;
294
    static const char* _qgcRebootRequiredJsonKey;
Don Gagne's avatar
Don Gagne committed
295 296
};

297
#endif