FactMetaData.cc 55.2 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 36 37 38 39
//Weight
const qreal FactMetaData::UnitConsts_s::ouncesToGrams =         28.3495;
const qreal FactMetaData::UnitConsts_s::poundsToGrams =         453.592;


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

43
const char* FactMetaData::qgcFileType =                 "FactMetaData";
44 45 46
const char* FactMetaData::_jsonMetaDataDefinesName =    "QGC.MetaData.Defines";
const char* FactMetaData::_jsonMetaDataFactsName =      "QGC.MetaData.Facts";

47 48
// Built in translations for all Facts
const FactMetaData::BuiltInTranslation_s FactMetaData::_rgBuiltInTranslations[] = {
49 50 51 52
    { "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 },
53
};
Don Gagne's avatar
Don Gagne committed
54

55 56
// Translations driven by app settings
const FactMetaData::AppSettingsTranslation_s FactMetaData::_rgAppSettingsTranslations[] = {
Remek Zajac's avatar
Remek Zajac committed
57 58 59 60 61 62 63 64 65 66 67 68
    { "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 },
    { "m^2",    "m\u00B2",  FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsSquareMeters,         FactMetaData::_defaultTranslator,                   FactMetaData::_defaultTranslator },
    { "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
69
    { "vertical m",  "ft",  FactMetaData::UnitVerticalDistance,      UnitsSettings::VerticalDistanceUnitsFeet,     FactMetaData::_metersToFeet,                        FactMetaData::_feetToMeters },
Remek Zajac's avatar
Remek Zajac committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
    { "cm/px",  "in/px",    FactMetaData::UnitHorizontalDistance,    UnitsSettings::HorizontalDistanceUnitsFeet,   FactMetaData::_centimetersToInches,                 FactMetaData::_inchesToCentimeters },
    { "m^2",    "km\u00B2", FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsSquareKilometers,     FactMetaData::_squareMetersToSquareKilometers,      FactMetaData::_squareKilometersToSquareMeters },
    { "m^2",    "ha",       FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsHectares,             FactMetaData::_squareMetersToHectares,              FactMetaData::_hectaresToSquareMeters },
    { "m^2",    "ft\u00B2", FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsSquareFeet,           FactMetaData::_squareMetersToSquareFeet,            FactMetaData::_squareFeetToSquareMeters },
    { "m^2",    "ac",       FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsAcres,                FactMetaData::_squareMetersToAcres,                 FactMetaData::_acresToSquareMeters },
    { "m^2",    "mi\u00B2", FactMetaData::UnitArea,                  UnitsSettings::AreaUnitsSquareMiles,          FactMetaData::_squareMetersToSquareMiles,           FactMetaData::_squareMilesToSquareMeters },
    { "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 },
85 86
};

87 88 89 90 91 92 93
const char* FactMetaData::_decimalPlacesJsonKey =       "decimalPlaces";
const char* FactMetaData::_nameJsonKey =                "name";
const char* FactMetaData::_typeJsonKey =                "type";
const char* FactMetaData::_shortDescriptionJsonKey =    "shortDescription";
const char* FactMetaData::_longDescriptionJsonKey =     "longDescription";
const char* FactMetaData::_unitsJsonKey =               "units";
const char* FactMetaData::_defaultValueJsonKey =        "defaultValue";
94
const char* FactMetaData::_mobileDefaultValueJsonKey =  "mobileDefaultValue";
95 96
const char* FactMetaData::_minJsonKey =                 "min";
const char* FactMetaData::_maxJsonKey =                 "max";
97
const char* FactMetaData::_incrementJsonKey =           "increment";
98
const char* FactMetaData::_hasControlJsonKey =          "control";
99
const char* FactMetaData::_qgcRebootRequiredJsonKey =   "qgcRebootRequired";
100

101
FactMetaData::FactMetaData(QObject* parent)
102 103
    : QObject               (parent)
    , _type                 (valueTypeInt32)
104
    , _decimalPlaces        (kUnknownDecimalPlaces)
105
    , _rawDefaultValue      (0)
106
    , _defaultValueAvailable(false)
107 108 109 110 111 112
    , _rawMax               (_maxForType())
    , _maxIsDefaultForType  (true)
    , _rawMin               (_minForType())
    , _minIsDefaultForType  (true)
    , _rawTranslator        (_defaultTranslator)
    , _cookedTranslator     (_defaultTranslator)
113 114
    , _vehicleRebootRequired(false)
    , _qgcRebootRequired    (false)
115
    , _rawIncrement         (std::numeric_limits<double>::quiet_NaN())
116 117
    , _hasControl           (true)
    , _readOnly             (false)
118
    , _writeOnly            (false)
119
    , _volatile             (false)
Don Gagne's avatar
Don Gagne committed
120
{
121 122
    _category   = kDefaultCategory;
    _group      = kDefaultGroup;
Don Gagne's avatar
Don Gagne committed
123 124
}

125
FactMetaData::FactMetaData(ValueType_t type, QObject* parent)
126 127
    : QObject               (parent)
    , _type                 (type)
128
    , _decimalPlaces        (kUnknownDecimalPlaces)
129
    , _rawDefaultValue      (0)
130
    , _defaultValueAvailable(false)
131 132 133 134 135 136
    , _rawMax               (_maxForType())
    , _maxIsDefaultForType  (true)
    , _rawMin               (_minForType())
    , _minIsDefaultForType  (true)
    , _rawTranslator        (_defaultTranslator)
    , _cookedTranslator     (_defaultTranslator)
137 138
    , _vehicleRebootRequired(false)
    , _qgcRebootRequired    (false)
139
    , _rawIncrement         (std::numeric_limits<double>::quiet_NaN())
140 141
    , _hasControl           (true)
    , _readOnly             (false)
142
    , _writeOnly            (false)
143
    , _volatile             (false)
144
{
145 146
    _category   = kDefaultCategory;
    _group      = kDefaultGroup;
147 148
}

Don Gagne's avatar
Don Gagne committed
149 150 151 152 153 154
FactMetaData::FactMetaData(const FactMetaData& other, QObject* parent)
    : QObject(parent)
{
    *this = other;
}

155
FactMetaData::FactMetaData(ValueType_t type, const QString name, QObject* parent)
156 157
    : QObject               (parent)
    , _type                 (type)
158
    , _decimalPlaces        (kUnknownDecimalPlaces)
159
    , _rawDefaultValue      (0)
160
    , _defaultValueAvailable(false)
161 162 163 164 165 166 167
    , _rawMax               (_maxForType())
    , _maxIsDefaultForType  (true)
    , _rawMin               (_minForType())
    , _minIsDefaultForType  (true)
    , _name                 (name)
    , _rawTranslator        (_defaultTranslator)
    , _cookedTranslator     (_defaultTranslator)
168 169
    , _vehicleRebootRequired(false)
    , _qgcRebootRequired    (false)
170
    , _rawIncrement         (std::numeric_limits<double>::quiet_NaN())
171 172
    , _hasControl           (true)
    , _readOnly             (false)
173
    , _writeOnly            (false)
174
    , _volatile             (false)
175
{
176 177
    _category   = kDefaultCategory;
    _group      = kDefaultGroup;
178 179
}

Don Gagne's avatar
Don Gagne committed
180 181
const FactMetaData& FactMetaData::operator=(const FactMetaData& other)
{
182
    _decimalPlaces          = other._decimalPlaces;
183
    _rawDefaultValue        = other._rawDefaultValue;
Don Gagne's avatar
Don Gagne committed
184
    _defaultValueAvailable  = other._defaultValueAvailable;
185 186
    _bitmaskStrings         = other._bitmaskStrings;
    _bitmaskValues          = other._bitmaskValues;
187 188
    _enumStrings            = other._enumStrings;
    _enumValues             = other._enumValues;
189
    _category               = other._category;
190 191
    _group                  = other._group;
    _longDescription        = other._longDescription;
192
    _rawMax                 = other._rawMax;
Don Gagne's avatar
Don Gagne committed
193
    _maxIsDefaultForType    = other._maxIsDefaultForType;
194
    _rawMin                 = other._rawMin;
195 196 197 198
    _minIsDefaultForType    = other._minIsDefaultForType;
    _name                   = other._name;
    _shortDescription       = other._shortDescription;
    _type                   = other._type;
199 200
    _rawUnits               = other._rawUnits;
    _cookedUnits            = other._cookedUnits;
201 202
    _rawTranslator          = other._rawTranslator;
    _cookedTranslator       = other._cookedTranslator;
203 204
    _vehicleRebootRequired  = other._vehicleRebootRequired;
    _qgcRebootRequired      = other._qgcRebootRequired;
205
    _rawIncrement           = other._rawIncrement;
206
    _hasControl             = other._hasControl;
207
    _readOnly               = other._readOnly;
208
    _writeOnly              = other._writeOnly;
209
    _volatile               = other._volatile;
Don Gagne's avatar
Don Gagne committed
210 211 212
    return *this;
}

213 214 215 216 217 218 219 220 221 222
const QString FactMetaData::defaultCategory()
{
    return QString(kDefaultCategory);
}

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

223
QVariant FactMetaData::rawDefaultValue(void) const
224 225
{
    if (_defaultValueAvailable) {
226
        return _rawDefaultValue;
227 228 229 230 231 232
    } else {
        qWarning() << "Attempt to access unavailable default value";
        return QVariant(0);
    }
}

233
void FactMetaData::setRawDefaultValue(const QVariant& rawDefaultValue)
234
{
235
    if (_type == valueTypeString || (isInRawMinLimit(rawDefaultValue) && isInRawMaxLimit(rawDefaultValue))) {
236
        _rawDefaultValue = rawDefaultValue;
237 238 239 240 241 242
        _defaultValueAvailable = true;
    } else {
        qWarning() << "Attempt to set default value which is outside min/max range";
    }
}

243
void FactMetaData::setRawMin(const QVariant& rawMin)
244
{
245
    if (isInRawMinLimit(rawMin)) {
246
        _rawMin = rawMin;
Don Gagne's avatar
Don Gagne committed
247
        _minIsDefaultForType = false;
248
    } else {
249
        qWarning() << "Attempt to set min below allowable value for fact: " << name()
250
                   << ", value attempted: " << rawMin
251
                   << ", type: " << type() << ", min for type: " << _minForType();
252
        _rawMin = _minForType();
253 254 255
    }
}

256
void FactMetaData::setRawMax(const QVariant& rawMax)
257
{
258
    if (isInRawMaxLimit(rawMax)) {
259
        _rawMax = rawMax;
Don Gagne's avatar
Don Gagne committed
260
        _maxIsDefaultForType = false;
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
    } 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:
        return _rawMin.value<float>() <= variantValue.value<float>();
    case valueTypeDouble:
        return _rawMin.value<double>() <= variantValue.value<double>();
    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:
        return _rawMax.value<float>() >= variantValue.value<float>();
    case valueTypeDouble:
        return _rawMax.value<double>() >= variantValue.value<double>();
    default:
        return true;
322
    }
323 324

    return true;
325 326
}

327
QVariant FactMetaData::_minForType(void) const
Don Gagne's avatar
Don Gagne committed
328
{
329
    switch (_type) {
330 331 332 333 334 335 336 337 338
    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:
339
        return QVariant(std::numeric_limits<uint32_t>::min());
340
    case valueTypeInt32:
341 342
        return QVariant(std::numeric_limits<int32_t>::min());
    case valueTypeUint64:
343
        return QVariant((qulonglong)std::numeric_limits<uint64_t>::min());
344
    case valueTypeInt64:
345
        return QVariant((qlonglong)std::numeric_limits<int64_t>::min());
346 347 348 349
    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
350 351
    case valueTypeString:
        return QVariant();
352 353
    case valueTypeBool:
        return QVariant(0);
354 355
    case valueTypeElapsedTimeInSeconds:
        return QVariant(0.0);
356 357
    case valueTypeCustom:
        return QVariant();
358
    }
359

Don Gagne's avatar
Don Gagne committed
360 361
    // Make windows compiler happy, even switch is full cased
    return QVariant();
Don Gagne's avatar
Don Gagne committed
362
}
Don Gagne's avatar
Don Gagne committed
363

364
QVariant FactMetaData::_maxForType(void) const
Don Gagne's avatar
Don Gagne committed
365
{
366
    switch (_type) {
367 368 369 370 371 372 373 374 375
    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:
376
        return QVariant(std::numeric_limits<uint32_t>::max());
377
    case valueTypeInt32:
378 379
        return QVariant(std::numeric_limits<int32_t>::max());
    case valueTypeUint64:
380
        return QVariant((qulonglong)std::numeric_limits<uint64_t>::max());
381
    case valueTypeInt64:
382
        return QVariant((qlonglong)std::numeric_limits<int64_t>::max());
383 384
    case valueTypeFloat:
        return QVariant(std::numeric_limits<float>::max());
385
    case valueTypeElapsedTimeInSeconds:
386 387
    case valueTypeDouble:
        return QVariant(std::numeric_limits<double>::max());
Don Gagne's avatar
Don Gagne committed
388 389
    case valueTypeString:
        return QVariant();
390 391
    case valueTypeBool:
        return QVariant(1);
392 393
    case valueTypeCustom:
        return QVariant();
394
    }
395

Don Gagne's avatar
Don Gagne committed
396 397
    // Make windows compiler happy, even switch is full cased
    return QVariant();
Don Gagne's avatar
Don Gagne committed
398
}
Don Gagne's avatar
Don Gagne committed
399

400
bool FactMetaData::convertAndValidateRaw(const QVariant& rawValue, bool convertOnly, QVariant& typedValue, QString& errorString)
Don Gagne's avatar
Don Gagne committed
401
{
402
    bool convertOk = false;
403

Don Gagne's avatar
Don Gagne committed
404
    errorString.clear();
405

Don Gagne's avatar
Don Gagne committed
406
    switch (type()) {
407 408 409 410 411
    case FactMetaData::valueTypeInt8:
    case FactMetaData::valueTypeInt16:
    case FactMetaData::valueTypeInt32:
        typedValue = QVariant(rawValue.toInt(&convertOk));
        if (!convertOnly && convertOk) {
412
            if (!isInRawLimit<int32_t>(typedValue)) {
413
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toInt()).arg(rawMax().toInt());
Don Gagne's avatar
Don Gagne committed
414
            }
415 416
        }
        break;
417 418 419
    case FactMetaData::valueTypeInt64:
        typedValue = QVariant(rawValue.toLongLong(&convertOk));
        if (!convertOnly && convertOk) {
420
            if (!isInRawLimit<int64_t>(typedValue)) {
421 422 423 424
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toInt()).arg(rawMax().toInt());
            }
        }
        break;
425 426 427 428 429
    case FactMetaData::valueTypeUint8:
    case FactMetaData::valueTypeUint16:
    case FactMetaData::valueTypeUint32:
        typedValue = QVariant(rawValue.toUInt(&convertOk));
        if (!convertOnly && convertOk) {
430
            if (!isInRawLimit<uint32_t>(typedValue)) {
431
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toUInt()).arg(rawMax().toUInt());
Don Gagne's avatar
Don Gagne committed
432
            }
433 434
        }
        break;
435 436 437
    case FactMetaData::valueTypeUint64:
        typedValue = QVariant(rawValue.toULongLong(&convertOk));
        if (!convertOnly && convertOk) {
438
            if (!isInRawLimit<uint64_t>(typedValue)) {
439 440 441 442
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toUInt()).arg(rawMax().toUInt());
            }
        }
        break;
443 444 445
    case FactMetaData::valueTypeFloat:
        typedValue = QVariant(rawValue.toFloat(&convertOk));
        if (!convertOnly && convertOk) {
446
            if (!isInRawLimit<float>(typedValue)) {
447
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toDouble()).arg(rawMax().toDouble());
Don Gagne's avatar
Don Gagne committed
448
            }
449 450
        }
        break;
451
    case FactMetaData::valueTypeElapsedTimeInSeconds:
452 453 454
    case FactMetaData::valueTypeDouble:
        typedValue = QVariant(rawValue.toDouble(&convertOk));
        if (!convertOnly && convertOk) {
455
            if (!isInRawLimit<double>(typedValue)) {
456
                errorString = tr("Value must be within %1 and %2").arg(rawMin().toDouble()).arg(rawMax().toDouble());
Don Gagne's avatar
Don Gagne committed
457
            }
458 459
        }
        break;
Don Gagne's avatar
Don Gagne committed
460 461 462 463
    case FactMetaData::valueTypeString:
        convertOk = true;
        typedValue = QVariant(rawValue.toString());
        break;
464 465 466 467
    case FactMetaData::valueTypeBool:
        convertOk = true;
        typedValue = QVariant(rawValue.toBool());
        break;
468 469 470 471
    case FactMetaData::valueTypeCustom:
        convertOk = true;
        typedValue = QVariant(rawValue.toByteArray());
        break;
Don Gagne's avatar
Don Gagne committed
472
    }
473

Don Gagne's avatar
Don Gagne committed
474
    if (!convertOk) {
475
        errorString += tr("Invalid number");
Don Gagne's avatar
Don Gagne committed
476
    }
477

Don Gagne's avatar
Don Gagne committed
478 479
    return convertOk && errorString.isEmpty();
}
480

481 482 483 484 485 486
bool FactMetaData::convertAndValidateCooked(const QVariant& cookedValue, bool convertOnly, QVariant& typedValue, QString& errorString)
{
    bool convertOk = false;

    errorString.clear();

487 488 489 490 491 492 493
    if (!convertOnly && _customCookedValidator) {
        errorString = _customCookedValidator(cookedValue);
        if (!errorString.isEmpty()) {
            return false;
        }
    }

494
    switch (type()) {
495 496 497 498 499
    case FactMetaData::valueTypeInt8:
    case FactMetaData::valueTypeInt16:
    case FactMetaData::valueTypeInt32:
        typedValue = QVariant(cookedValue.toInt(&convertOk));
        if (!convertOnly && convertOk) {
500
            if (!isInCookedLimit<int32_t>(typedValue)) {
501
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toInt()).arg(cookedMax().toInt());
502
            }
503 504
        }
        break;
505 506 507
    case FactMetaData::valueTypeInt64:
        typedValue = QVariant(cookedValue.toLongLong(&convertOk));
        if (!convertOnly && convertOk) {
508
            if (!isInCookedLimit<int64_t>(typedValue)) {
509 510 511 512
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toInt()).arg(cookedMax().toInt());
            }
        }
        break;
513 514 515 516 517
    case FactMetaData::valueTypeUint8:
    case FactMetaData::valueTypeUint16:
    case FactMetaData::valueTypeUint32:
        typedValue = QVariant(cookedValue.toUInt(&convertOk));
        if (!convertOnly && convertOk) {
518
            if (!isInCookedLimit<uint32_t>(typedValue)) {
519
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toUInt()).arg(cookedMax().toUInt());
520
            }
521 522
        }
        break;
523 524 525
    case FactMetaData::valueTypeUint64:
        typedValue = QVariant(cookedValue.toULongLong(&convertOk));
        if (!convertOnly && convertOk) {
526
            if (!isInCookedLimit<uint64_t>(typedValue)) {
527 528 529 530
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toUInt()).arg(cookedMax().toUInt());
            }
        }
        break;
531 532 533
    case FactMetaData::valueTypeFloat:
        typedValue = QVariant(cookedValue.toFloat(&convertOk));
        if (!convertOnly && convertOk) {
534
            if (!isInCookedLimit<float>(typedValue)) {
535
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toFloat()).arg(cookedMax().toFloat());
536
            }
537 538
        }
        break;
539
    case FactMetaData::valueTypeElapsedTimeInSeconds:
540 541 542
    case FactMetaData::valueTypeDouble:
        typedValue = QVariant(cookedValue.toDouble(&convertOk));
        if (!convertOnly && convertOk) {
543
            if (!isInCookedLimit<double>(typedValue)) {
544
                errorString = tr("Value must be within %1 and %2").arg(cookedMin().toDouble()).arg(cookedMax().toDouble());
545
            }
546 547
        }
        break;
Don Gagne's avatar
Don Gagne committed
548 549 550 551
    case FactMetaData::valueTypeString:
        convertOk = true;
        typedValue = QVariant(cookedValue.toString());
        break;
552 553 554 555
    case FactMetaData::valueTypeBool:
        convertOk = true;
        typedValue = QVariant(cookedValue.toBool());
        break;
556 557 558 559
    case FactMetaData::valueTypeCustom:
        convertOk = true;
        typedValue = QVariant(cookedValue.toByteArray());
        break;
560 561 562
    }

    if (!convertOk) {
563
        errorString += tr("Invalid number");
564 565 566 567 568
    }

    return convertOk && errorString.isEmpty();
}

569 570 571 572 573 574 575 576 577
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) {
578
            clamp<int32_t>(typedValue);
579 580
        }
        break;
581 582 583
    case FactMetaData::valueTypeInt64:
        typedValue = QVariant(cookedValue.toLongLong(&convertOk));
        if (convertOk) {
584
            clamp<int64_t>(typedValue);
585 586
        }
        break;
587 588 589 590 591
    case FactMetaData::valueTypeUint8:
    case FactMetaData::valueTypeUint16:
    case FactMetaData::valueTypeUint32:
        typedValue = QVariant(cookedValue.toUInt(&convertOk));
        if (convertOk) {
592
            clamp<uint32_t>(typedValue);
593 594
        }
        break;
595 596 597
    case FactMetaData::valueTypeUint64:
        typedValue = QVariant(cookedValue.toULongLong(&convertOk));
        if (convertOk) {
598
            clamp<uint64_t>(typedValue);
599 600
        }
        break;
601 602 603
    case FactMetaData::valueTypeFloat:
        typedValue = QVariant(cookedValue.toFloat(&convertOk));
        if (convertOk) {
604
            clamp<float>(typedValue);
605 606 607 608 609 610
        }
        break;
    case FactMetaData::valueTypeElapsedTimeInSeconds:
    case FactMetaData::valueTypeDouble:
        typedValue = QVariant(cookedValue.toDouble(&convertOk));
        if (convertOk) {
611
            clamp<double>(typedValue);
612 613 614 615 616 617 618 619 620 621
        }
        break;
    case FactMetaData::valueTypeString:
        convertOk = true;
        typedValue = QVariant(cookedValue.toString());
        break;
    case FactMetaData::valueTypeBool:
        convertOk = true;
        typedValue = QVariant(cookedValue.toBool());
        break;
622 623 624 625
    case FactMetaData::valueTypeCustom:
        convertOk = true;
        typedValue = QVariant(cookedValue.toByteArray());
        break;
626 627 628 629
    }
    return convertOk;
}

630 631 632 633 634 635 636 637 638
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;
639
    setBuiltInTranslator();
640 641 642 643 644 645 646 647
}

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

648 649 650 651 652 653 654 655 656
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;
657
    setBuiltInTranslator();
658 659
}

660 661 662 663 664 665
void FactMetaData::addEnumInfo(const QString& name, const QVariant& value)
{
    _enumStrings << name;
    _enumValues << value;
}

666 667 668 669 670
void FactMetaData::setTranslators(Translator rawTranslator, Translator cookedTranslator)
{
    _rawTranslator = rawTranslator;
    _cookedTranslator = cookedTranslator;
}
671

672
void FactMetaData::setBuiltInTranslator(void)
673 674 675 676 677
{
    if (_enumStrings.count()) {
        // No translation if enum
        setTranslators(_defaultTranslator, _defaultTranslator);
        _cookedUnits = _rawUnits;
678
        return;
679
    } else {
680 681
        for (size_t i=0; i<sizeof(_rgBuiltInTranslations)/sizeof(_rgBuiltInTranslations[0]); i++) {
            const BuiltInTranslation_s* pBuiltInTranslation = &_rgBuiltInTranslations[i];
682

683
            if (pBuiltInTranslation->rawUnits.toLower() == _rawUnits.toLower()) {
684 685
                _cookedUnits = pBuiltInTranslation->cookedUnits;
                setTranslators(pBuiltInTranslation->rawTranslator, pBuiltInTranslation->cookedTranslator);
686
                return;
687 688 689
            }
        }
    }
690 691 692

    // Translator not yet set, try app settings translators
    _setAppSettingsTranslators();
693 694 695 696
}

QVariant FactMetaData::_degreesToRadians(const QVariant& degrees)
{
697
    return QVariant(qDegreesToRadians(degrees.toDouble()));
698 699 700 701
}

QVariant FactMetaData::_radiansToDegrees(const QVariant& radians)
{
702
    return QVariant(qRadiansToDegrees(radians.toDouble()));
703 704 705 706
}

QVariant FactMetaData::_centiDegreesToDegrees(const QVariant& centiDegrees)
{
707
    return QVariant(centiDegrees.toReal() / 100.0);
708 709 710 711
}

QVariant FactMetaData::_degreesToCentiDegrees(const QVariant& degrees)
{
712
    return QVariant(qRound(degrees.toReal() * 100.0));
713 714
}

715 716 717 718 719 720 721 722 723 724 725 726 727 728
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;
}

729 730
QVariant FactMetaData::_metersToFeet(const QVariant& meters)
{
731
    return QVariant(meters.toDouble() * 1.0/constants.feetToMeters);
732 733 734 735
}

QVariant FactMetaData::_feetToMeters(const QVariant& feet)
{
736
    return QVariant(feet.toDouble() * constants.feetToMeters);
737 738
}

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
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);
}

789 790
QVariant FactMetaData::_metersPerSecondToMilesPerHour(const QVariant& metersPerSecond)
{
791
    return QVariant((metersPerSecond.toDouble() * 1.0/constants.milesToMeters) * constants.secondsPerHour);
792 793 794 795
}

QVariant FactMetaData::_milesPerHourToMetersPerSecond(const QVariant& milesPerHour)
{
796
    return QVariant((milesPerHour.toDouble() * constants.milesToMeters) / constants.secondsPerHour);
797 798 799 800
}

QVariant FactMetaData::_metersPerSecondToKilometersPerHour(const QVariant& metersPerSecond)
{
801
    return QVariant((metersPerSecond.toDouble() / 1000.0) * constants.secondsPerHour);
802 803 804 805
}

QVariant FactMetaData::_kilometersPerHourToMetersPerSecond(const QVariant& kilometersPerHour)
{
806
    return QVariant((kilometersPerHour.toDouble() * 1000.0) / constants.secondsPerHour);
807 808 809 810
}

QVariant FactMetaData::_metersPerSecondToKnots(const QVariant& metersPerSecond)
{
811
    return QVariant(metersPerSecond.toDouble() * constants.secondsPerHour / (1000.0 * constants.knotsToKPH));
812 813 814 815
}

QVariant FactMetaData::_knotsToMetersPerSecond(const QVariant& knots)
{
816
    return QVariant(knots.toDouble() * (1000.0 * constants.knotsToKPH / constants.secondsPerHour));
817 818
}

819 820 821 822 823 824 825 826 827 828
QVariant FactMetaData::_percentToNorm(const QVariant& percent)
{
    return QVariant(percent.toDouble() / 100.0);
}

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

829 830 831 832 833 834 835 836 837 838
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);
}

839 840 841 842 843 844 845 846 847 848
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));
}

849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
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);
}

873 874 875 876 877
void FactMetaData::setRawUnits(const QString& rawUnits)
{
    _rawUnits = rawUnits;
    _cookedUnits = rawUnits;

878
    setBuiltInTranslator();
879
}
Don Gagne's avatar
Don Gagne committed
880 881 882 883 884 885 886 887 888

FactMetaData::ValueType_t FactMetaData::stringToType(const QString& typeString, bool& unknownType)
{
    QStringList         knownTypeStrings;
    QList<ValueType_t>  knownTypes;

    unknownType = false;

    knownTypeStrings << QStringLiteral("Uint8")
889 890 891 892 893
                     << QStringLiteral("Int8")
                     << QStringLiteral("Uint16")
                     << QStringLiteral("Int16")
                     << QStringLiteral("Uint32")
                     << QStringLiteral("Int32")
894 895
                     << QStringLiteral("Uint64")
                     << QStringLiteral("Int64")
896
                     << QStringLiteral("Float")
Don Gagne's avatar
Don Gagne committed
897
                     << QStringLiteral("Double")
898
                     << QStringLiteral("String")
899
                     << QStringLiteral("Bool")
900 901
                     << QStringLiteral("ElapsedSeconds")
                     << QStringLiteral("Custom");
Don Gagne's avatar
Don Gagne committed
902 903

    knownTypes << valueTypeUint8
904 905 906 907 908
               << valueTypeInt8
               << valueTypeUint16
               << valueTypeInt16
               << valueTypeUint32
               << valueTypeInt32
909 910
               << valueTypeUint64
               << valueTypeInt64
911
               << valueTypeFloat
Don Gagne's avatar
Don Gagne committed
912
               << valueTypeDouble
913
               << valueTypeString
914
               << valueTypeBool
915 916
               << valueTypeElapsedTimeInSeconds
               << valueTypeCustom;
Don Gagne's avatar
Don Gagne committed
917 918 919 920 921 922 923 924 925 926 927

    for (int i=0; i<knownTypeStrings.count(); i++) {
        if (knownTypeStrings[i].compare(typeString, Qt::CaseInsensitive) == 0) {
            return knownTypes[i];
        }
    }

    unknownType = true;

    return valueTypeDouble;
}
928 929 930 931

size_t FactMetaData::typeToSize(ValueType_t type)
{
    switch (type) {
932 933 934
    case valueTypeUint8:
    case valueTypeInt8:
        return 1;
935

936 937 938
    case valueTypeUint16:
    case valueTypeInt16:
        return 2;
939

940 941 942 943
    case valueTypeUint32:
    case valueTypeInt32:
    case valueTypeFloat:
        return 4;
944

945 946
    case valueTypeUint64:
    case valueTypeInt64:
947 948
    case valueTypeDouble:
        return 8;
949

950 951 952
    case valueTypeCustom:
        return MAVLINK_MSG_PARAM_EXT_SET_FIELD_PARAM_VALUE_LEN;

953 954
    default:
        qWarning() << "Unsupported fact value type" << type;
Don Gagne's avatar
Don Gagne committed
955
        return 0;
956 957
    }
}
958

959 960
/// Set translators according to app settings
void FactMetaData::_setAppSettingsTranslators(void)
961
{
962 963
    // We can only translate between real numbers
    if (!_enumStrings.count() && (type() == valueTypeDouble || type() == valueTypeFloat)) {
964 965
        for (size_t i=0; i<sizeof(_rgAppSettingsTranslations)/sizeof(_rgAppSettingsTranslations[0]); i++) {
            const AppSettingsTranslation_s* pAppSettingsTranslation = &_rgAppSettingsTranslations[i];
966 967 968 969 970 971 972 973 974

            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
975 976
            case UnitHorizontalDistance:
                settingsUnits = settings->horizontalDistanceUnits()->rawValue().toUInt();
977
                break;
Remek Zajac's avatar
Remek Zajac committed
978 979
            case UnitVerticalDistance:
                settingsUnits = settings->verticalDistanceUnits()->rawValue().toUInt();
980
                break;
981 982 983 984 985 986 987 988 989
            case UnitSpeed:
                settingsUnits = settings->speedUnits()->rawValue().toUInt();
                break;
            case UnitArea:
                settingsUnits = settings->areaUnits()->rawValue().toUInt();
                break;
            case UnitTemperature:
                settingsUnits = settings->temperatureUnits()->rawValue().toUInt();
                break;
990 991 992
            case UnitWeight:
                settingsUnits = settings->weightUnits()->rawValue().toUInt();
                break;
993 994 995 996 997 998
            default:
                break;
            }

            if (settingsUnits == pAppSettingsTranslation->unitOption) {
                 _cookedUnits = pAppSettingsTranslation->cookedUnits;
999 1000 1001 1002 1003 1004
                setTranslators(pAppSettingsTranslation->rawTranslator, pAppSettingsTranslation->cookedTranslator);
                return;
            }
        }
    }
}
1005

1006
const FactMetaData::AppSettingsTranslation_s* FactMetaData::_findAppSettingsUnitsTranslation(const QString& rawUnits, UnitTypes type)
1007 1008 1009
{
    for (size_t i=0; i<sizeof(_rgAppSettingsTranslations)/sizeof(_rgAppSettingsTranslations[0]); i++) {
        const AppSettingsTranslation_s* pAppSettingsTranslation = &_rgAppSettingsTranslations[i];
1010 1011 1012 1013 1014

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

1015 1016
        uint unitOption = 0;
        auto unitsSettings = qgcApp()->toolbox()->settingsManager()->unitsSettings();
1017 1018
        switch (type) {
        case UnitHorizontalDistance:
1019
            unitOption = unitsSettings->horizontalDistanceUnits()->rawValue().toUInt();
1020 1021
            break;
        case UnitVerticalDistance:
1022
            unitOption = unitsSettings->verticalDistanceUnits()->rawValue().toUInt();
1023 1024
            break;
        case UnitArea:
1025
            unitOption = unitsSettings->areaUnits()->rawValue().toUInt();
1026 1027
            break;
        case UnitSpeed:
1028
            unitOption = unitsSettings->speedUnits()->rawValue().toUInt();
1029 1030
            break;
        case UnitTemperature:
1031
            unitOption = unitsSettings->temperatureUnits()->rawValue().toUInt();
1032 1033
            break;
        case UnitWeight:
1034
            unitOption = unitsSettings->weightUnits()->rawValue().toUInt();
1035 1036 1037 1038
            break;
        default:
            assert(false);
            break;
1039 1040
        }

1041
        if (pAppSettingsTranslation->unitType == type
1042
                && pAppSettingsTranslation->unitOption == unitOption) {
1043 1044 1045 1046 1047 1048 1049
            return pAppSettingsTranslation;
        }
    }

    return nullptr;
}

Remek Zajac's avatar
Remek Zajac committed
1050
QVariant FactMetaData::metersToAppSettingsHorizontalDistanceUnits(const QVariant& meters)
1051
{
1052
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m", UnitHorizontalDistance);
1053 1054 1055 1056 1057 1058 1059
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->rawTranslator(meters);
    } else {
        return meters;
    }
}

Remek Zajac's avatar
Remek Zajac committed
1060
QVariant FactMetaData::metersToAppSettingsVerticalDistanceUnits(const QVariant& meters)
1061
{
1062
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("vertical m", UnitVerticalDistance);
1063 1064 1065 1066 1067 1068 1069
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->rawTranslator(meters);
    } else {
        return meters;
    }
}

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

Remek Zajac's avatar
Remek Zajac committed
1080
QVariant FactMetaData::appSettingsVerticalDistanceUnitsToMeters(const QVariant& distance)
1081
{
1082
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("alt m", UnitVerticalDistance);
1083 1084 1085 1086 1087 1088 1089
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedTranslator(distance);
    } else {
        return distance;
    }
}

Remek Zajac's avatar
Remek Zajac committed
1090
QString FactMetaData::appSettingsHorizontalDistanceUnitsString(void)
1091
{
1092
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m", UnitHorizontalDistance);
1093 1094 1095 1096 1097 1098
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("m");
    }
}
1099

Remek Zajac's avatar
Remek Zajac committed
1100
QString FactMetaData::appSettingsVerticalDistanceUnitsString(void)
1101
{
1102
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("alt m", UnitVerticalDistance);
1103 1104 1105 1106 1107 1108 1109 1110 1111
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("m");
    }
}

QString FactMetaData::appSettingsWeightUnitsString(void)
{
1112
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("g", UnitWeight);
1113 1114 1115 1116 1117 1118 1119
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("g");
    }
}

1120 1121
QVariant FactMetaData::squareMetersToAppSettingsAreaUnits(const QVariant& squareMeters)
{
1122
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m^2", UnitArea);
1123 1124 1125 1126 1127 1128 1129 1130 1131
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->rawTranslator(squareMeters);
    } else {
        return squareMeters;
    }
}

QVariant FactMetaData::appSettingsAreaUnitsToSquareMeters(const QVariant& area)
{
1132
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m^2", UnitArea);
1133 1134 1135 1136 1137 1138 1139 1140 1141
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedTranslator(area);
    } else {
        return area;
    }
}

QString FactMetaData::appSettingsAreaUnitsString(void)
{
1142
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m^2", UnitArea);
1143 1144 1145 1146 1147 1148 1149
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("m^2");
    }
}

1150
QVariant FactMetaData::gramsToAppSettingsWeightUnits(const QVariant& grams) {
1151
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("g", UnitWeight);
1152 1153 1154 1155 1156 1157 1158 1159
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->rawTranslator(grams);
    } else {
        return grams;
    }
}

QVariant FactMetaData::appSettingsWeightUnitsToGrams(const QVariant& weight) {
1160
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("g", UnitWeight);
1161 1162 1163 1164 1165 1166 1167
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedTranslator(weight);
    } else {
        return weight;
    }
}

1168 1169
QString FactMetaData::appSettingsSpeedUnitsString()
{
1170
    const AppSettingsTranslation_s* pAppSettingsTranslation = _findAppSettingsUnitsTranslation("m/s", UnitSpeed);
1171 1172 1173 1174 1175 1176
    if (pAppSettingsTranslation) {
        return pAppSettingsTranslation->cookedUnits;
    } else {
        return QStringLiteral("m/s");
    }
}
1177

1178 1179
double FactMetaData::cookedIncrement(void) const
{
1180
    return _rawTranslator(this->rawIncrement()).toDouble();
1181 1182
}

1183 1184
int FactMetaData::decimalPlaces(void) const
{
1185 1186
    int actualDecimalPlaces = kDefaultDecimalPlaces;
    int incrementDecimalPlaces = kUnknownDecimalPlaces;
1187 1188

    // First determine decimal places from increment
1189
    double increment = _rawTranslator(this->rawIncrement()).toDouble();
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
    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));
        }
    }

1203 1204 1205 1206 1207 1208 1209
    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();
1210

1211
            settingsDecimalPlaces += -log10(ctest);
1212

1213 1214 1215 1216 1217
            settingsDecimalPlaces = qMin(25, settingsDecimalPlaces);
            settingsDecimalPlaces = qMax(0, settingsDecimalPlaces);
        }
    } else {
        actualDecimalPlaces = _decimalPlaces;
1218 1219 1220 1221
    }

    return actualDecimalPlaces;
}
1222

1223
FactMetaData* FactMetaData::createFromJsonObject(const QJsonObject& json, QMap<QString, QString>& defineMap, QObject* metaDataParent)
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
{
    QString         errorString;

    // Make sure we have the required keys
    QStringList requiredKeys;
    requiredKeys << _nameJsonKey << _typeJsonKey;
    if (!JsonHelper::validateRequiredKeys(json, requiredKeys, errorString)) {
        qWarning() << errorString;
        return new FactMetaData(valueTypeUint32, metaDataParent);
    }

1235
    QList<JsonHelper::KeyValidateInfo> keyInfoList = {
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
        { _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 },
1246 1247
    };
    if (!JsonHelper::validateKeys(json, keyInfoList, errorString)) {
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
        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);
    }

    FactMetaData*   metaData = new FactMetaData(type, metaDataParent);

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

    QStringList enumValues, enumStrings;
1264
    if (JsonHelper::parseEnum(json, defineMap, enumStrings, enumValues, errorString, metaData->name())) {
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
        for (int i=0; i<enumValues.count(); i++) {
            QVariant    enumVariant;
            QString     errorString;

            if (metaData->convertAndValidateRaw(enumValues[i], false /* validate */, enumVariant, errorString)) {
                metaData->addEnumInfo(enumStrings[i], enumVariant);
            } else {
                qWarning() << "Invalid enum value, name:" << metaData->name()
                           << " type:" << metaData->type()
                           << " value:" << enumValues[i]
                           << " error:" << errorString;
            }
        }
    } else {
        qWarning() << errorString;
    }

    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());
    }
1289 1290

    QString defaultValueJsonKey;
1291 1292
#ifdef __mobile__
    if (json.contains(_mobileDefaultValueJsonKey)) {
Don Gagne's avatar
Don Gagne committed
1293
        defaultValueJsonKey = _mobileDefaultValueJsonKey;
1294
    }
1295
#endif
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
    if (defaultValueJsonKey.isEmpty() && json.contains(_defaultValueJsonKey)) {
        defaultValueJsonKey = _defaultValueJsonKey;
    }
    if (!defaultValueJsonKey.isEmpty()) {
        QVariant typedValue;
        QString errorString;
        QVariant initialValue = json[defaultValueJsonKey].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;
        }
    }

1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
    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;
        }
    }

1327
    if (json.contains(_minJsonKey)) {
1328 1329
        QVariant typedValue;
        QString errorString;
1330 1331 1332 1333 1334 1335 1336 1337 1338
        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;
        }
1339
    }
1340

1341
    if (json.contains(_maxJsonKey)) {
1342 1343
        QVariant typedValue;
        QString errorString;
1344 1345 1346 1347 1348 1349 1350 1351 1352
        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;
        }
1353
    }
1354

1355 1356 1357 1358 1359
    if (json.contains(_hasControlJsonKey)) {
        metaData->setHasControl(json[_hasControlJsonKey].toBool());
    } else {
        metaData->setHasControl(true);
    }
1360

1361 1362 1363 1364 1365 1366
    if (json.contains(_qgcRebootRequiredJsonKey)) {
        metaData->setQGCRebootRequired(json[_qgcRebootRequiredJsonKey].toBool());
    } else {
        metaData->setQGCRebootRequired(false);
    }

1367 1368 1369
    return metaData;
}

1370 1371 1372 1373 1374 1375 1376 1377
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();
    }
}

1378 1379 1380 1381
QMap<QString, FactMetaData*> FactMetaData::createMapFromJsonFile(const QString& jsonFilename, QObject* metaDataParent)
{
    QMap<QString, FactMetaData*> metaDataMap;

1382 1383 1384 1385 1386
    QString errorString;
    int version;
    QJsonObject jsonObject = JsonHelper::openInternalQGCJsonFile(jsonFilename, qgcFileType, 1, 1, version, errorString);
    if (!errorString.isEmpty()) {
        qWarning() << "Internal Error: " << errorString;
1387 1388 1389
        return metaDataMap;
    }

1390 1391 1392
    QJsonArray factArray;
    QMap<QString /* define name */, QString /* define value */> defineMap;

1393 1394 1395 1396 1397 1398
    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;
1399 1400 1401
        return metaDataMap;
    }

1402 1403 1404
    _loadJsonDefines(jsonObject[FactMetaData::_jsonMetaDataDefinesName].toObject(), defineMap);
    factArray = jsonObject[FactMetaData::_jsonMetaDataFactsName].toArray();

1405
    return createMapFromJsonArray(factArray, defineMap, metaDataParent);
1406
}
1407

1408
QMap<QString, FactMetaData*> FactMetaData::createMapFromJsonArray(const QJsonArray jsonArray, QMap<QString, QString>& defineMap, QObject* metaDataParent)
1409 1410 1411 1412
{
    QMap<QString, FactMetaData*> metaDataMap;
    for (int i=0; i<jsonArray.count(); i++) {
        QJsonValue jsonValue = jsonArray.at(i);
1413 1414 1415 1416 1417
        if (!jsonValue.isObject()) {
            qWarning() << QStringLiteral("JsonValue at index %1 not an object").arg(i);
            continue;
        }
        QJsonObject jsonObject = jsonValue.toObject();
1418
        FactMetaData* metaData = createFromJsonObject(jsonObject, defineMap, metaDataParent);
1419 1420
        if (metaDataMap.contains(metaData->name())) {
            qWarning() << QStringLiteral("Duplicate fact name:") << metaData->name();
1421
            delete metaData;
1422 1423 1424 1425 1426 1427
        } else {
            metaDataMap[metaData->name()] = metaData;
        }
    }
    return metaDataMap;
}
1428 1429 1430 1431

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.
1432
    return qMax(_rawTranslator(_rawMax), _rawTranslator(_rawMin));
1433 1434 1435 1436 1437
}

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.
1438
    return qMin(_rawTranslator(_rawMax), _rawTranslator(_rawMin));
1439
}
1440 1441 1442 1443 1444 1445 1446 1447

void FactMetaData::setVolatileValue(bool bValue)
{
    _volatile = bValue;
    if (_volatile) {
        _readOnly = true;
    }
}