FactMetaData.cc 62.1 KB
Newer Older
1 2
/****************************************************************************
 *
Gus Grubba's avatar
Gus Grubba committed
3
 * (c) 2009-2020 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
4 5 6 7 8 9
 *
 * 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
#include "FactMetaData.h"
11
#include "SettingsManager.h"
12
#include "JsonHelper.h"
13
#include "QGCApplication.h"
Don Gagne's avatar
Don Gagne committed
14

15
#include <QDebug>
16
#include <QtMath>
17 18
#include <QJsonParseError>
#include <QJsonArray>
19

Don Gagne's avatar
Don Gagne committed
20
#include <limits>
21 22
#include <cmath>

23 24 25 26 27 28 29 30
// Conversion Constants
// Time
const qreal FactMetaData::UnitConsts_s::secondsPerHour = 3600.0;

// Velocity
const qreal FactMetaData::UnitConsts_s::knotsToKPH = 1.852; // exact, hence weird base for knotsToMetersPerSecond

// Length
31 32 33
const qreal FactMetaData::UnitConsts_s::milesToMeters       = 1609.344;
const qreal FactMetaData::UnitConsts_s::feetToMeters        = 0.3048;
const qreal FactMetaData::UnitConsts_s::inchesToCentimeters = 2.54;
34

35
//Weight
36 37
const qreal FactMetaData::UnitConsts_s::ouncesToGrams = 28.3495;
const qreal FactMetaData::UnitConsts_s::poundsToGrams = 453.592;
38

39 40
const char* FactMetaData::kDefaultCategory = QT_TRANSLATE_NOOP("FactMetaData", "Other");
const char* FactMetaData::kDefaultGroup    = QT_TRANSLATE_NOOP("FactMetaData", "Misc");
41

42 43 44 45 46 47 48 49 50 51 52 53 54
const char* FactMetaData::qgcFileType                           = "FactMetaData";
const char* FactMetaData::_jsonMetaDataDefinesName              = "QGC.MetaData.Defines";
const char* FactMetaData::_jsonMetaDataFactsName                = "QGC.MetaData.Facts";
const char* FactMetaData::_enumStringsJsonKey                   = "enumStrings";
const char* FactMetaData::_enumValuesJsonKey                    = "enumValues";

// This is the newer json format for enums and bitmasks. They are used by the new COMPONENT_INFORMATION parameter metadata for example.
const char* FactMetaData::_enumValuesArrayJsonKey               = "values";
const char* FactMetaData::_enumBitmaskArrayJsonKey              = "bitmask";
const char* FactMetaData::_enumValuesArrayValueJsonKey          = "value";
const char* FactMetaData::_enumValuesArrayDescriptionJsonKey    = "description";
const char* FactMetaData::_enumBitmaskArrayIndexJsonKey         = "index";
const char* FactMetaData::_enumBitmaskArrayDescriptionJsonKey   = "description";
55

56 57
// Built in translations for all Facts
const FactMetaData::BuiltInTranslation_s FactMetaData::_rgBuiltInTranslations[] = {
58 59 60 61
    { "centi-degrees",  "deg",  FactMetaData::_centiDegreesToDegrees,                   FactMetaData::_degreesToCentiDegrees },
    { "radians",        "deg",  FactMetaData::_radiansToDegrees,                        FactMetaData::_degreesToRadians },
    { "gimbal-degrees", "deg",  FactMetaData::_mavlinkGimbalDegreesToUserGimbalDegrees, FactMetaData::_userGimbalDegreesToMavlinkGimbalDegrees },
    { "norm",           "%",    FactMetaData::_normToPercent,                           FactMetaData::_percentToNorm },
62
};
Don Gagne's avatar
Don Gagne committed
63

64 65
// Translations driven by app settings
const FactMetaData::AppSettingsTranslation_s FactMetaData::_rgAppSettingsTranslations[] = {
Remek Zajac's avatar
Remek Zajac committed
66 67 68 69 70 71 72 73
    { "m",      "m",        FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsMeters, FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
    { "meter",  "meter",    FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsMeters, FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
    { "meters", "meters",   FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsMeters, FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
    //NOTE: we've coined an artificial "raw unit" of "vertical metre" to separate it from the horizontal metre - a bit awkward but this is all the design permits
    { "vertical m",  "m",   FactMetaData::UnitVerticalDistance,      UnitsSettings::VerticalDistanceUnitsMeters,   FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
    { "cm/px",  "cm/px",    FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsMeters, FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
    { "m/s",    "m/s",      FactMetaData::UnitSpeed,                 UnitsSettings::SpeedUnitsMetersPerSecond,     FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
    { "C",      "C",        FactMetaData::UnitTemperature,           UnitsSettings::TemperatureUnitsCelsius,       FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
74
    { "m^2",    "m^2",      FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsSquareMeters,         FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
Remek Zajac's avatar
Remek Zajac committed
75 76 77
    { "m",      "ft",       FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsFeet,   FactMetaData::_metersToFeet,                        FactMetaData::_feetToMeters },
    { "meter",  "ft",       FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsFeet,   FactMetaData::_metersToFeet,                        FactMetaData::_feetToMeters },
    { "meters", "ft",       FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsFeet,   FactMetaData::_metersToFeet,                        FactMetaData::_feetToMeters },
Remek Zajac's avatar
Remek Zajac committed
78
    { "vertical m",  "ft",  FactMetaData::UnitVerticalDistance,      UnitsSettings::VerticalDistanceUnitsFeet,     FactMetaData::_metersToFeet,                        FactMetaData::_feetToMeters },
Remek Zajac's avatar
Remek Zajac committed
79
    { "cm/px",  "in/px",    FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsFeet,   FactMetaData::_centimetersToInches,                 FactMetaData::_inchesToCentimeters },
80
    { "m^2",    "km^2",     FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsSquareKilometers,     FactMetaData::_squareMetersToSquareKilometers,      FactMetaData::_squareKilometersToSquareMeters },
Remek Zajac's avatar
Remek Zajac committed
81
    { "m^2",    "ha",       FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsHectares,             FactMetaData::_squareMetersToHectares,              FactMetaData::_hectaresToSquareMeters },
82
    { "m^2",    "ft^2",     FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsSquareFeet,           FactMetaData::_squareMetersToSquareFeet,            FactMetaData::_squareFeetToSquareMeters },
Remek Zajac's avatar
Remek Zajac committed
83
    { "m^2",    "ac",       FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsAcres,                FactMetaData::_squareMetersToAcres,                 FactMetaData::_acresToSquareMeters },
84
    { "m^2",    "mi^2",     FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsSquareMiles,          FactMetaData::_squareMetersToSquareMiles,           FactMetaData::_squareMilesToSquareMeters },
Remek Zajac's avatar
Remek Zajac committed
85 86 87 88 89 90 91 92 93
    { "m/s",    "ft/s",     FactMetaData::UnitSpeed,                 UnitsSettings::SpeedUnitsFeetPerSecond,       FactMetaData::_metersToFeet,                        FactMetaData::_feetToMeters },
    { "m/s",    "mph",      FactMetaData::UnitSpeed,                 UnitsSettings::SpeedUnitsMilesPerHour,        FactMetaData::_metersPerSecondToMilesPerHour,       FactMetaData::_milesPerHourToMetersPerSecond },
    { "m/s",    "km/h",     FactMetaData::UnitSpeed,                 UnitsSettings::SpeedUnitsKilometersPerHour,   FactMetaData::_metersPerSecondToKilometersPerHour,  FactMetaData::_kilometersPerHourToMetersPerSecond },
    { "m/s",    "kn",       FactMetaData::UnitSpeed,                 UnitsSettings::SpeedUnitsKnots,               FactMetaData::_metersPerSecondToKnots,              FactMetaData::_knotsToMetersPerSecond },
    { "C",      "F",        FactMetaData::UnitTemperature,           UnitsSettings::TemperatureUnitsFarenheit,     FactMetaData::_celsiusToFarenheit,                  FactMetaData::_farenheitToCelsius },
    { "g",      "g",        FactMetaData::UnitWeight,                UnitsSettings::WeightUnitsGrams,              FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
    { "g",      "kg",       FactMetaData::UnitWeight,                UnitsSettings::WeightUnitsKg,                 FactMetaData::_gramsToKilograms,                    FactMetaData::_kilogramsToGrams },
    { "g",      "oz",       FactMetaData::UnitWeight,                UnitsSettings::WeightUnitsOz,                 FactMetaData::_gramsToOunces,                       FactMetaData::_ouncesToGrams },
    { "g",      "lbs",      FactMetaData::UnitWeight,                UnitsSettings::WeightUnitsLbs,                FactMetaData::_gramsToPunds,                        FactMetaData::_poundsToGrams },
94 95
};

DonLakeFlyer's avatar
DonLakeFlyer committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
const char* FactMetaData::_rgKnownTypeStrings[] = {
    "Uint8",
    "Int8",
    "Uint16",
    "Int16",
    "Uint32",
    "Int32",
    "Uint64",
    "Int64",
    "Float",
    "Double",
    "String",
    "Bool",
    "ElapsedSeconds",
    "Custom",
};

const  FactMetaData::ValueType_t FactMetaData::_rgKnownValueTypes[] = {
    valueTypeUint8,
    valueTypeInt8,
    valueTypeUint16,
    valueTypeInt16,
    valueTypeUint32,
    valueTypeInt32,
    valueTypeUint64,
    valueTypeInt64,
    valueTypeFloat,
    valueTypeDouble,
    valueTypeString,
    valueTypeBool,
    valueTypeElapsedTimeInSeconds,
    valueTypeCustom,
};

130 131 132
const char* FactMetaData::_decimalPlacesJsonKey =       "decimalPlaces";
const char* FactMetaData::_nameJsonKey =                "name";
const char* FactMetaData::_typeJsonKey =                "type";
133 134
const char* FactMetaData::_shortDescriptionJsonKey =    "shortDesc";
const char* FactMetaData::_longDescriptionJsonKey =     "longDesc";
135
const char* FactMetaData::_unitsJsonKey =               "units";
136 137
const char* FactMetaData::_defaultValueJsonKey =        "default";
const char* FactMetaData::_mobileDefaultValueJsonKey =  "mobileDefault";
138 139
const char* FactMetaData::_minJsonKey =                 "min";
const char* FactMetaData::_maxJsonKey =                 "max";
140
const char* FactMetaData::_incrementJsonKey =           "increment";
141
const char* FactMetaData::_hasControlJsonKey =          "control";
142
const char* FactMetaData::_qgcRebootRequiredJsonKey =   "qgcRebootRequired";
143 144 145
const char* FactMetaData::_categoryJsonKey =            "category";
const char* FactMetaData::_groupJsonKey =               "group";
const char* FactMetaData::_volatileJsonKey =            "volatile";
146

147
FactMetaData::FactMetaData(QObject* parent)
148 149
    : QObject               (parent)
    , _type                 (valueTypeInt32)
150
    , _decimalPlaces        (kUnknownDecimalPlaces)
151
    , _rawDefaultValue      (0)
152
    , _defaultValueAvailable(false)
153 154 155 156 157 158
    , _rawMax               (_maxForType())
    , _maxIsDefaultForType  (true)
    , _rawMin               (_minForType())
    , _minIsDefaultForType  (true)
    , _rawTranslator        (_defaultTranslator)
    , _cookedTranslator     (_defaultTranslator)
159 160
    , _vehicleRebootRequired(false)
    , _qgcRebootRequired    (false)
161
    , _rawIncrement         (std::numeric_limits<double>::quiet_NaN())
162 163
    , _hasControl           (true)
    , _readOnly             (false)
164
    , _writeOnly            (false)
165
    , _volatile             (false)
Don Gagne's avatar
Don Gagne committed
166
{
167 168
    _category   = kDefaultCategory;
    _group      = kDefaultGroup;
Don Gagne's avatar
Don Gagne committed
169 170
}

171
FactMetaData::FactMetaData(ValueType_t type, QObject* parent)
172 173
    : QObject               (parent)
    , _type                 (type)
174
    , _decimalPlaces        (kUnknownDecimalPlaces)
175
    , _rawDefaultValue      (0)
176
    , _defaultValueAvailable(false)
177 178 179 180 181 182
    , _rawMax               (_maxForType())
    , _maxIsDefaultForType  (true)
    , _rawMin               (_minForType())
    , _minIsDefaultForType  (true)
    , _rawTranslator        (_defaultTranslator)
    , _cookedTranslator     (_defaultTranslator)
183 184
    , _vehicleRebootRequired(false)
    , _qgcRebootRequired    (false)
185
    , _rawIncrement         (std::numeric_limits<double>::quiet_NaN())
186 187
    , _hasControl           (true)
    , _readOnly             (false)
188
    , _writeOnly            (false)
189
    , _volatile             (false)
190
{
191 192
    _category   = kDefaultCategory;
    _group      = kDefaultGroup;
193 194
}

Don Gagne's avatar
Don Gagne committed
195 196 197 198 199 200
FactMetaData::FactMetaData(const FactMetaData& other, QObject* parent)
    : QObject(parent)
{
    *this = other;
}

201
FactMetaData::FactMetaData(ValueType_t type, const QString name, QObject* parent)
202 203
    : QObject               (parent)
    , _type                 (type)
204
    , _decimalPlaces        (kUnknownDecimalPlaces)
205
    , _rawDefaultValue      (0)
206
    , _defaultValueAvailable(false)
207 208 209 210 211 212 213
    , _rawMax               (_maxForType())
    , _maxIsDefaultForType  (true)
    , _rawMin               (_minForType())
    , _minIsDefaultForType  (true)
    , _name                 (name)
    , _rawTranslator        (_defaultTranslator)
    , _cookedTranslator     (_defaultTranslator)
214 215
    , _vehicleRebootRequired(false)
    , _qgcRebootRequired    (false)
216
    , _rawIncrement         (std::numeric_limits<double>::quiet_NaN())
217 218
    , _hasControl           (true)
    , _readOnly             (false)
219
    , _writeOnly            (false)
220
    , _volatile             (false)
221
{
222 223
    _category   = kDefaultCategory;
    _group      = kDefaultGroup;
224 225
}

Don Gagne's avatar
Don Gagne committed
226 227
const FactMetaData& FactMetaData::operator=(const FactMetaData& other)
{
228
    _decimalPlaces          = other._decimalPlaces;
229
    _rawDefaultValue        = other._rawDefaultValue;
Don Gagne's avatar
Don Gagne committed
230
    _defaultValueAvailable  = other._defaultValueAvailable;
231 232
    _bitmaskStrings         = other._bitmaskStrings;
    _bitmaskValues          = other._bitmaskValues;
233 234
    _enumStrings            = other._enumStrings;
    _enumValues             = other._enumValues;
235
    _category               = other._category;
236 237
    _group                  = other._group;
    _longDescription        = other._longDescription;
238
    _rawMax                 = other._rawMax;
Don Gagne's avatar
Don Gagne committed
239
    _maxIsDefaultForType    = other._maxIsDefaultForType;
240
    _rawMin                 = other._rawMin;
241 242 243 244
    _minIsDefaultForType    = other._minIsDefaultForType;
    _name                   = other._name;
    _shortDescription       = other._shortDescription;
    _type                   = other._type;
245 246
    _rawUnits               = other._rawUnits;
    _cookedUnits            = other._cookedUnits;
247 248
    _rawTranslator          = other._rawTranslator;
    _cookedTranslator       = other._cookedTranslator;
249 250
    _vehicleRebootRequired  = other._vehicleRebootRequired;
    _qgcRebootRequired      = other._qgcRebootRequired;
251
    _rawIncrement           = other._rawIncrement;
252
    _hasControl             = other._hasControl;
253
    _readOnly               = other._readOnly;
254
    _writeOnly              = other._writeOnly;
255
    _volatile               = other._volatile;
Don Gagne's avatar
Don Gagne committed
256 257 258
    return *this;
}

259 260 261 262 263 264 265 266 267 268
const QString FactMetaData::defaultCategory()
{
    return QString(kDefaultCategory);
}

const QString FactMetaData::defaultGroup()
{
    return QString(kDefaultGroup);
}

269
QVariant FactMetaData::rawDefaultValue(void) const
270 271
{
    if (_defaultValueAvailable) {
272
        return _rawDefaultValue;
273 274 275 276 277 278
    } else {
        qWarning() << "Attempt to access unavailable default value";
        return QVariant(0);
    }
}

279
void FactMetaData::setRawDefaultValue(const QVariant& rawDefaultValue)
280
{
281
    if (_type == valueTypeString || (isInRawMinLimit(rawDefaultValue) && isInRawMaxLimit(rawDefaultValue))) {
282
        _rawDefaultValue = rawDefaultValue;
283 284 285 286 287 288
        _defaultValueAvailable = true;
    } else {
        qWarning() << "Attempt to set default value which is outside min/max range";
    }
}

289
void FactMetaData::setRawMin(const QVariant& rawMin)
290
{
291
    if (isInRawMinLimit(rawMin)) {
292
        _rawMin = rawMin;
Don Gagne's avatar
Don Gagne committed
293
        _minIsDefaultForType = false;
294
    } else {
295
        qWarning() << "Attempt to set min below allowable value for fact: " << name()
296
                   << ", value attempted: " << rawMin
297
                   << ", type: " << type() << ", min for type: " << _minForType();
298
        _rawMin = _minForType();
299 300 301
    }
}

302
void FactMetaData::setRawMax(const QVariant& rawMax)
303
{
304
    if (isInRawMaxLimit(rawMax)) {
305
        _rawMax = rawMax;
Don Gagne's avatar
Don Gagne committed
306
        _maxIsDefaultForType = false;
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
    } else {
        qWarning() << "Attempt to set max above allowable value";
        _rawMax = _maxForType();
    }
}

bool FactMetaData::isInRawMinLimit(const QVariant& variantValue) const
{
    switch (_type) {
    case valueTypeUint8:
        return _rawMin.value<unsigned char>() <= variantValue.value<unsigned char>();
    case valueTypeInt8:
        return _rawMin.value<signed char>() <= variantValue.value<signed char>();
    case valueTypeUint16:
        return _rawMin.value<unsigned short int>() <= variantValue.value<unsigned short int>();
    case valueTypeInt16:
        return _rawMin.value<short int>() <= variantValue.value<short int>();
    case valueTypeUint32:
        return _rawMin.value<uint32_t>() <= variantValue.value<uint32_t>();
    case valueTypeInt32:
        return _rawMin.value<int32_t>() <= variantValue.value<int32_t>();
    case valueTypeUint64:
        return _rawMin.value<uint64_t>() <= variantValue.value<uint64_t>();
    case valueTypeInt64:
        return _rawMin.value<int64_t>() <= variantValue.value<int64_t>();
    case valueTypeFloat:
333
        return qIsNaN(variantValue.toFloat()) || _rawMin.value<float>() <= variantValue.value<float>();
334
    case valueTypeDouble:
335
        return qIsNaN(variantValue.toDouble()) || _rawMin.value<double>() <= variantValue.value<double>();
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
    default:
        return true;
    }

    return true;
}

bool FactMetaData::isInRawMaxLimit(const QVariant& variantValue) const
{
    switch (_type) {
    case valueTypeUint8:
        return _rawMax.value<unsigned char>() >= variantValue.value<unsigned char>();
    case valueTypeInt8:
        return _rawMax.value<signed char>() >= variantValue.value<signed char>();
    case valueTypeUint16:
        return _rawMax.value<unsigned short int>() >= variantValue.value<unsigned short int>();
    case valueTypeInt16:
        return _rawMax.value<short int>() >= variantValue.value<short int>();
    case valueTypeUint32:
        return _rawMax.value<uint32_t>() >= variantValue.value<uint32_t>();
    case valueTypeInt32:
        return _rawMax.value<int32_t>() >= variantValue.value<int32_t>();
    case valueTypeUint64:
        return _rawMax.value<uint64_t>() >= variantValue.value<uint64_t>();
    case valueTypeInt64:
        return _rawMax.value<int64_t>() >= variantValue.value<int64_t>();
    case valueTypeFloat:
363
        return qIsNaN(variantValue.toFloat()) || _rawMax.value<float>() >= variantValue.value<float>();
364
    case valueTypeDouble:
365
        return qIsNaN(variantValue.toDouble()) || _rawMax.value<double>() >= variantValue.value<double>();
366 367
    default:
        return true;
368
    }
369 370

    return true;
371 372
}

373
QVariant FactMetaData::_minForType(void) const
Don Gagne's avatar
Don Gagne committed
374
{
375
    switch (_type) {
376 377 378 379 380 381 382 383 384
    case valueTypeUint8:
        return QVariant(std::numeric_limits<unsigned char>::min());
    case valueTypeInt8:
        return QVariant(std::numeric_limits<signed char>::min());
    case valueTypeUint16:
        return QVariant(std::numeric_limits<unsigned short int>::min());
    case valueTypeInt16:
        return QVariant(std::numeric_limits<short int>::min());
    case valueTypeUint32:
385
        return QVariant(std::numeric_limits<uint32_t>::min());
386
    case valueTypeInt32:
387 388
        return QVariant(std::numeric_limits<int32_t>::min());
    case valueTypeUint64:
389
        return QVariant((qulonglong)std::numeric_limits<uint64_t>::min());
390
    case valueTypeInt64:
391
        return QVariant((qlonglong)std::numeric_limits<int64_t>::min());
392 393 394 395
    case valueTypeFloat:
        return QVariant(-std::numeric_limits<float>::max());
    case valueTypeDouble:
        return QVariant(-std::numeric_limits<double>::max());
Don Gagne's avatar
Don Gagne committed
396 397
    case valueTypeString:
        return QVariant();
398 399
    case valueTypeBool:
        return QVariant(0);
400 401
    case valueTypeElapsedTimeInSeconds:
        return QVariant(0.0);
402 403
    case valueTypeCustom:
        return QVariant();
404
    }
405

Don Gagne's avatar
Don Gagne committed
406 407
    // Make windows compiler happy, even switch is full cased
    return QVariant();
Don Gagne's avatar
Don Gagne committed
408
}
Don Gagne's avatar
Don Gagne committed
409

410
QVariant FactMetaData::_maxForType(void) const
Don Gagne's avatar
Don Gagne committed
411
{
412
    switch (_type) {
413 414 415 416 417 418 419 420 421
    case valueTypeUint8:
        return QVariant(std::numeric_limits<unsigned char>::max());
    case valueTypeInt8:
        return QVariant(std::numeric_limits<signed char>::max());
    case valueTypeUint16:
        return QVariant(std::numeric_limits<unsigned short int>::max());
    case valueTypeInt16:
        return QVariant(std::numeric_limits<short int>::max());
    case valueTypeUint32:
422
        return QVariant(std::numeric_limits<uint32_t>::max());
423
    case valueTypeInt32:
424 425
        return QVariant(std::numeric_limits<int32_t>::max());
    case valueTypeUint64:
426
        return QVariant((qulonglong)std::numeric_limits<uint64_t>::max());
427
    case valueTypeInt64:
428
        return QVariant((qlonglong)std::numeric_limits<int64_t>::max());
429 430
    case valueTypeFloat:
        return QVariant(std::numeric_limits<float>::max());
431
    case valueTypeElapsedTimeInSeconds:
432 433
    case valueTypeDouble:
        return QVariant(std::numeric_limits<double>::max());
Don Gagne's avatar
Don Gagne committed
434 435
    case valueTypeString:
        return QVariant();
436 437
    case valueTypeBool:
        return QVariant(1);
438 439
    case valueTypeCustom:
        return QVariant();
440
    }
441

Don Gagne's avatar
Don Gagne committed
442 443
    // Make windows compiler happy, even switch is full cased
    return QVariant();
Don Gagne's avatar
Don Gagne committed
444
}
Don Gagne's avatar
Don Gagne committed
445

446
bool FactMetaData::convertAndValidateRaw(const QVariant& rawValue, bool convertOnly, QVariant& typedValue, QString& errorString)
Don Gagne's avatar
Don Gagne committed
447
{
448
    bool convertOk = false;
449

Don Gagne's avatar
Don Gagne committed
450
    errorString.clear();
451

Don Gagne's avatar
Don Gagne committed
452
    switch (type()) {
453 454 455 456 457
    case FactMetaData::valueTypeInt8:
    case FactMetaData::valueTypeInt16:
    case FactMetaData::valueTypeInt32:
        typedValue = QVariant(rawValue.toInt(&convertOk));
        if (!convertOnly && convertOk) {
458
            if (!isInRawLimit<int32_t>(typedValue)) {
459
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toInt()).arg(rawMax().toInt());
Don Gagne's avatar
Don Gagne committed
460
            }
461 462
        }
        break;
463 464 465
    case FactMetaData::valueTypeInt64:
        typedValue = QVariant(rawValue.toLongLong(&convertOk));
        if (!convertOnly && convertOk) {
466
            if (!isInRawLimit<int64_t>(typedValue)) {
467 468 469 470
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toInt()).arg(rawMax().toInt());
            }
        }
        break;
471 472 473 474 475
    case FactMetaData::valueTypeUint8:
    case FactMetaData::valueTypeUint16:
    case FactMetaData::valueTypeUint32:
        typedValue = QVariant(rawValue.toUInt(&convertOk));
        if (!convertOnly && convertOk) {
476
            if (!isInRawLimit<uint32_t>(typedValue)) {
477
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toUInt()).arg(rawMax().toUInt());
Don Gagne's avatar
Don Gagne committed
478
            }
479 480
        }
        break;
481 482 483
    case FactMetaData::valueTypeUint64:
        typedValue = QVariant(rawValue.toULongLong(&convertOk));
        if (!convertOnly && convertOk) {
484
            if (!isInRawLimit<uint64_t>(typedValue)) {
485 486 487 488
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toUInt()).arg(rawMax().toUInt());
            }
        }
        break;
489 490 491
    case FactMetaData::valueTypeFloat:
        typedValue = QVariant(rawValue.toFloat(&convertOk));
        if (!convertOnly && convertOk) {
492
            if (!isInRawLimit<float>(typedValue)) {
493
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toDouble()).arg(rawMax().toDouble());
Don Gagne's avatar
Don Gagne committed
494
            }
495 496
        }
        break;
497
    case FactMetaData::valueTypeElapsedTimeInSeconds:
498 499 500
    case FactMetaData::valueTypeDouble:
        typedValue = QVariant(rawValue.toDouble(&convertOk));
        if (!convertOnly && convertOk) {
501
            if (!isInRawLimit<double>(typedValue)) {
502
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toDouble()).arg(rawMax().toDouble());
Don Gagne's avatar
Don Gagne committed
503
            }
504 505
        }
        break;
Don Gagne's avatar
Don Gagne committed
506 507 508 509
    case FactMetaData::valueTypeString:
        convertOk = true;
        typedValue = QVariant(rawValue.toString());
        break;
510 511 512 513
    case FactMetaData::valueTypeBool:
        convertOk = true;
        typedValue = QVariant(rawValue.toBool());
        break;
514 515 516 517
    case FactMetaData::valueTypeCustom:
        convertOk = true;
        typedValue = QVariant(rawValue.toByteArray());
        break;
Don Gagne's avatar
Don Gagne committed
518
    }
519

Don Gagne's avatar
Don Gagne committed
520
    if (!convertOk) {
521
        errorString += tr("Invalid number");
Don Gagne's avatar
Don Gagne committed
522
    }
523

Don Gagne's avatar
Don Gagne committed
524 525
    return convertOk && errorString.isEmpty();
}
526

527 528 529 530 531 532
bool FactMetaData::convertAndValidateCooked(const QVariant& cookedValue, bool convertOnly, QVariant& typedValue, QString& errorString)
{
    bool convertOk = false;

    errorString.clear();

533 534 535 536 537 538 539
    if (!convertOnly && _customCookedValidator) {
        errorString = _customCookedValidator(cookedValue);
        if (!errorString.isEmpty()) {
            return false;
        }
    }

540
    switch (type()) {
541 542 543 544 545
    case FactMetaData::valueTypeInt8:
    case FactMetaData::valueTypeInt16:
    case FactMetaData::valueTypeInt32:
        typedValue = QVariant(cookedValue.toInt(&convertOk));
        if (!convertOnly && convertOk) {
546
            if (!isInCookedLimit<int32_t>(typedValue)) {
547
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toInt()).arg(cookedMax().toInt());
548
            }
549 550
        }
        break;
551 552 553
    case FactMetaData::valueTypeInt64:
        typedValue = QVariant(cookedValue.toLongLong(&convertOk));
        if (!convertOnly && convertOk) {
554
            if (!isInCookedLimit<int64_t>(typedValue)) {
555 556 557 558
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toInt()).arg(cookedMax().toInt());
            }
        }
        break;
559 560 561 562 563
    case FactMetaData::valueTypeUint8:
    case FactMetaData::valueTypeUint16:
    case FactMetaData::valueTypeUint32:
        typedValue = QVariant(cookedValue.toUInt(&convertOk));
        if (!convertOnly && convertOk) {
564
            if (!isInCookedLimit<uint32_t>(typedValue)) {
565
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toUInt()).arg(cookedMax().toUInt());
566
            }
567 568
        }
        break;
569 570 571
    case FactMetaData::valueTypeUint64:
        typedValue = QVariant(cookedValue.toULongLong(&convertOk));
        if (!convertOnly && convertOk) {
572
            if (!isInCookedLimit<uint64_t>(typedValue)) {
573 574 575 576
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toUInt()).arg(cookedMax().toUInt());
            }
        }
        break;
577 578 579
    case FactMetaData::valueTypeFloat:
        typedValue = QVariant(cookedValue.toFloat(&convertOk));
        if (!convertOnly && convertOk) {
580
            if (!isInCookedLimit<float>(typedValue)) {
581
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toFloat()).arg(cookedMax().toFloat());
582
            }
583 584
        }
        break;
585
    case FactMetaData::valueTypeElapsedTimeInSeconds:
586 587 588
    case FactMetaData::valueTypeDouble:
        typedValue = QVariant(cookedValue.toDouble(&convertOk));
        if (!convertOnly && convertOk) {
589
            if (!isInCookedLimit<double>(typedValue)) {
590
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toDouble()).arg(cookedMax().toDouble());
591
            }
592 593
        }
        break;
Don Gagne's avatar
Don Gagne committed
594 595 596 597
    case FactMetaData::valueTypeString:
        convertOk = true;
        typedValue = QVariant(cookedValue.toString());
        break;
598 599 600 601
    case FactMetaData::valueTypeBool:
        convertOk = true;
        typedValue = QVariant(cookedValue.toBool());
        break;
602 603 604 605
    case FactMetaData::valueTypeCustom:
        convertOk = true;
        typedValue = QVariant(cookedValue.toByteArray());
        break;
606 607 608
    }

    if (!convertOk) {
609
        errorString += tr("Invalid number");
610 611 612 613 614
    }

    return convertOk && errorString.isEmpty();
}

615 616 617 618 619 620 621 622 623
bool FactMetaData::clampValue(const QVariant& cookedValue, QVariant& typedValue)
{
    bool convertOk = false;
    switch (type()) {
    case FactMetaData::valueTypeInt8:
    case FactMetaData::valueTypeInt16:
    case FactMetaData::valueTypeInt32:
        typedValue = QVariant(cookedValue.toInt(&convertOk));
        if (convertOk) {
624
            clamp<int32_t>(typedValue);
625 626
        }
        break;
627 628 629
    case FactMetaData::valueTypeInt64:
        typedValue = QVariant(cookedValue.toLongLong(&convertOk));
        if (convertOk) {
630
            clamp<int64_t>(typedValue);
631 632
        }
        break;
633 634 635 636 637
    case FactMetaData::valueTypeUint8:
    case FactMetaData::valueTypeUint16:
    case FactMetaData::valueTypeUint32:
        typedValue = QVariant(cookedValue.toUInt(&convertOk));
        if (convertOk) {
638
            clamp<uint32_t>(typedValue);
639 640
        }
        break;
641 642 643
    case FactMetaData::valueTypeUint64:
        typedValue = QVariant(cookedValue.toULongLong(&convertOk));
        if (convertOk) {
644
            clamp<uint64_t>(typedValue);
645 646
        }
        break;
647 648 649
    case FactMetaData::valueTypeFloat:
        typedValue = QVariant(cookedValue.toFloat(&convertOk));
        if (convertOk) {
650
            clamp<float>(typedValue);
651 652 653 654 655 656
        }
        break;
    case FactMetaData::valueTypeElapsedTimeInSeconds:
    case FactMetaData::valueTypeDouble:
        typedValue = QVariant(cookedValue.toDouble(&convertOk));
        if (convertOk) {
657
            clamp<double>(typedValue);
658 659 660 661 662 663 664 665 666 667
        }
        break;
    case FactMetaData::valueTypeString:
        convertOk = true;
        typedValue = QVariant(cookedValue.toString());
        break;
    case FactMetaData::valueTypeBool:
        convertOk = true;
        typedValue = QVariant(cookedValue.toBool());
        break;
668 669 670 671
    case FactMetaData::valueTypeCustom:
        convertOk = true;
        typedValue = QVariant(cookedValue.toByteArray());
        break;
672 673 674 675
    }
    return convertOk;
}

676 677 678 679 680 681 682 683 684
void FactMetaData::setBitmaskInfo(const QStringList& strings, const QVariantList& values)
{
    if (strings.count() != values.count()) {
        qWarning() << "Count mismatch strings:values" << strings.count() << values.count();
        return;
    }

    _bitmaskStrings = strings;
    _bitmaskValues = values;
685
    setBuiltInTranslator();
686 687 688 689 690 691 692 693
}

void FactMetaData::addBitmaskInfo(const QString& name, const QVariant& value)
{
    _bitmaskStrings << name;
    _bitmaskValues << value;
}

694 695 696 697 698 699 700 701 702
void FactMetaData::setEnumInfo(const QStringList& strings, const QVariantList& values)
{
    if (strings.count() != values.count()) {
        qWarning() << "Count mismatch strings:values" << strings.count() << values.count();
        return;
    }

    _enumStrings = strings;
    _enumValues = values;
703
    setBuiltInTranslator();
704 705
}

706 707 708 709 710 711
void FactMetaData::addEnumInfo(const QString& name, const QVariant& value)
{
    _enumStrings << name;
    _enumValues << value;
}

712 713 714 715 716
void FactMetaData::setTranslators(Translator rawTranslator, Translator cookedTranslator)
{
    _rawTranslator = rawTranslator;
    _cookedTranslator = cookedTranslator;
}
717

718
void FactMetaData::setBuiltInTranslator(void)
719
{
720
    if (_enumStrings.count() || _bitmaskStrings.count()) {
721 722 723
        // No translation if enum
        setTranslators(_defaultTranslator, _defaultTranslator);
        _cookedUnits = _rawUnits;
724
        return;
725
    } else {
726 727
        for (size_t i=0; i<sizeof(_rgBuiltInTranslations)/sizeof(_rgBuiltInTranslations[0]); i++) {
            const BuiltInTranslation_s* pBuiltInTranslation = &_rgBuiltInTranslations[i];
728

729
            if (pBuiltInTranslation->rawUnits.toLower() == _rawUnits.toLower()) {
730 731
                _cookedUnits = pBuiltInTranslation->cookedUnits;
                setTranslators(pBuiltInTranslation->rawTranslator, pBuiltInTranslation->cookedTranslator);
732
                return;
733 734 735
            }
        }
    }
736 737 738

    // Translator not yet set, try app settings translators
    _setAppSettingsTranslators();
739 740 741 742
}

QVariant FactMetaData::_degreesToRadians(const QVariant& degrees)
{
743
    return QVariant(qDegreesToRadians(degrees.toDouble()));
744 745 746 747
}

QVariant FactMetaData::_radiansToDegrees(const QVariant& radians)
{
748
    return QVariant(qRadiansToDegrees(radians.toDouble()));
749 750 751 752
}

QVariant FactMetaData::_centiDegreesToDegrees(const QVariant& centiDegrees)
{
753
    return QVariant(centiDegrees.toReal() / 100.0);
754 755 756 757
}

QVariant FactMetaData::_degreesToCentiDegrees(const QVariant& degrees)
{
758
    return QVariant(qRound(degrees.toReal() * 100.0));
759 760
}

761 762 763 764 765 766 767 768 769 770 771 772 773 774
QVariant FactMetaData::_userGimbalDegreesToMavlinkGimbalDegrees(const QVariant& userGimbalDegrees)
{
    // User facing gimbal degree values are from 0 (level) to 90 (straight down)
    // Mavlink gimbal degree values are from 0 (level) to -90 (straight down)
    return userGimbalDegrees.toDouble() * -1.0;
}

QVariant FactMetaData::_mavlinkGimbalDegreesToUserGimbalDegrees(const QVariant& mavlinkGimbalDegrees)
{
    // User facing gimbal degree values are from 0 (level) to 90 (straight down)
    // Mavlink gimbal degree values are from 0 (level) to -90 (straight down)
    return mavlinkGimbalDegrees.toDouble() * -1.0;
}

775 776
QVariant FactMetaData::_metersToFeet(const QVariant& meters)
{
777
    return QVariant(meters.toDouble() * 1.0/constants.feetToMeters);
778 779 780 781
}

QVariant FactMetaData::_feetToMeters(const QVariant& feet)
{
782
    return QVariant(feet.toDouble() * constants.feetToMeters);
783 784
}

785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
QVariant FactMetaData::_squareMetersToSquareKilometers(const QVariant& squareMeters)
{
    return QVariant(squareMeters.toDouble() * 0.000001);
}

QVariant FactMetaData::_squareKilometersToSquareMeters(const QVariant& squareKilometers)
{
    return QVariant(squareKilometers.toDouble() * 1000000.0);
}

QVariant FactMetaData::_squareMetersToHectares(const QVariant& squareMeters)
{
    return QVariant(squareMeters.toDouble() * 0.0001);
}

QVariant FactMetaData::_hectaresToSquareMeters(const QVariant& hectares)
{
    return QVariant(hectares.toDouble() * 1000.0);
}

QVariant FactMetaData::_squareMetersToSquareFeet(const QVariant& squareMeters)
{
    return QVariant(squareMeters.toDouble() * 10.7639);
}

QVariant FactMetaData::_squareFeetToSquareMeters(const QVariant& squareFeet)
{
    return QVariant(squareFeet.toDouble() * 0.0929);
}

QVariant FactMetaData::_squareMetersToAcres(const QVariant& squareMeters)
{
    return QVariant(squareMeters.toDouble() * 0.000247105);
}

QVariant FactMetaData::_acresToSquareMeters(const QVariant& acres)
{
    return QVariant(acres.toDouble() * 4046.86);
}

QVariant FactMetaData::_squareMetersToSquareMiles(const QVariant& squareMeters)
{
    return QVariant(squareMeters.toDouble() * 3.86102e-7);
}

QVariant FactMetaData::_squareMilesToSquareMeters(const QVariant& squareMiles)
{
    return QVariant(squareMiles.toDouble() * 258999039.98855);
}

835 836
QVariant FactMetaData::_metersPerSecondToMilesPerHour(const QVariant& metersPerSecond)
{
837
    return QVariant((metersPerSecond.toDouble() * 1.0/constants.milesToMeters) * constants.secondsPerHour);
838 839 840 841
}

QVariant FactMetaData::_milesPerHourToMetersPerSecond(const QVariant& milesPerHour)
{
842
    return QVariant((milesPerHour.toDouble() * constants.milesToMeters) / constants.secondsPerHour);
843 844 845 846
}

QVariant FactMetaData::_metersPerSecondToKilometersPerHour(const QVariant& metersPerSecond)
{
847
    return QVariant((metersPerSecond.toDouble() / 1000.0) * constants.secondsPerHour);
848 849 850 851
}

QVariant FactMetaData::_kilometersPerHourToMetersPerSecond(const QVariant& kilometersPerHour)
{
852
    return QVariant((kilometersPerHour.toDouble() * 1000.0) / constants.secondsPerHour);
853 854 855 856
}

QVariant FactMetaData::_metersPerSecondToKnots(const QVariant& metersPerSecond)
{
857
    return QVariant(metersPerSecond.toDouble() * constants.secondsPerHour / (1000.0 * constants.knotsToKPH));
858 859 860 861
}

QVariant FactMetaData::_knotsToMetersPerSecond(const QVariant& knots)
{
862
    return QVariant(knots.toDouble() * (1000.0 * constants.knotsToKPH / constants.secondsPerHour));
863 864
}

865 866 867 868 869 870 871 872 873 874
QVariant FactMetaData::_percentToNorm(const QVariant& percent)
{
    return QVariant(percent.toDouble() / 100.0);
}

QVariant FactMetaData::_normToPercent(const QVariant& normalized)
{
    return QVariant(normalized.toDouble() * 100.0);
}

875 876 877 878 879 880 881 882 883 884
QVariant FactMetaData::_centimetersToInches(const QVariant& centimeters)
{
    return QVariant(centimeters.toDouble() * 1.0/constants.inchesToCentimeters);
}

QVariant FactMetaData::_inchesToCentimeters(const QVariant& inches)
{
    return QVariant(inches.toDouble() * constants.inchesToCentimeters);
}

885 886 887 888 889 890 891 892 893 894
QVariant FactMetaData::_celsiusToFarenheit(const QVariant& celsius)
{
    return QVariant(celsius.toDouble() * (9.0 / 5.0) + 32);
}

QVariant FactMetaData::_farenheitToCelsius(const QVariant& farenheit)
{
    return QVariant((farenheit.toDouble() - 32) * (5.0 / 9.0));
}

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
QVariant FactMetaData::_kilogramsToGrams(const QVariant& kg) {
    return QVariant(kg.toDouble() * 1000);
}

QVariant FactMetaData::_ouncesToGrams(const QVariant& oz) {
    return QVariant(oz.toDouble() * constants.ouncesToGrams);
}

QVariant FactMetaData::_poundsToGrams(const QVariant& lbs) {
    return QVariant(lbs.toDouble() * constants.poundsToGrams);
}

QVariant FactMetaData::_gramsToKilograms(const QVariant& g) {
    return QVariant(g.toDouble() / 1000);
}

QVariant FactMetaData::_gramsToOunces(const QVariant& g) {
    return QVariant(g.toDouble() / constants.ouncesToGrams);
}

QVariant FactMetaData::_gramsToPunds(const QVariant& g) {
    return QVariant(g.toDouble() / constants.poundsToGrams);
}

919 920 921 922 923
void FactMetaData::setRawUnits(const QString& rawUnits)
{
    _rawUnits = rawUnits;
    _cookedUnits = rawUnits;

924
    setBuiltInTranslator();
925
}
Don Gagne's avatar
Don Gagne committed
926 927 928 929 930

FactMetaData::ValueType_t FactMetaData::stringToType(const QString& typeString, bool& unknownType)
{
    unknownType = false;

DonLakeFlyer's avatar
DonLakeFlyer committed
931 932 933
    for (size_t i=0; i<sizeof(_rgKnownTypeStrings)/sizeof(_rgKnownTypeStrings[0]); i++) {
        if (typeString.compare(_rgKnownTypeStrings[i], Qt::CaseInsensitive) == 0) {
            return _rgKnownValueTypes[i];
Don Gagne's avatar
Don Gagne committed
934 935 936 937 938 939 940
        }
    }

    unknownType = true;

    return valueTypeDouble;
}
941

DonLakeFlyer's avatar
DonLakeFlyer committed
942 943 944 945 946 947 948 949 950 951 952
QString FactMetaData::typeToString(ValueType_t type)
{
    for (size_t i=0; i<sizeof(_rgKnownTypeStrings)/sizeof(_rgKnownTypeStrings[0]); i++) {
        if (type == _rgKnownValueTypes[i]) {
            return _rgKnownTypeStrings[i];
        }
    }

    return QStringLiteral("UnknownType%1").arg(type);
}

953 954 955
size_t FactMetaData::typeToSize(ValueType_t type)
{
    switch (type) {
956 957 958
    case valueTypeUint8:
    case valueTypeInt8:
        return 1;
959

960 961 962
    case valueTypeUint16:
    case valueTypeInt16:
        return 2;
963

964 965 966 967
    case valueTypeUint32:
    case valueTypeInt32:
    case valueTypeFloat:
        return 4;
968

969 970
    case valueTypeUint64:
    case valueTypeInt64:
971 972
    case valueTypeDouble:
        return 8;
973

974 975 976
    case valueTypeCustom:
        return MAVLINK_MSG_PARAM_EXT_SET_FIELD_PARAM_VALUE_LEN;

977 978
    default:
        qWarning() << "Unsupported fact value type" << type;
Don Gagne's avatar
Don Gagne committed
979
        return 0;
980 981
    }
}
982

983 984
/// Set translators according to app settings
void FactMetaData::_setAppSettingsTranslators(void)
985
{
986 987
    // We can only translate between real numbers
    if (!_enumStrings.count() && (type() == valueTypeDouble || type() == valueTypeFloat)) {
988 989
        for (size_t i=0; i<sizeof(_rgAppSettingsTranslations)/sizeof(_rgAppSettingsTranslations[0]); i++) {
            const AppSettingsTranslation_s* pAppSettingsTranslation = &_rgAppSettingsTranslations[i];
990 991 992 993 994 995 996 997 998

            if (_rawUnits.toLower() != pAppSettingsTranslation->rawUnits.toLower()) {
                continue;
            }

            UnitsSettings* settings = qgcApp()->toolbox()->settingsManager()->unitsSettings();
            uint settingsUnits = 0;

            switch (pAppSettingsTranslation->unitType) {
Remek Zajac's avatar
Remek Zajac committed
999 1000
            case UnitHorizontalDistance:
                settingsUnits = settings->horizontalDistanceUnits()->rawValue().toUInt();
1001
                break;
Remek Zajac's avatar
Remek Zajac committed
1002 1003
            case UnitVerticalDistance:
                settingsUnits = settings->verticalDistanceUnits()->rawValue().toUInt();
1004
                break;
1005 1006 1007 1008 1009 1010 1011 1012 1013
            case UnitSpeed:
                settingsUnits = settings->speedUnits()->rawValue().toUInt();
                break;
            case UnitArea:
                settingsUnits = settings->areaUnits()->rawValue().toUInt();
                break;
            case UnitTemperature:
                settingsUnits = settings->temperatureUnits()->rawValue().toUInt();
                break;
1014 1015 1016
            case UnitWeight:
                settingsUnits = settings->weightUnits()->rawValue().toUInt();
                break;
1017 1018 1019 1020 1021
            default:
                break;
            }

            if (settingsUnits == pAppSettingsTranslation->unitOption) {
1022
                _cookedUnits = pAppSettingsTranslation->cookedUnits;
1023 1024 1025 1026 1027 1028
                setTranslators(pAppSettingsTranslation->rawTranslator, pAppSettingsTranslation->cookedTranslator);
                return;
            }
        }
    }
}
1029

1030
const FactMetaData::AppSettingsTranslation_s* FactMetaData::_findAppSettingsUnitsTranslation(const QString& rawUnits, UnitTypes type)
1031 1032 1033
{
    for (size_t i=0; i<sizeof(_rgAppSettingsTranslations)/sizeof(_rgAppSettingsTranslations[0]); i++) {
        const AppSettingsTranslation_s* pAppSettingsTranslation = &_rgAppSettingsTranslations[i];
1034 1035 1036 1037 1038

        if (rawUnits.toLower() != pAppSettingsTranslation->rawUnits.toLower()) {
            continue;
        }

1039 1040
        uint unitOption = 0;
        auto unitsSettings = qgcApp()->toolbox()->settingsManager()->unitsSettings();
1041 1042
        switch (type) {
        case UnitHorizontalDistance:
1043
            unitOption = unitsSettings->horizontalDistanceUnits()->rawValue().toUInt();
1044 1045
            break;
        case UnitVerticalDistance:
1046
            unitOption = unitsSettings->verticalDistanceUnits()->rawValue().toUInt();
1047 1048
            break;
        case UnitArea:
1049
            unitOption = unitsSettings->areaUnits()->rawValue().toUInt();
1050 1051
            break;
        case UnitSpeed:
1052
            unitOption = unitsSettings->speedUnits()->rawValue().toUInt();
1053 1054
            break;
        case UnitTemperature:
1055
            unitOption = unitsSettings->temperatureUnits()->rawValue().toUInt();
1056 1057
            break;
        case UnitWeight:
1058
            unitOption = unitsSettings->weightUnits()->rawValue().toUInt();
1059
            break;
1060 1061
        }

1062
        if (pAppSettingsTranslation->unitType == type
1063
                && pAppSettingsTranslation->unitOption == unitOption) {
1064 1065 1066 1067 1068 1069 1070
            return pAppSettingsTranslation;
        }
    }

    return nullptr;
}

Remek Zajac's avatar
Remek Zajac committed
1071
QVariant FactMetaData::metersToAppSettingsHorizontalDistanceUnits(const QVariant& meters)
1072
{
1073
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m", UnitHorizontalDistance);
1074 1075 1076 1077 1078 1079 1080
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->rawTranslator(meters);
    } else {
        return meters;
    }
}

Remek Zajac's avatar
Remek Zajac committed
1081
QVariant FactMetaData::metersToAppSettingsVerticalDistanceUnits(const QVariant& meters)
1082
{
1083
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("vertical m", UnitVerticalDistance);
1084 1085 1086 1087 1088 1089 1090
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->rawTranslator(meters);
    } else {
        return meters;
    }
}

Remek Zajac's avatar
Remek Zajac committed
1091
QVariant FactMetaData::appSettingsHorizontalDistanceUnitsToMeters(const QVariant& distance)
1092
{
1093
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m", UnitHorizontalDistance);
1094 1095 1096 1097 1098 1099 1100
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedTranslator(distance);
    } else {
        return distance;
    }
}

Remek Zajac's avatar
Remek Zajac committed
1101
QVariant FactMetaData::appSettingsVerticalDistanceUnitsToMeters(const QVariant& distance)
1102
{
1103
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("vertical m", UnitVerticalDistance);
1104 1105 1106 1107 1108 1109 1110
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedTranslator(distance);
    } else {
        return distance;
    }
}

Remek Zajac's avatar
Remek Zajac committed
1111
QString FactMetaData::appSettingsHorizontalDistanceUnitsString(void)
1112
{
1113
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m", UnitHorizontalDistance);
1114 1115 1116 1117 1118 1119
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("m");
    }
}
1120

Remek Zajac's avatar
Remek Zajac committed
1121
QString FactMetaData::appSettingsVerticalDistanceUnitsString(void)
1122
{
1123
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("vertical m", UnitVerticalDistance);
1124 1125 1126 1127 1128 1129 1130 1131 1132
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("m");
    }
}

QString FactMetaData::appSettingsWeightUnitsString(void)
{
1133
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("g", UnitWeight);
1134 1135 1136 1137 1138 1139 1140
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("g");
    }
}

1141 1142
QVariant FactMetaData::squareMetersToAppSettingsAreaUnits(const QVariant& squareMeters)
{
1143
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m^2", UnitArea);
1144 1145 1146 1147 1148 1149 1150 1151 1152
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->rawTranslator(squareMeters);
    } else {
        return squareMeters;
    }
}

QVariant FactMetaData::appSettingsAreaUnitsToSquareMeters(const QVariant& area)
{
1153
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m^2", UnitArea);
1154 1155 1156 1157 1158 1159 1160 1161 1162
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedTranslator(area);
    } else {
        return area;
    }
}

QString FactMetaData::appSettingsAreaUnitsString(void)
{
1163
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m^2", UnitArea);
1164 1165 1166 1167 1168 1169 1170
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("m^2");
    }
}

1171
QVariant FactMetaData::gramsToAppSettingsWeightUnits(const QVariant& grams) {
1172
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("g", UnitWeight);
1173 1174 1175 1176 1177 1178 1179 1180
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->rawTranslator(grams);
    } else {
        return grams;
    }
}

QVariant FactMetaData::appSettingsWeightUnitsToGrams(const QVariant& weight) {
1181
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("g", UnitWeight);
1182 1183 1184 1185 1186 1187 1188
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedTranslator(weight);
    } else {
        return weight;
    }
}

1189 1190
QString FactMetaData::appSettingsSpeedUnitsString()
{
1191
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m/s", UnitSpeed);
1192 1193 1194 1195 1196 1197
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("m/s");
    }
}
1198

1199 1200
double FactMetaData::cookedIncrement(void) const
{
1201
    return _rawTranslator(this->rawIncrement()).toDouble();
1202 1203
}

1204 1205
int FactMetaData::decimalPlaces(void) const
{
1206 1207
    int actualDecimalPlaces = kDefaultDecimalPlaces;
    int incrementDecimalPlaces = kUnknownDecimalPlaces;
1208 1209

    // First determine decimal places from increment
1210
    double increment = _rawTranslator(this->rawIncrement()).toDouble();
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
    if (!qIsNaN(increment)) {
        double integralPart;

        // Get the fractional part only
        increment = fabs(modf(increment, &integralPart));
        if (increment == 0.0) {
            // No fractional part, so no decimal places
            incrementDecimalPlaces = 0;
        } else {
            incrementDecimalPlaces = -ceil(log10(increment));
        }
    }

1224 1225 1226 1227 1228 1229 1230
    if (_decimalPlaces == kUnknownDecimalPlaces) {
        if (incrementDecimalPlaces != kUnknownDecimalPlaces) {
            actualDecimalPlaces = incrementDecimalPlaces;
        } else {
            // Adjust decimal places for cooked translation
            int settingsDecimalPlaces = _decimalPlaces == kUnknownDecimalPlaces ? kDefaultDecimalPlaces : _decimalPlaces;
            double ctest = _rawTranslator(1.0).toDouble();
1231

1232
            settingsDecimalPlaces += -log10(ctest);
1233

1234 1235 1236 1237 1238
            settingsDecimalPlaces = qMin(25, settingsDecimalPlaces);
            settingsDecimalPlaces = qMax(0, settingsDecimalPlaces);
        }
    } else {
        actualDecimalPlaces = _decimalPlaces;
1239 1240 1241 1242
    }

    return actualDecimalPlaces;
}
1243

1244
FactMetaData* FactMetaData::createFromJsonObject(const QJsonObject& json, QMap<QString, QString>& defineMap, QObject* metaDataParent)
1245 1246 1247
{
    QString         errorString;

1248
    QList<JsonHelper::KeyValidateInfo> keyInfoList = {
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
        { _nameJsonKey,                 QJsonValue::String, true },
        { _typeJsonKey,                 QJsonValue::String, true },
        { _shortDescriptionJsonKey,     QJsonValue::String, false },
        { _longDescriptionJsonKey,      QJsonValue::String, false },
        { _unitsJsonKey,                QJsonValue::String, false },
        { _decimalPlacesJsonKey,        QJsonValue::Double, false },
        { _minJsonKey,                  QJsonValue::Double, false },
        { _maxJsonKey,                  QJsonValue::Double, false },
        { _hasControlJsonKey,           QJsonValue::Bool,   false },
        { _qgcRebootRequiredJsonKey,    QJsonValue::Bool,   false },
1259 1260 1261
        { _categoryJsonKey,             QJsonValue::String, false },
        { _groupJsonKey,                QJsonValue::String, false },
        { _volatileJsonKey,             QJsonValue::Bool,   false },
1262 1263 1264 1265
        { _enumBitmaskArrayJsonKey,     QJsonValue::Array,  false },
        { _enumValuesArrayJsonKey,      QJsonValue::Array,  false },
        { _enumValuesJsonKey,           QJsonValue::String, false },
        { _enumStringsJsonKey,          QJsonValue::String, false },
1266 1267
    };
    if (!JsonHelper::validateKeys(json, keyInfoList, errorString)) {
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
        qWarning() << errorString;
        return new FactMetaData(valueTypeUint32, metaDataParent);
    }

    bool unknownType;
    FactMetaData::ValueType_t type = FactMetaData::stringToType(json[_typeJsonKey].toString(), unknownType);
    if (unknownType) {
        qWarning() << "Unknown type" << json[_typeJsonKey].toString();
        return new FactMetaData(valueTypeUint32, metaDataParent);
    }

1279
    FactMetaData* metaData = new FactMetaData(type, metaDataParent);
1280 1281 1282

    metaData->_name = json[_nameJsonKey].toString();

1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
    QStringList     rgDescriptions;
    QList<double>   rgDoubleValues;
    QStringList     rgStringValues;

    bool foundBitmask = false;
    if (!_parseValuesArray(json, rgDescriptions, rgDoubleValues, errorString)) {
        qWarning() << QStringLiteral("FactMetaData::createFromJsonObject _parseValueDescriptionArray for %1 failed. %2").arg(metaData->_name).arg(errorString);
    }
    if (rgDescriptions.isEmpty()) {
        if (!_parseBitmaskArray(json, rgDescriptions, rgDoubleValues, errorString)) {
            qWarning() << QStringLiteral("FactMetaData::createFromJsonObject _parseBitmaskArray for %1 failed. %2").arg(metaData->_name).arg(errorString);
        }
        foundBitmask = rgDescriptions.count() != 0;
    }
    if (rgDescriptions.isEmpty()) {
        if (!_parseEnum(json, defineMap, rgDescriptions, rgStringValues, errorString)) {
            qWarning() << QStringLiteral("FactMetaData::createFromJsonObject _parseEnum for %1 failed. %2").arg(metaData->_name).arg(errorString);
        }
    }

    if (errorString.isEmpty() && rgDescriptions.count()) {
        for (int i=0; i<rgDescriptions.count(); i++) {
            QVariant    rawValueVariant         = rgDoubleValues.count() ? QVariant(rgDoubleValues[i]) : QVariant(rgStringValues[i]);
            QVariant    convertedValueVariant;
1307 1308
            QString     errorString;

1309 1310
            if (foundBitmask) {
                metaData->addBitmaskInfo(rgDescriptions[i], rawValueVariant);
1311
            } else {
1312 1313 1314 1315 1316 1317 1318 1319
                if (metaData->convertAndValidateRaw(rawValueVariant, false /* validate */, convertedValueVariant, errorString)) {
                    metaData->addEnumInfo(rgDescriptions[i], convertedValueVariant);
                } else {
                    qWarning() << QStringLiteral("FactMetaData::createFromJsonObject convertAndValidateRaw on enum value for %1 failed.").arg(metaData->_name)
                               << " type:" << metaData->type()
                               << " value:" << rawValueVariant
                               << " error:" << errorString;
                }
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
            }
        }
    }

    metaData->setDecimalPlaces(json[_decimalPlacesJsonKey].toInt(0));
    metaData->setShortDescription(json[_shortDescriptionJsonKey].toString());
    metaData->setLongDescription(json[_longDescriptionJsonKey].toString());

    if (json.contains(_unitsJsonKey)) {
        metaData->setRawUnits(json[_unitsJsonKey].toString());
    }
1331

1332
    QString defaultValueJsonKey = _defaultValueJsonKey;
1333 1334
#ifdef __mobile__
    if (json.contains(_mobileDefaultValueJsonKey)) {
Don Gagne's avatar
Don Gagne committed
1335
        defaultValueJsonKey = _mobileDefaultValueJsonKey;
1336
    }
1337
#endif
1338 1339 1340 1341 1342 1343

    if (json.contains(defaultValueJsonKey)) {
        const QJsonValue jsonValue = json[defaultValueJsonKey];

        if (jsonValue.type() == QJsonValue::Null && (type == valueTypeFloat || type == valueTypeDouble)) {
            metaData->setRawDefaultValue(type == valueTypeFloat ? std::numeric_limits<float>::quiet_NaN() : std::numeric_limits<double>::quiet_NaN());
1344
        } else {
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
            QVariant typedValue;
            QString errorString;
            QVariant initialValue = jsonValue.toVariant();

            if (metaData->convertAndValidateRaw(initialValue, true /* convertOnly */, typedValue, errorString)) {
                metaData->setRawDefaultValue(typedValue);
            } else {
                qWarning() << "Invalid default value, name:" << metaData->name()
                           << " type:" << metaData->type()
                           << " value:" << initialValue
                           << " error:" << errorString;
            }
1357 1358 1359
        }
    }

1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
    if (json.contains(_incrementJsonKey)) {
        QVariant typedValue;
        QString errorString;
        QVariant initialValue = json[_incrementJsonKey].toVariant();
        if (metaData->convertAndValidateRaw(initialValue, true /* convertOnly */, typedValue, errorString)) {
            metaData->setRawIncrement(typedValue.toDouble());
        } else {
            qWarning() << "Invalid increment value, name:" << metaData->name()
                       << " type:" << metaData->type()
                       << " value:" << initialValue
                       << " error:" << errorString;
        }
    }

1374
    if (json.contains(_minJsonKey)) {
1375 1376
        QVariant typedValue;
        QString errorString;
1377 1378 1379 1380 1381 1382 1383 1384 1385
        QVariant initialValue = json[_minJsonKey].toVariant();
        if (metaData->convertAndValidateRaw(initialValue, true /* convertOnly */, typedValue, errorString)) {
            metaData->setRawMin(typedValue);
        } else {
            qWarning() << "Invalid min value, name:" << metaData->name()
                       << " type:" << metaData->type()
                       << " value:" << initialValue
                       << " error:" << errorString;
        }
1386
    }
1387

1388
    if (json.contains(_maxJsonKey)) {
1389 1390
        QVariant typedValue;
        QString errorString;
1391 1392 1393 1394 1395 1396 1397 1398 1399
        QVariant initialValue = json[_maxJsonKey].toVariant();
        if (metaData->convertAndValidateRaw(initialValue, true /* convertOnly */, typedValue, errorString)) {
            metaData->setRawMax(typedValue);
        } else {
            qWarning() << "Invalid max value, name:" << metaData->name()
                       << " type:" << metaData->type()
                       << " value:" << initialValue
                       << " error:" << errorString;
        }
1400
    }
1401

1402
    bool hasControlJsonKey = true;
1403
    if (json.contains(_hasControlJsonKey)) {
1404
        hasControlJsonKey = json[_hasControlJsonKey].toBool();
1405
    }
1406
    metaData->setHasControl(hasControlJsonKey);
1407

1408
    bool qgcRebootRequired = false;
1409
    if (json.contains(_qgcRebootRequiredJsonKey)) {
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
        qgcRebootRequired = json[_qgcRebootRequiredJsonKey].toBool();
    }
    metaData->setQGCRebootRequired(qgcRebootRequired);

    bool volatileValue = false;
    if (json.contains(_volatileJsonKey)) {
        volatileValue = json[_volatileJsonKey].toBool();
    }
    metaData->setVolatileValue(volatileValue);

    if (json.contains(_groupJsonKey)) {
        metaData->setGroup(json[_groupJsonKey].toString());
    }

    if (json.contains(_categoryJsonKey)) {
        metaData->setCategory(json[_categoryJsonKey].toString());
1426 1427
    }

1428 1429 1430
    return metaData;
}

1431 1432 1433 1434 1435 1436 1437 1438
void FactMetaData::_loadJsonDefines(const QJsonObject& jsonDefinesObject, QMap<QString, QString>& defineMap)
{
    for (const QString& defineName: jsonDefinesObject.keys()) {
        QString mapKey = _jsonMetaDataDefinesName + QString(".") + defineName;
        defineMap[mapKey] = jsonDefinesObject[defineName].toString();
    }
}

1439 1440 1441 1442
QMap<QString, FactMetaData*> FactMetaData::createMapFromJsonFile(const QString& jsonFilename, QObject* metaDataParent)
{
    QMap<QString, FactMetaData*> metaDataMap;

1443 1444 1445 1446 1447
    QString errorString;
    int version;
    QJsonObject jsonObject = JsonHelper::openInternalQGCJsonFile(jsonFilename, qgcFileType, 1, 1, version, errorString);
    if (!errorString.isEmpty()) {
        qWarning() << "Internal Error: " << errorString;
1448 1449 1450
        return metaDataMap;
    }

1451 1452 1453
    QJsonArray factArray;
    QMap<QString /* define name */, QString /* define value */> defineMap;

1454 1455 1456 1457 1458 1459
    QList<JsonHelper::KeyValidateInfo> keyInfoList = {
        { FactMetaData::_jsonMetaDataDefinesName,   QJsonValue::Object, false },
        { FactMetaData::_jsonMetaDataFactsName,     QJsonValue::Array,  true },
    };
    if (!JsonHelper::validateKeys(jsonObject, keyInfoList, errorString)) {
        qWarning() << "Json document incorrect format:" << errorString;
1460 1461 1462
        return metaDataMap;
    }

1463 1464 1465
    _loadJsonDefines(jsonObject[FactMetaData::_jsonMetaDataDefinesName].toObject(), defineMap);
    factArray = jsonObject[FactMetaData::_jsonMetaDataFactsName].toArray();

1466
    return createMapFromJsonArray(factArray, defineMap, metaDataParent);
1467
}
1468

1469
QMap<QString, FactMetaData*> FactMetaData::createMapFromJsonArray(const QJsonArray jsonArray, QMap<QString, QString>& defineMap, QObject* metaDataParent)
1470 1471 1472 1473
{
    QMap<QString, FactMetaData*> metaDataMap;
    for (int i=0; i<jsonArray.count(); i++) {
        QJsonValue jsonValue = jsonArray.at(i);
1474 1475 1476 1477 1478
        if (!jsonValue.isObject()) {
            qWarning() << QStringLiteral("JsonValue at index %1 not an object").arg(i);
            continue;
        }
        QJsonObject jsonObject = jsonValue.toObject();
1479
        FactMetaData* metaData = createFromJsonObject(jsonObject, defineMap, metaDataParent);
1480 1481
        if (metaDataMap.contains(metaData->name())) {
            qWarning() << QStringLiteral("Duplicate fact name:") << metaData->name();
1482
            delete metaData;
1483 1484 1485 1486 1487 1488
        } else {
            metaDataMap[metaData->name()] = metaData;
        }
    }
    return metaDataMap;
}
1489 1490 1491 1492

QVariant FactMetaData::cookedMax(void) const
{
    // We have to be careful with cooked min/max. Running the raw values through the translator could flip min and max.
DonLakeFlyer's avatar
DonLakeFlyer committed
1493
    return qMax(_rawTranslator(_rawMax).toDouble(), _rawTranslator(_rawMin).toDouble());
1494 1495 1496 1497 1498
}

QVariant FactMetaData::cookedMin(void) const
{
    // We have to be careful with cooked min/max. Running the raw values through the translator could flip min and max.
DonLakeFlyer's avatar
DonLakeFlyer committed
1499
    return qMin(_rawTranslator(_rawMax).toDouble(), _rawTranslator(_rawMin).toDouble());
1500
}
1501 1502 1503 1504 1505 1506 1507 1508

void FactMetaData::setVolatileValue(bool bValue)
{
    _volatile = bValue;
    if (_volatile) {
        _readOnly = true;
    }
}
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610

bool FactMetaData::_parseEnum(const QJsonObject& jsonObject, DefineMap_t defineMap, QStringList& rgDescriptions, QStringList& rgValues, QString& errorString)
{
    rgDescriptions.clear();
    rgValues.clear();
    errorString.clear();

    if (!jsonObject.contains(_enumStringsJsonKey)) {
        return true;
    }

    QString strings = jsonObject.value(_enumStringsJsonKey).toString();
#if QT_VERSION < QT_VERSION_CHECK(5, 15, 0)
    rgDescriptions = defineMap.value(strings, strings).split(",", QString::SkipEmptyParts);
#else
    rgDescriptions = defineMap.value(strings, strings).split(",", Qt::SkipEmptyParts);
#endif

    QString values = jsonObject.value(_enumValuesJsonKey).toString();
#if QT_VERSION < QT_VERSION_CHECK(5, 15, 0)
    rgValues = defineMap.value(values, values).split(",", QString::SkipEmptyParts);
#else
    rgValues = defineMap.value(values, values).split(",", Qt::SkipEmptyParts);
#endif

    if (rgDescriptions.count() != rgValues.count()) {
        errorString = QStringLiteral("Enum strings/values count mismatch - strings:values %1:%2").arg(rgDescriptions.count()).arg(rgValues.count());
        return false;
    }

    return true;
}

bool FactMetaData::_parseValuesArray(const QJsonObject& jsonObject, QStringList& rgDescriptions, QList<double>& rgValues, QString& errorString)
{
    rgDescriptions.clear();
    rgValues.clear();
    errorString.clear();

    if (!jsonObject.contains(_enumValuesArrayJsonKey)) {
        return true;
    }

    QList<JsonHelper::KeyValidateInfo> keyInfoList = {
        { _enumValuesArrayDescriptionJsonKey,   QJsonValue::String, true },
        { _enumValuesArrayValueJsonKey,         QJsonValue::Double, true },
    };

    const QJsonArray& rgValueDescription = jsonObject[_enumValuesArrayJsonKey].toArray();
    for (int i=0; i<rgValueDescription.count(); i++) {
        if (rgValueDescription[i].type() != QJsonValue::Object) {
            errorString = QStringLiteral("Value at index %1 in \"values\" array is not an object.").arg(i);
            return false;
        }

        const QJsonObject& valueDescriptionObject = rgValueDescription[i].toObject();
        if (!JsonHelper::validateKeys(valueDescriptionObject, keyInfoList, errorString)) {
            errorString = QStringLiteral("Object at index %1 in \"values\" array failed validation '%2'.").arg(i).arg(errorString);
            return false;
        }

        rgDescriptions.append(valueDescriptionObject[_enumValuesArrayDescriptionJsonKey].toString());
        rgValues.append(valueDescriptionObject[_enumValuesArrayValueJsonKey].toDouble());
    }

    return true;
}

bool FactMetaData::_parseBitmaskArray(const QJsonObject& jsonObject, QStringList& rgDescriptions, QList<double>& rgValues, QString& errorString)
{
    rgDescriptions.clear();
    rgValues.clear();
    errorString.clear();

    if (!jsonObject.contains(_enumBitmaskArrayJsonKey)) {
        return true;
    }

    QList<JsonHelper::KeyValidateInfo> keyInfoList = {
        { _enumBitmaskArrayDescriptionJsonKey,   QJsonValue::String, true },
        { _enumBitmaskArrayIndexJsonKey,         QJsonValue::Double, true },
    };

    const QJsonArray& rgValueDescription = jsonObject[_enumBitmaskArrayJsonKey].toArray();
    for (int i=0; i<rgValueDescription.count(); i++) {
        if (rgValueDescription[i].type() != QJsonValue::Object) {
            errorString = QStringLiteral("Value at index %1 in \"values\" array is not an object.").arg(i);
            return false;
        }

        const QJsonObject& valueDescriptionObject = rgValueDescription[i].toObject();
        if (!JsonHelper::validateKeys(valueDescriptionObject, keyInfoList, errorString)) {
            errorString = QStringLiteral("Object at index %1 in \"values\" array failed validation '%2'.").arg(i).arg(errorString);
            return false;
        }

        rgDescriptions.append(valueDescriptionObject[_enumBitmaskArrayDescriptionJsonKey].toString());
        rgValues.append(valueDescriptionObject[_enumBitmaskArrayIndexJsonKey].toDouble());
    }

    return true;
}