File: dbc_classes.cpp

package info (click to toggle)
savvycan 220-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 12,456 kB
  • sloc: cpp: 61,803; sh: 293; javascript: 91; python: 44; makefile: 8
file content (487 lines) | stat: -rw-r--r-- 17,555 bytes parent folder | download
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
#include "dbc_classes.h"
#include "dbchandler.h"
#include "utility.h"
#include <QtMath>

DBC_MESSAGE::DBC_MESSAGE()
{
    sigHandler = new DBCSignalHandler;
    ID = 0;
    len = 0;
    multiplexorSignal = nullptr;
    sender = nullptr;
}

void DBC_SIGNAL::addMultiplexRange(int min, int max)
{
    if (min != max)
        hasExtendedMultiplexing = true;
    isMultiplexed = true;
    //it is very likely that things that include extended multiplexing will have at least two definitions
    //which are identical. So, detect this and don't store on subsequent calls
    if (!multiplexLowAndHighValues.contains(QPair<int, int>(min, max)))
        multiplexLowAndHighValues.append(QPair<int, int>(min, max));
}

bool DBC_SIGNAL::isSignalInMessage(const CANFrame &frame)
{
    DBC_MESSAGE *msg = nullptr;

    if (isMultiplexor && !isMultiplexed) return true; //the root multiplexor is always in the message.
    if (isMultiplexed)
    {
        DBC_SIGNAL *sig = nullptr;

        if (parentMessage->multiplexorSignal != nullptr)
        {
            if (multiplexParent->isSignalInMessage(frame)) //parent is in message so check if value is correct
            {
                int val;
                if (!multiplexParent->processAsInt(frame, val)) return false;
                return isValueMatchingMultiplex(val);
            }
            else return false;
        }
        else return false;
    }
    else return true; //if signal isn't multiplexed then it's definitely in the message
}

bool DBC_SIGNAL::isValueMatchingMultiplex(int val) const
{
    for (auto limitPair : multiplexLowAndHighValues) {
        if ((limitPair.first <= val) && (val <= limitPair.second))
            return true;
    }
    return false;
}

QString DBC_SIGNAL::multiplexDbcString(DbcMuxStringFormat fmt) const
{
    QString ret;
    for (auto limitPair : multiplexLowAndHighValues) {
        if (fmt == MuxStringFormat_DbcFile) {
            if (!ret.isEmpty())
                ret.append(QStringLiteral(" "));
            ret.append(QString("%1-%2").arg(limitPair.first).arg(limitPair.second));
        } else {
            if (!ret.isEmpty())
                ret.append(QStringLiteral(";"));
            ret.append(QString::number(limitPair.first));
            if (limitPair.first != limitPair.second)
                ret.append(QString("-%1").arg(limitPair.second));
        }
    }
    return ret;
}

void DBC_SIGNAL::copyMultiplexValuesFromSignal(const DBC_SIGNAL &signal)
{
    isMultiplexed = signal.isMultiplexed;
    for (auto multiplexSignalPair : signal.multiplexLowAndHighValues) {
        multiplexLowAndHighValues.append(multiplexSignalPair);
    }
}

/*
 * multiplexLowAndHighValues is private but the DBC saving code needs to be able to save a reasonable value for the multiplex value
 * for non-extended multiplex values. So, we grab the first element of the first item which should be the non-extended value
 */
int DBC_SIGNAL::getSimpleMultiplexValue()
{
    return multiplexLowAndHighValues.at(0).first;
}

/**
 * @brief DBC_SIGNAL::parseDbcMultiplexUiString
 * Method for parsing the Vector CANDB++ like multiplex definitions:
 *
 * Single values has to be separated by semicolons
 * and the value ranges by hypens
 * (e.g.: 1;2;5-7)
 * @param multiplexes in  the format from the UI
 * @param errorString output parameter to pass the failure text if parsing failed
 * @return true if the multiplexes parameter could be parsed properly
 */
bool DBC_SIGNAL::parseDbcMultiplexUiString(const QString &multiplexes, QString &errorString)
{
    QList<QPair<int, int>> multiplexLowAndHighValuesTemp;
    const auto muxes = multiplexes.split(QChar(';'), Qt::SkipEmptyParts);
    for (const auto &mux : muxes) {
        bool ok = false;
        if (mux.contains(QChar('-'))) {
            const auto minMax = mux.split(QChar('-'));
            if (minMax.count() != 2) {
                errorString = QObject::tr("The %1 part contains more than one '-' sign").arg(mux);
                return false;
            }

            int min = minMax.at(0).toInt(&ok);
            if (!ok) {
                errorString = QObject::tr("Unable to parse the %1 part to integer").arg(minMax.at(0));
                return false;
            }

            int max = minMax.at(1).toInt(&ok);
            if (!ok) {
                errorString = QObject::tr("Unable to parse the %1 part to integer").arg(minMax.at(1));
                return false;
            }

            multiplexLowAndHighValuesTemp.append(QPair<int, int>(min, max));
        } else {
            int value = mux.toInt(&ok);
            if (!ok) {
                errorString = QObject::tr("Unable to parse the %1 part to integer").arg(mux);
                return false;
            }
            multiplexLowAndHighValuesTemp.append(QPair<int, int>(value, value));
        }
    }
    multiplexLowAndHighValues.clear();
    multiplexLowAndHighValues = multiplexLowAndHighValuesTemp;
    return true;
}

bool DBC_SIGNAL::multiplexesIdenticalToSignal(DBC_SIGNAL *other) const
{
    auto othersMuxes = other->multiplexLowAndHighValues;
    for (auto myMux : multiplexLowAndHighValues) {
        bool found = false;
        for (auto otherMux : othersMuxes) {
            if (myMux == otherMux) {
                othersMuxes.removeAll(myMux);
                found = true;
                break;
            }
        }
        if (!found)
            return false;
    }
    return othersMuxes.isEmpty();
}

//Take all the children of this signal and see if they exist in the message. Can be called recursively to descend the dependency tree
QString DBC_SIGNAL::processSignalTree(const CANFrame &frame)
{
    QString build;
    int val;
    if (!this->processAsInt(frame, val))
    {
        qDebug() << "Could not process multiplexor as an integer.";
        return build;
    }
    qDebug() << val;

    foreach (DBC_SIGNAL *sig, multiplexedChildren)
    {
        if (sig->isValueMatchingMultiplex(val))
        {
            qDebug() << "Found match for multiplex value range - " << sig->name;
            QString sigString;
            if (sig->processAsText(frame, sigString))
            {
                qDebug() << "Returned value: " << sigString;
                if (!build.isEmpty() && !sigString.isEmpty())
                    build.append("\n");
                build.append(sigString);
                if (sig->isMultiplexor)
                {
                    qDebug() << "Spelunkin!";
                    auto subTreeString = sig->processSignalTree(frame);
                    if (!build.isEmpty() && !subTreeString.isEmpty())
                        build.append("\n");
                    build.append(subTreeString);
                }
            }
        }
    }
    return build;
}

/*
 The way that the DBC file format works is kind of weird... For intel format signals you count up
from the start bit to the end bit which is (startbit + signallength - 1). At each point
bits are numbered in a sawtooth manner. What that means is that the very first bit is 0 and you count up
from there all of the way to 63 with each byte being 8 bits so bit 0 is the lowest bit in the first byte
and 8 is the lowest bit in the next byte up. The whole thing looks like this:
                 Bits
      7  6  5  4  3  2  1  0

  0   7  6  5  4  3  2  1  0
b 1   15 14 13 12 11 10 9  8
y 2   23 22 21 20 19 18 17 16
t 3   31 30 29 28 27 26 25 24
e 4   39 38 37 36 35 34 33 32
s 5   47 46 45 44 43 42 41 40
  6   55 54 53 52 51 50 49 48
  7   63 62 61 60 59 58 57 56

  For intel format you start at the start bit and keep counting up. If you have a signal size of 8
  and start at bit 12 then the bits are 12, 13, 14, 15, 16, 17, 18, 19 which spans across two bytes.
  In this format each bit is worth twice as much as the last and you just keep counting up.
  Bit 12 is worth 1, 13 is worth 2, 14 is worth 4, etc all of the way to bit 19 is worth 128.

  Motorola format turns most everything on its head. You count backward from the start bit but
  only within the current byte. If you are about to exit the current byte you go one higher and then keep
  going backward as before. Using the same example as for intel, start bit of 12 and a signal length of 8.
  So, the bits are 12, 11, 10, 9, 8, 23, 22, 21. Yes, that's confusing. They now go in reverse value order too.
  Bit 12 is worth 128, 11 is worth 64, etc until bit 21 is worth 1.
*/
bool DBC_SIGNAL::processAsText(const CANFrame &frame, QString &outString, bool outputName, bool outputUnit)
{
    int64_t result = 0;
    bool isSigned = false;
    bool isInteger = false;
    double endResult;

    //if (!isSignalInMessage(frame)) return false;

    if (valType == STRING)
    {
        QString buildString;
        int startByte = startBit / 8;
        int bytes = signalSize / 8;
        for (int x = 0; x < bytes; x++) buildString.append(frame.payload().data()[startByte + x]);
        outString = buildString;
        cachedValue = outString;
        return true;
    }

    if (valType == SIGNED_INT) isSigned = true;
    if (valType == SIGNED_INT || valType == UNSIGNED_INT)
    {
        result = Utility::processIntegerSignal(frame.payload(), startBit, signalSize, intelByteOrder, isSigned);
        endResult = ((double)result * factor) + bias;
        result = (int64_t)endResult;
        // if factor is an integer, we don't need the possibly human-unreadable float representation
        isInteger = (factor == qFloor(factor));
    }
    else if (valType == SP_FLOAT)
    {
        //The theory here is that we force the integer signal code to treat this as
        //a 32 bit unsigned integer. This integer is then cast into a float in such a way
        //that the bytes that make up the integer are instead treated as having made up
        //a 32 bit single precision float. That's evil incarnate but it is very fast and small
        //in terms of new code.
        result = Utility::processIntegerSignal(frame.payload(), startBit, 32, intelByteOrder, false);
        endResult = (*((float *)(&result)) * factor) + bias; //look away! This is awful. I don't even know for sure if it works. Should test that.
    }
    else //double precision float
    {
        if ( frame.payload().length() < 8 )
        {
            result = 0;
            return false;
        }
        //like the above, this is rotten and evil and wrong in so many ways. Force
        //calculation of a 64 bit integer and then cast it into a double.
        result = Utility::processIntegerSignal(frame.payload(), startBit, 64, intelByteOrder, false);
        endResult = (*((double *)(&result)) * factor) + bias;
    }

    outString = makePrettyOutput(endResult, result, outputName, isInteger, outputUnit);
    cachedValue = endResult;
    return true;
}

bool DBC_SIGNAL::getValueString(int64_t intVal, QString &outString)
{
    if (valList.count() > 0) //if this is a value list type then look it up and display the proper string
    {
        for (int x = 0; x < valList.count(); x++)
        {
            if (valList.at(x).value == intVal)
            {
                outString = valList.at(x).descript;
                return true;
            }
        }
    }
    return false;
}

QString DBC_SIGNAL::makePrettyOutput(double floatVal, int64_t intVal, bool outputName, bool isInteger, bool outputUnit)
{
    QString outputString;

    if (outputName) outputString = name + ": ";

    if (valList.count() > 0) //if this is a value list type then look it up and display the proper string
    {
        bool foundVal = false;
        for (int x = 0; x < valList.count(); x++)
        {
            if (valList.at(x).value == intVal)
            {
                outputString += valList.at(x).descript;
                foundVal = true;
                break;
            }
        }
        if (!foundVal) outputString += QString::number(intVal);
        if (outputUnit) outputString += " " + unitName;
    }
    else //otherwise display the actual number and unit (if it exists)
    {
       outputString += (isInteger ? QString::number(intVal) : QString::number(floatVal));
       if (outputUnit) outputString += " " + unitName;
    }
    return outputString;
}

//Works quite a bit like the above version but this one is cut down and only will return int32_t which is perfect for
//uses like calculating a multiplexor value or if you know you are going to get an integer returned
//from a signal and you want to use it as-is and not have to convert back from a string. Use with caution though
//as this basically assumes the signal is an integer.
//The call syntax is different from the more generic processSignal. Instead of returning the value we return
//true or false to show whether the function succeeded. The variable to fill out is passed by reference.
bool DBC_SIGNAL::processAsInt(const CANFrame &frame, int32_t &outValue)
{
    int32_t result = 0;
    bool isSigned = false;

    if (valType == STRING || valType == SP_FLOAT  || valType == DP_FLOAT)
    {
        return false;
    }

    //if (!isSignalInMessage(frame)) return false;

    if (valType == SIGNED_INT) isSigned = true;
    /*if ( static_cast<int>(frame.payload().length() * 8) <= (startBit + signalSize) )
    {
        result = 0;
        return false;
    }*/

    result = static_cast<int32_t>(Utility::processIntegerSignal(frame.payload(), startBit, signalSize, intelByteOrder, isSigned));

    double endResult = (result * factor) + bias;
    result = static_cast<int32_t>(endResult);
    cachedValue = result;
    outValue = result;
    return true;
}

//Another cut down version that will only return double precision data. This can be used on any of the types
//except STRING. Useful for when you know you'll need floating point data and don't want to incur a conversion
//back and forth to double or float. Such a use is the graphing window.
//Similar syntax to processSignalInt but with double instead.
bool DBC_SIGNAL::processAsDouble(const CANFrame &frame, double &outValue)
{
    int64_t result = 0;
    bool isSigned = false;
    double endResult;

    if (valType == STRING)
    {
        return false;
    }

    //if (!isSignalInMessage(frame)) return false;

    if (valType == SIGNED_INT) isSigned = true;
    if (valType == SIGNED_INT || valType == UNSIGNED_INT)
    {
        if ( frame.payload().length() * 8 < (startBit+signalSize) )
        {
            result = 0;
            return false;
        }
        result = Utility::processIntegerSignal(frame.payload(), startBit, signalSize, intelByteOrder, isSigned);
        endResult = ((double)result * factor) + bias;
        result = (int64_t)endResult;
    }
    /*TODO: It should be noted that the below floating point has not even been tested. For shame! Test it!*/
    else if (valType == SP_FLOAT)
    {
        if ( frame.payload().length() * 8 < (startBit + 32) )
        {
            result = 0;
            return false;
        }
        //The theory here is that we force the integer signal code to treat this as
        //a 32 bit unsigned integer. This integer is then cast into a float in such a way
        //that the bytes that make up the integer are instead treated as having made up
        //a 32 bit single precision float. That's evil incarnate but it is very fast and small
        //in terms of new code.
        result = Utility::processIntegerSignal(frame.payload(), startBit, 32, false, false);
        endResult = (*((float *)(&result)) * factor) + bias;
    }
    else //double precision float
    {
        if ( frame.payload().length() < 8 )
        {
            result = 0;
            return false;
        }
        //like the above, this is rotten and evil and wrong in so many ways. Force
        //calculation of a 64 bit integer and then cast it into a double.
        result = Utility::processIntegerSignal(frame.payload(), startBit, 64, false, false);
        endResult = (*((double *)(&result)) * factor) + bias;
    }
    cachedValue = endResult;
    outValue = endResult;
    return true;
}

DBC_ATTRIBUTE_VALUE *DBC_SIGNAL::findAttrValByName(QString name)
{
    if (attributes.length() == 0) return nullptr;
    for (int i = 0; i < attributes.length(); i++)
    {
        if (attributes[i].attrName.compare(name, Qt::CaseInsensitive) == 0)
        {
            return &attributes[i];
        }
    }
    return nullptr;
}

DBC_ATTRIBUTE_VALUE *DBC_SIGNAL::findAttrValByIdx(int idx)
{
    if (idx < 0) return nullptr;
    if (idx >= attributes.count()) return nullptr;
    return &attributes[idx];
}

DBC_ATTRIBUTE_VALUE *DBC_MESSAGE::findAttrValByName(QString name)
{
    if (attributes.length() == 0) return nullptr;
    for (int i = 0; i < attributes.length(); i++)
    {
        if (attributes[i].attrName.compare(name, Qt::CaseInsensitive) == 0)
        {
            return &attributes[i];
        }
    }
    return nullptr;
}

DBC_ATTRIBUTE_VALUE *DBC_MESSAGE::findAttrValByIdx(int idx)
{
    if (idx < 0) return nullptr;
    if (idx >= attributes.count()) return nullptr;
    return &attributes[idx];
}

DBC_ATTRIBUTE_VALUE *DBC_NODE::findAttrValByName(QString name)
{
    if (attributes.length() == 0) return nullptr;
    for (int i = 0; i < attributes.length(); i++)
    {
        if (attributes[i].attrName.compare(name, Qt::CaseInsensitive) == 0)
        {
            return &attributes[i];
        }
    }
    return nullptr;
}

DBC_ATTRIBUTE_VALUE *DBC_NODE::findAttrValByIdx(int idx)
{
    if (idx < 0) return nullptr;
    if (idx >= attributes.count()) return nullptr;
    return &attributes[idx];
}