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

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

#include "Fact.h"
Don Gagne's avatar
Don Gagne committed
28
#include "QGCMAVLink.h"
Don Gagne's avatar
Don Gagne committed
29
30
31

#include <QtQml>

Don Gagne's avatar
Don Gagne committed
32
33
34
Fact::Fact(QObject* parent)
    : QObject(parent)
    , _componentId(-1)
Don Gagne's avatar
Don Gagne committed
35
    , _rawValue(0)
Don Gagne's avatar
Don Gagne committed
36
37
    , _type(FactMetaData::valueTypeInt32)
    , _metaData(NULL)
Don Gagne's avatar
Don Gagne committed
38
39
    , _sendValueChangedSignals(true)
    , _deferredValueChangeSignal(false)
Don Gagne's avatar
Don Gagne committed
40
41
42
43
44
{    
    FactMetaData* metaData = new FactMetaData(_type, this);
    setMetaData(metaData);
}

Don Gagne's avatar
Don Gagne committed
45
46
47
48
Fact::Fact(int componentId, QString name, FactMetaData::ValueType_t type, QObject* parent)
    : QObject(parent)
    , _name(name)
    , _componentId(componentId)
Don Gagne's avatar
Don Gagne committed
49
    , _rawValue(0)
Don Gagne's avatar
Don Gagne committed
50
51
    , _type(type)
    , _metaData(NULL)
Don Gagne's avatar
Don Gagne committed
52
53
    , _sendValueChangedSignals(true)
    , _deferredValueChangeSignal(false)
Don Gagne's avatar
Don Gagne committed
54
{
Don Gagne's avatar
Don Gagne committed
55
56
57
    FactMetaData* metaData = new FactMetaData(_type, this);
    setMetaData(metaData);
}
Don Gagne's avatar
Don Gagne committed
58

Don Gagne's avatar
Don Gagne committed
59
60
61
62
63
64
65
66
Fact::Fact(const Fact& other, QObject* parent)
    : QObject(parent)
{
    *this = other;
}

const Fact& Fact::operator=(const Fact& other)
{
Don Gagne's avatar
Don Gagne committed
67
68
69
70
71
72
73
    _name                       = other._name;
    _componentId                = other._componentId;
    _rawValue                   = other._rawValue;
    _type                       = other._type;
    _sendValueChangedSignals    = other._sendValueChangedSignals;
    _deferredValueChangeSignal  = other._deferredValueChangeSignal;

Don Gagne's avatar
Don Gagne committed
74
75
76
77
78
79
80
    if (_metaData && other._metaData) {
        *_metaData = *other._metaData;
    } else {
        _metaData = NULL;
    }
    
    return *this;
Don Gagne's avatar
Don Gagne committed
81
82
}

Don Gagne's avatar
Don Gagne committed
83
void Fact::forceSetRawValue(const QVariant& value)
Don Gagne's avatar
Don Gagne committed
84
85
86
87
88
{
    if (_metaData) {
        QVariant    typedValue;
        QString     errorString;
        
89
        if (_metaData->convertAndValidateRaw(value, true /* convertOnly */, typedValue, errorString)) {
Don Gagne's avatar
Don Gagne committed
90
            _rawValue.setValue(typedValue);
Don Gagne's avatar
Don Gagne committed
91
            _sendValueChangedSignal(cookedValue());
Don Gagne's avatar
Don Gagne committed
92
            emit _containerRawValueChanged(rawValue());
Don Gagne's avatar
Don Gagne committed
93
94
95
96
97
98
        }
    } else {
        qWarning() << "Meta data pointer missing";
    }
}

Don Gagne's avatar
Don Gagne committed
99
void Fact::setRawValue(const QVariant& value)
Don Gagne's avatar
Don Gagne committed
100
{
Don Gagne's avatar
Don Gagne committed
101
102
103
104
    if (_metaData) {
        QVariant    typedValue;
        QString     errorString;
        
105
        if (_metaData->convertAndValidateRaw(value, true /* convertOnly */, typedValue, errorString)) {
Don Gagne's avatar
Don Gagne committed
106
107
            if (typedValue != _rawValue) {
                _rawValue.setValue(typedValue);
Don Gagne's avatar
Don Gagne committed
108
                _sendValueChangedSignal(cookedValue());
Don Gagne's avatar
Don Gagne committed
109
                emit _containerRawValueChanged(rawValue());
Don Gagne's avatar
Don Gagne committed
110
111
112
113
            }
        }
    } else {
        qWarning() << "Meta data pointer missing";
114
    }
Don Gagne's avatar
Don Gagne committed
115
116
}

Don Gagne's avatar
Don Gagne committed
117
void Fact::setCookedValue(const QVariant& value)
Don Gagne's avatar
Don Gagne committed
118
119
120
121
122
123
124
125
126
127
128
129
130
{
    if (_metaData) {
        setRawValue(_metaData->cookedTranslator()(value));
    } else {
        qWarning() << "Meta data pointer missing";
    }
}

void Fact::setEnumStringValue(const QString& value)
{
    if (_metaData) {
        int index = _metaData->enumStrings().indexOf(value);
        if (index != -1) {
Don Gagne's avatar
Don Gagne committed
131
            setCookedValue(_metaData->enumValues()[index]);
Don Gagne's avatar
Don Gagne committed
132
133
134
135
136
137
138
139
140
        }
    } else {
        qWarning() << "Meta data pointer missing";
    }
}

void Fact::setEnumIndex(int index)
{
    if (_metaData) {
Don Gagne's avatar
Don Gagne committed
141
        setCookedValue(_metaData->enumValues()[index]);
Don Gagne's avatar
Don Gagne committed
142
143
144
145
146
    } else {
        qWarning() << "Meta data pointer missing";
    }
}

Don Gagne's avatar
Don Gagne committed
147
void Fact::_containerSetRawValue(const QVariant& value)
Don Gagne's avatar
Don Gagne committed
148
{
Don Gagne's avatar
Don Gagne committed
149
    _rawValue = value;
Don Gagne's avatar
Don Gagne committed
150
    _sendValueChangedSignal(cookedValue());
Don Gagne's avatar
Don Gagne committed
151
    emit vehicleUpdated(_rawValue);
Don Gagne's avatar
Don Gagne committed
152
}
Don Gagne's avatar
Don Gagne committed
153
154
155
156
157
158

QString Fact::name(void) const
{
    return _name;
}

159
160
161
162
163
int Fact::componentId(void) const
{
    return _componentId;
}

Don Gagne's avatar
Don Gagne committed
164
QVariant Fact::cookedValue(void) const
Don Gagne's avatar
Don Gagne committed
165
{
Don Gagne's avatar
Don Gagne committed
166
167
168
169
170
171
172
173
    if (_metaData) {
        return _metaData->rawTranslator()(_rawValue);
    } else {
        qWarning() << "Meta data pointer missing";
        return _rawValue;
    }
}

Don Gagne's avatar
Don Gagne committed
174
QString Fact::enumStringValue(void)
Don Gagne's avatar
Don Gagne committed
175
176
177
{
    if (_metaData) {
        int enumIndex = this->enumIndex();
Don Gagne's avatar
Don Gagne committed
178
        if (enumIndex >= 0 && enumIndex < _metaData->enumStrings().count()) {
Don Gagne's avatar
Don Gagne committed
179
180
181
182
183
184
185
186
187
            return _metaData->enumStrings()[enumIndex];
        }
    } else {
        qWarning() << "Meta data pointer missing";
    }

    return QString();
}

Don Gagne's avatar
Don Gagne committed
188
int Fact::enumIndex(void)
Don Gagne's avatar
Don Gagne committed
189
190
191
{
    if (_metaData) {
        int index = 0;
Don Gagne's avatar
Don Gagne committed
192

Don Gagne's avatar
Don Gagne committed
193
        foreach (QVariant enumValue, _metaData->enumValues()) {
Don Gagne's avatar
Don Gagne committed
194
            if (enumValue == rawValue()) {
Don Gagne's avatar
Don Gagne committed
195
196
197
198
                return index;
            }
            index ++;
        }
Don Gagne's avatar
Don Gagne committed
199
200
201
202
203
204

        // Current value is not in list, add it manually
        _metaData->addEnumInfo(QString("Unknown: %1").arg(rawValue().toString()), rawValue());
        emit enumStringsChanged();
        emit enumValuesChanged();
        return index;
Don Gagne's avatar
Don Gagne committed
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
    } else {
        qWarning() << "Meta data pointer missing";
    }

    return -1;
}

QStringList Fact::enumStrings(void) const
{
    if (_metaData) {
        return _metaData->enumStrings();
    } else {
        qWarning() << "Meta data pointer missing";
        return QStringList();
    }
}

QVariantList Fact::enumValues(void) const
{
    if (_metaData) {
        return _metaData->enumValues();
    } else {
        qWarning() << "Meta data pointer missing";
        return QVariantList();
    }
Don Gagne's avatar
Don Gagne committed
230
231
}

Don Gagne's avatar
Don Gagne committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
QStringList Fact::bitmaskStrings(void) const
{
    if (_metaData) {
        return _metaData->bitmaskStrings();
    } else {
        qWarning() << "Meta data pointer missing";
        return QStringList();
    }
}

QVariantList Fact::bitmaskValues(void) const
{
    if (_metaData) {
        return _metaData->bitmaskValues();
    } else {
        qWarning() << "Meta data pointer missing";
        return QVariantList();
    }
}

252
QString Fact::_variantToString(const QVariant& variant) const
Don Gagne's avatar
Don Gagne committed
253
{
254
255
256
257
    QString valueString;

    switch (type()) {
        case FactMetaData::valueTypeFloat:
258
            valueString = QString("%1").arg(variant.toFloat(), 0, 'f', decimalPlaces());
259
260
            break;
        case FactMetaData::valueTypeDouble:
261
            valueString = QString("%1").arg(variant.toDouble(), 0, 'f', decimalPlaces());
262
263
            break;
        default:
264
            valueString = variant.toString();
265
266
267
268
            break;
    }

    return valueString;
Don Gagne's avatar
Don Gagne committed
269
270
}

271
272
273
274
275
276
QString Fact::rawValueString(void) const
{
    return _variantToString(rawValue());
}

QString Fact::cookedValueString(void) const
277
{
Don Gagne's avatar
Don Gagne committed
278
    return _variantToString(cookedValue());
279
280
}

281
282
283
284
285
286
287
288
289
290
291
292
293
294
QVariant Fact::rawDefaultValue(void) const
{
    if (_metaData) {
        if (!_metaData->defaultValueAvailable()) {
            qDebug() << "Access to unavailable default value";
        }
        return _metaData->rawDefaultValue();
    } else {
        qWarning() << "Meta data pointer missing";
        return QVariant(0);
    }
}

QVariant Fact::cookedDefaultValue(void) const
Don Gagne's avatar
Don Gagne committed
295
{
Don Gagne's avatar
Don Gagne committed
296
297
298
299
    if (_metaData) {
        if (!_metaData->defaultValueAvailable()) {
            qDebug() << "Access to unavailable default value";
        }
300
        return _metaData->cookedDefaultValue();
Don Gagne's avatar
Don Gagne committed
301
302
303
    } else {
        qWarning() << "Meta data pointer missing";
        return QVariant(0);
Don Gagne's avatar
Don Gagne committed
304
    }
Don Gagne's avatar
Don Gagne committed
305
306
}

307
QString Fact::cookedDefaultValueString(void) const
308
{
309
    return _variantToString(cookedDefaultValue());
310
311
}

312
FactMetaData::ValueType_t Fact::type(void) const
Don Gagne's avatar
Don Gagne committed
313
{
314
    return _type;
Don Gagne's avatar
Don Gagne committed
315
316
}

317
QString Fact::shortDescription(void) const
Don Gagne's avatar
Don Gagne committed
318
{
Don Gagne's avatar
Don Gagne committed
319
320
321
322
323
324
    if (_metaData) {
        return _metaData->shortDescription();
    } else {
        qWarning() << "Meta data pointer missing";
        return QString();
    }
Don Gagne's avatar
Don Gagne committed
325
326
}

327
QString Fact::longDescription(void) const
Don Gagne's avatar
Don Gagne committed
328
{
Don Gagne's avatar
Don Gagne committed
329
330
331
332
333
334
    if (_metaData) {
        return _metaData->longDescription();
    } else {
        qWarning() << "Meta data pointer missing";
        return QString();
    }
Don Gagne's avatar
Don Gagne committed
335
336
}

337
338
339
340
341
342
343
344
345
346
347
QString Fact::rawUnits(void) const
{
    if (_metaData) {
        return _metaData->rawUnits();
    } else {
        qWarning() << "Meta data pointer missing";
        return QString();
    }
}

QString Fact::cookedUnits(void) const
Don Gagne's avatar
Don Gagne committed
348
{
Don Gagne's avatar
Don Gagne committed
349
    if (_metaData) {
350
        return _metaData->cookedUnits();
Don Gagne's avatar
Don Gagne committed
351
352
353
354
    } else {
        qWarning() << "Meta data pointer missing";
        return QString();
    }
Don Gagne's avatar
Don Gagne committed
355
356
}

357
QVariant Fact::rawMin(void) const
Don Gagne's avatar
Don Gagne committed
358
{
Don Gagne's avatar
Don Gagne committed
359
    if (_metaData) {
360
        return _metaData->rawMin();
Don Gagne's avatar
Don Gagne committed
361
362
363
364
    } else {
        qWarning() << "Meta data pointer missing";
        return QVariant(0);
    }
Don Gagne's avatar
Don Gagne committed
365
366
}

367
QVariant Fact::cookedMin(void) const
368
{
369
370
371
372
373
374
    if (_metaData) {
        return _metaData->cookedMin();
    } else {
        qWarning() << "Meta data pointer missing";
        return QVariant(0);
    }
375
376
}

377
378
379
380
381
382
QString Fact::cookedMinString(void) const
{
    return _variantToString(cookedMin());
}

QVariant Fact::rawMax(void) const
Don Gagne's avatar
Don Gagne committed
383
{
Don Gagne's avatar
Don Gagne committed
384
    if (_metaData) {
385
        return _metaData->rawMax();
Don Gagne's avatar
Don Gagne committed
386
387
388
389
390
391
    } else {
        qWarning() << "Meta data pointer missing";
        return QVariant(0);
    }
}

392
QVariant Fact::cookedMax(void) const
393
{
394
395
396
397
398
399
400
401
402
403
404
    if (_metaData) {
        return _metaData->cookedMax();
    } else {
        qWarning() << "Meta data pointer missing";
        return QVariant(0);
    }
}

QString Fact::cookedMaxString(void) const
{
    return _variantToString(cookedMax());
405
406
}

407
bool Fact::minIsDefaultForType(void) const
Don Gagne's avatar
Don Gagne committed
408
409
410
411
412
413
414
415
416
{
    if (_metaData) {
        return _metaData->minIsDefaultForType();
    } else {
        qWarning() << "Meta data pointer missing";
        return false;
    }
}

417
bool Fact::maxIsDefaultForType(void) const
Don Gagne's avatar
Don Gagne committed
418
419
420
421
422
423
424
{
    if (_metaData) {
        return _metaData->maxIsDefaultForType();
    } else {
        qWarning() << "Meta data pointer missing";
        return false;
    }
Don Gagne's avatar
Don Gagne committed
425
426
}

427
428
429
430
431
432
433
434
435
436
int Fact::decimalPlaces(void) const
{
    if (_metaData) {
        return _metaData->decimalPlaces();
    } else {
        qWarning() << "Meta data pointer missing";
        return FactMetaData::defaultDecimalPlaces;
    }
}

437
QString Fact::group(void) const
Don Gagne's avatar
Don Gagne committed
438
{
Don Gagne's avatar
Don Gagne committed
439
440
441
442
443
444
    if (_metaData) {
        return _metaData->group();
    } else {
        qWarning() << "Meta data pointer missing";
        return QString();
    }
Don Gagne's avatar
Don Gagne committed
445
446
}

Don Gagne's avatar
Don Gagne committed
447
448
449
void Fact::setMetaData(FactMetaData* metaData)
{
    _metaData = metaData;
Don Gagne's avatar
Don Gagne committed
450
    emit valueChanged(cookedValue());
Don Gagne's avatar
Don Gagne committed
451
}
Don Gagne's avatar
Don Gagne committed
452

453
bool Fact::valueEqualsDefault(void) const
Don Gagne's avatar
Don Gagne committed
454
{
Don Gagne's avatar
Don Gagne committed
455
456
    if (_metaData) {
        if (_metaData->defaultValueAvailable()) {
457
            return _metaData->rawDefaultValue() == rawValue();
Don Gagne's avatar
Don Gagne committed
458
459
460
        } else {
            return false;
        }
Don Gagne's avatar
Don Gagne committed
461
    } else {
Don Gagne's avatar
Don Gagne committed
462
        qWarning() << "Meta data pointer missing";
Don Gagne's avatar
Don Gagne committed
463
464
465
466
        return false;
    }
}

467
bool Fact::defaultValueAvailable(void) const
Don Gagne's avatar
Don Gagne committed
468
{
Don Gagne's avatar
Don Gagne committed
469
470
471
472
473
474
475
476
    if (_metaData) {
        return _metaData->defaultValueAvailable();
    } else {
        qWarning() << "Meta data pointer missing";
        return false;
    }
}

477
QString Fact::validate(const QString& cookedValue, bool convertOnly)
Don Gagne's avatar
Don Gagne committed
478
479
480
481
482
{
    if (_metaData) {
        QVariant    typedValue;
        QString     errorString;
        
483
        _metaData->convertAndValidateCooked(cookedValue, convertOnly, typedValue, errorString);
Don Gagne's avatar
Don Gagne committed
484
485
486
487
488
489
490
        
        return errorString;
    } else {
        qWarning() << "Meta data pointer missing";
        return QString("Internal error: Meta data pointer missing");
    }
}
Don Gagne's avatar
Don Gagne committed
491
492
493
494
495
496
497
498
499
500

bool Fact::rebootRequired(void) const
{
    if (_metaData) {
        return _metaData->rebootRequired();
    } else {
        qWarning() << "Meta data pointer missing";
        return false;
    }
}
Don Gagne's avatar
Don Gagne committed
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526

void Fact::setSendValueChangedSignals (bool sendValueChangedSignals)
{
    if (sendValueChangedSignals != _sendValueChangedSignals) {
        _sendValueChangedSignals = sendValueChangedSignals;
        emit sendValueChangedSignalsChanged(_sendValueChangedSignals);
    }
}

void Fact::_sendValueChangedSignal(QVariant value)
{
    if (_sendValueChangedSignals) {
        emit valueChanged(value);
        _deferredValueChangeSignal = false;
    } else {
        _deferredValueChangeSignal = true;
    }
}

void Fact::sendDeferredValueChangedSignal(void)
{
    if (_deferredValueChangeSignal) {
        _deferredValueChangeSignal = false;
        emit valueChanged(cookedValue());
    }
}
527
528
529
530
531
532
533
534
535
536
537
538
539
540

QString Fact::enumOrValueString(void)
{
    if (_metaData) {
        if (_metaData->enumStrings().count()) {
            return enumStringValue();
        } else {
            return cookedValueString();
        }
    } else {
        qWarning() << "Meta data pointer missing";
    }
    return QString();
}