tempo-plotter Changeset - 5c809411253d · protofusion repositories

Changeset - 5c809411253d

Parent rev.

Child rev.

[Not reviewed]

stream

0 4 0

Hasan Yavuz ÖZDERYA - 7 years ago 2018-04-08 13:28:06
hy@ozderya.net

added reworked FramedReader with basic tests

4 files changed with 69 insertions and 25 deletions:

src/framedreader.cpp

src/framedreader.h

tests/CMakeLists.txt

tests/test_readers.cpp

0 comments (0 inline, 0 general)

src/framedreader.cpp

➞

Show inline comments

 /*
-  Copyright © 2017 Hasan Yavuz Özderya
+  Copyright © 2018 Hasan Yavuz Özderya
   This file is part of serialplot.
   serialplot 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
@@ @@ -20,21 +20,20 @@ @@
 #include <QtDebug>
 #include <QtEndian>
 #include "floatswap.h"
 #include "framedreader.h"
 FramedReader::FramedReader(QIODevice* device, ChannelManager* channelMan,
                            DataRecorder* recorder, QObject* parent) :
     AbstractReader(device, channelMan, recorder, parent)
 FramedReader::FramedReader(QIODevice* device, QObject* parent) :
     AbstractReader(device, parent)
+{
     paused = false;
     // initial settings
     settingsInvalid = 0;
-    _numOfChannels = _settingsWidget.numOfChannels();
+    _numChannels = _settingsWidget.numOfChannels();
     hasSizeByte = _settingsWidget.frameSize() == 0;
     frameSize = _settingsWidget.frameSize();
     syncWord = _settingsWidget.syncWord();
     checksumEnabled = _settingsWidget.isChecksumEnabled();
     onNumberFormatChanged(_settingsWidget.numberFormat());
     debugModeEnabled = _settingsWidget.isDebugModeEnabled();
@@ @@ -70,23 +69,24 @@ void FramedReader::enable(bool enabled) @@
         connect(_device, &QIODevice::readyRead,
                 this, &FramedReader::onDataReady);
+    }
     else
+    {
         QObject::disconnect(_device, 0, this, 0);
         disconnectSinks();
+    }
+}
 QWidget* FramedReader::settingsWidget()
+{
     return &_settingsWidget;
+}
-unsigned FramedReader::numOfChannels()
+unsigned FramedReader::numChannels() const
+{
-    return _numOfChannels;
+    return _numChannels;
+}
 void FramedReader::pause(bool enabled)
+{
     paused = enabled;
+}
@@ @@ -142,13 +142,13 @@ void FramedReader::checkSettings() @@
     else // sync word is valid
+    {
         settingsInvalid &= ~SYNCWORD_INVALID;
+    }
     // check if fixed frame size is multiple of a sample set size
-    if (!hasSizeByte && frameSize % (_numOfChannels * sampleSize) != 0)
+    if (!hasSizeByte && frameSize % (_numChannels * sampleSize) != 0)
+    {
         settingsInvalid |= FRAMESIZE_INVALID;
+    }
     else
+    {
         settingsInvalid &= ~FRAMESIZE_INVALID;
@@ @@ -160,25 +160,25 @@ void FramedReader::checkSettings() @@
         _settingsWidget.showMessage("Sync word is invalid!", true);
+    }
     else if (settingsInvalid & FRAMESIZE_INVALID)
+    {
         QString errorMessage =
             QString("Frame size must be multiple of %1 (#channels * sample size)!")\
-            .arg(_numOfChannels * sampleSize);
+            .arg(_numChannels * sampleSize);
         _settingsWidget.showMessage(errorMessage, true);
+    }
     else
+    {
         _settingsWidget.showMessage("All is well!");
+    }
+}
 void FramedReader::onNumOfChannelsChanged(unsigned value)
+{
-    _numOfChannels = value;
+    _numChannels = value;
     checkSettings();
     reset();
     emit numOfChannelsChanged(value);
+}
 void FramedReader::onSyncWordChanged(QByteArray word)
@@ @@ -235,17 +235,17 @@ void FramedReader::onDataReady() @@
             if (frameSize == 0) // check size
+            {
                 qCritical() << "Frame size is 0!";
                 reset();
+            }
-            else if (frameSize % (_numOfChannels * sampleSize) != 0)
+            else if (frameSize % (_numChannels * sampleSize) != 0)
+            {
                 qCritical() <<
                     QString("Frame size is not multiple of %1 (#channels * sample size)!") \
-                    .arg(_numOfChannels * sampleSize);
+                    .arg(_numChannels * sampleSize);
                 reset();
+            }
             else
+            {
                 if (debugModeEnabled) qDebug() << "Frame size:" << frameSize;
                 gotSize = true;
@@ @@ -284,20 +284,19 @@ void FramedReader::readFrameDataAndCheck @@
+    {
         _device->read((checksumEnabled ? frameSize+1 : frameSize));
         return;
+    }
     // a package is 1 set of samples for all channels
     unsigned numOfPackagesToRead = frameSize / (_numOfChannels * sampleSize);
     double* channelSamples = new double[numOfPackagesToRead * _numOfChannels];
     unsigned numOfPackagesToRead = frameSize / (_numChannels * sampleSize);
     SamplePack samples(numOfPackagesToRead, _numChannels);
     for (unsigned i = 0; i < numOfPackagesToRead; i++)
+    {
-        for (unsigned int ci = 0; ci < _numOfChannels; ci++)
+        for (unsigned int ci = 0; ci < _numChannels; ci++)
+        {
-            channelSamples[ci*numOfPackagesToRead+i] = (this->*readSample)();
+            samples.data(ci)[i] = (this->*readSample)();
+        }
+    }
     // read checksum
     unsigned rChecksum = 0;
     bool checksumPassed = false;
@@ @@ -308,20 +307,18 @@ void FramedReader::readFrameDataAndCheck @@
         checksumPassed = (calcChecksum == rChecksum);
+    }
     if (!checksumEnabled || checksumPassed)
+    {
         // commit data
-        addData(channelSamples, numOfPackagesToRead*_numOfChannels);
+        feedOut(samples);
+    }
     else
+    {
         qCritical() << "Checksum failed! Received:" << rChecksum << "Calculated:" << calcChecksum;
+    }
     delete[] channelSamples;
+}
 template<typename T> double FramedReader::readSampleAs()
+{
     T data;

src/framedreader.h

➞

Show inline comments

 /*
-  Copyright © 2017 Hasan Yavuz Özderya
+  Copyright © 2018 Hasan Yavuz Özderya
   This file is part of serialplot.
   serialplot 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
@@ @@ -30,16 +30,15 @@ @@
  */
 class FramedReader : public AbstractReader
+{
     Q_OBJECT
 public:
     explicit FramedReader(QIODevice* device, ChannelManager* channelMan,
                           DataRecorder* recorder, QObject *parent = 0);
     explicit FramedReader(QIODevice* device, QObject *parent = 0);
     QWidget* settingsWidget();
-    unsigned numOfChannels();
+    unsigned numChannels() const;
     void enable(bool enabled = true);
     /// Stores settings into a `QSettings`
     void saveSettings(QSettings* settings);
     /// Loads settings from a `QSettings`.
     void loadSettings(QSettings* settings);
@@ @@ -53,13 +52,13 @@ private: @@
         SYNCWORD_INVALID = 1,
         FRAMESIZE_INVALID = 2
     };
     // settings related members
     FramedReaderSettings _settingsWidget;
-    unsigned _numOfChannels;
+    unsigned _numChannels;
     unsigned sampleSize;
     bool paused;
     unsigned settingsInvalid;   /// settings are all valid if this is 0, if not no reading is done
     QByteArray syncWord;
     bool checksumEnabled;
     bool hasSizeByte;

tests/CMakeLists.txt

➞

Show inline comments

@@ @@ -40,12 +40,13 @@ add_executable(Test EXCLUDE_FROM_ALL @@
 add_test(NAME test1 COMMAND Test)
 qt5_use_modules(Test Widgets)
 qt5_wrap_ui(UI_FILES_T
   ../src/binarystreamreadersettings.ui
   ../src/asciireadersettings.ui
   ../src/framedreadersettings.ui
   ../src/numberformatbox.ui
   ../src/endiannessbox.ui
+  )
 # test for readers
 add_executable(TestReaders EXCLUDE_FROM_ALL
@@ @@ -55,12 +56,15 @@ add_executable(TestReaders EXCLUDE_FROM_ @@
   ../src/source.cpp
   ../src/abstractreader.cpp
   ../src/binarystreamreader.cpp
   ../src/binarystreamreadersettings.cpp
   ../src/asciireader.cpp
   ../src/asciireadersettings.cpp
   ../src/framedreader.cpp
   ../src/framedreadersettings.cpp
   ../src/commandedit.cpp
   ../src/endiannessbox.cpp
   ../src/numberformatbox.cpp
   ../src/numberformat.cpp
   ${UI_FILES_T}
+  )
 qt5_use_modules(TestReaders Widgets Test)

tests/test_readers.cpp

➞

Show inline comments

@@ @@ -22,12 +22,13 @@ @@
 #include "catch.hpp"
 #include <QSignalSpy>
 #include <QBuffer>
 #include "binarystreamreader.h"
 #include "asciireader.h"
 #include "framedreader.h"
 #include "test_helpers.h"
 static const int READYREAD_TIMEOUT = 10; // milliseconds
 TEST_CASE("reading data with BinaryStreamReader", "[reader]")
@@ @@ -118,12 +119,55 @@ TEST_CASE("AsciiReader shouldn't read wh @@
     REQUIRE_FALSE(spy.wait(READYREAD_TIMEOUT));
     REQUIRE(sink._numChannels == 1);
     REQUIRE(sink._hasX == false);
     REQUIRE(sink.totalFed == 0);
+}
 TEST_CASE("reading data with FramedReader", "[reader]")
+{
     QBuffer bufferDev;
     FramedReader reader(&bufferDev);
     reader.enable(true);
     TestSink sink;
     reader.connectSink(&sink);
     REQUIRE(sink._numChannels == 1);
     REQUIRE(sink._hasX == false);
     bufferDev.open(QIODevice::ReadWrite);
     const uint8_t data[] = {0xAA, 0xBB, 4, 0x01, 0x02, 0x03, 0x04};
     bufferDev.write((const char*) data, 7);
     bufferDev.seek(0);
     QSignalSpy spy(&bufferDev, SIGNAL(readyRead()));
     REQUIRE(spy.wait(READYREAD_TIMEOUT));
     REQUIRE(sink.totalFed == 4);
+}
 TEST_CASE("FramedReader shouldn't read when disabled", "[reader]")
+{
     QBuffer bufferDev;
     FramedReader reader(&bufferDev);
     TestSink sink;
     reader.connectSink(&sink);
     REQUIRE(sink._numChannels == 1);
     REQUIRE(sink._hasX == false);
     bufferDev.open(QIODevice::ReadWrite);
     const uint8_t data[] = {0xAA, 0xBB, 4, 0x01, 0x02, 0x03, 0x04};
     bufferDev.write((const char*) data, 7);
     bufferDev.seek(0);
     QSignalSpy spy(&bufferDev, SIGNAL(readyRead()));
     REQUIRE_FALSE(spy.wait(READYREAD_TIMEOUT));
     REQUIRE(sink.totalFed == 0);
+}
 // Note: this is added because `QApplication` must be created for widgets
 #include <QApplication>
 int main(int argc, char* argv[])
+{
     QApplication a(argc, argv);

0 comments (0 inline, 0 general)