tempo-plotter Changeset - b1d64d0822d2 · protofusion repositories

Changeset - b1d64d0822d2

Parent rev.

Child rev.

[Not reviewed]

default

0 4 0

Hasan Yavuz ÖZDERYA - 9 years ago 2017-04-01 12:41:24
hy@ozderya.net

add windows style line endings option for recording

4 files changed with 115 insertions and 60 deletions:

src/datarecorder.cpp

src/datarecorder.h

src/recordpanel.cpp

src/recordpanel.ui

0 comments (0 inline, 0 general)

src/datarecorder.cpp

➞

Show inline comments

@@ @@ -6,84 +6,90 @@ @@
   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
   (at your option) any later version.
   serialplot 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 serialplot.  If not, see <http://www.gnu.org/licenses/>.
 */
 #include "datarecorder.h"
 #include <QtDebug>
 DataRecorder::DataRecorder(QObject *parent) :
     QObject(parent),
     fileStream(&file)
+{
     lastNumChannels = 0;
     disableBuffering = false;
     windowsLE = false;
+}
 bool DataRecorder::startRecording(QString fileName, QString separator, QStringList channelNames)
+{
     Q_ASSERT(!file.isOpen());
     _sep =  separator;
     // open file
     file.setFileName(fileName);
     if (!file.open(QIODevice::WriteOnly))
+    {
         qCritical() << "Opening file " << fileName
                     << " for recording failed with error: " << file.error();
         return false;
+    }
     // write header line
     if (!channelNames.isEmpty())
+    {
         fileStream << channelNames.join(_sep);
-        fileStream << "\n";
+        fileStream << le();
         lastNumChannels = channelNames.length();
+    }
     return true;
+}
 void DataRecorder::addData(double* data, unsigned length, unsigned numOfChannels)
+{
     Q_ASSERT(length > 0);
     Q_ASSERT(length % numOfChannels == 0);
     if (lastNumChannels != 0 && numOfChannels != lastNumChannels)
+    {
         qWarning() << "Number of channels changed from " << lastNumChannels
                    << " to " << numOfChannels <<
             " during recording, CSV file is corrupted but no data will be lost.";
+    }
     lastNumChannels = numOfChannels;
     unsigned numOfSamples = length / numOfChannels; // per channel
     for (unsigned int i = 0; i < numOfSamples; i++)
+    {
         for (unsigned ci = 0; ci < numOfChannels; ci++)
+        {
             fileStream << data[ci * numOfSamples + i];
             if (ci != numOfChannels-1) fileStream << _sep;
+        }
-        fileStream << '\n';
+        fileStream << le();
+    }
     if (disableBuffering) fileStream.flush();
+}
 void DataRecorder::stopRecording()
+{
     Q_ASSERT(file.isOpen());
     file.close();
     lastNumChannels = 0;
+}
 const char* DataRecorder::le() const
+{
     return windowsLE ? "\r\n" : "\n";
+}

src/datarecorder.h

➞

Show inline comments

@@ @@ -13,65 +13,76 @@ @@
   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 serialplot.  If not, see <http://www.gnu.org/licenses/>.
 */
 #ifndef DATARECORDER_H
 #define DATARECORDER_H
 #include <QObject>
 #include <QFile>
 #include <QTextStream>
 class DataRecorder : public QObject
+{
     Q_OBJECT
 public:
     explicit DataRecorder(QObject *parent = 0);
     /// Disables file buffering
     bool disableBuffering;
     /**
      * Use CR+LF as line ending. `false` by default.
+     *
      * @note Toggling this variable during a recording will result in
      * a corrupted file. Care must be taken at higher (UI) levels.
      */
     bool windowsLE;
     /**
      * @brief Starts recording data to a file in CSV format.
+     *
      * File is opened and header line (names of channels) is written.
+     *
      * @param fileName name of the recording file
      * @param separator column separator
      * @param channelNames names of the channels for header line, if empty no header line is written
      * @return false if file operation fails (read only etc.)
      */
     bool startRecording(QString fileName, QString separator, QStringList channelNames);
     /**
      * @brief Adds data to a channel.
+     *
      * Multiple rows of data can be added at a time. Each channels
      * data should be ordered consecutively in the `data` array:
+     *
      * [CH0_SMP0, CH0_SMP1 ... CH0_SMPN, CH1_SMP0, CH1_SMP1, ... , CHN_SMPN]
+     *
      * If `numOfChannels` changes during recording, no data will be
      * lost (ie. it will be written to the file) but this will produce
      * an invalid CSV file. An error message will be written to the
      * console.
+     *
      * @param data samples array
      * @param length number of samples in `data`, must be multiple of `numOfChannels`
      * @param numOfChannels how many channels samples this data carries
      */
     void addData(double* data, unsigned length, unsigned numOfChannels);
     /// Stops recording, closes file.
     void stopRecording();
 private:
     unsigned lastNumChannels;   ///< used for error message only
     QFile file;
     QTextStream fileStream;
     QString _sep;
     /// Returns the selected line ending.
     const char* le() const;
 };
 #endif // DATARECORDER_H

src/recordpanel.cpp

➞

Show inline comments

@@ @@ -39,48 +39,56 @@ RecordPanel::RecordPanel(DataRecorder* r @@
     _recorder = recorder;
     _channelMan = channelMan;
     ui->setupUi(this);
     recordToolBar.setObjectName("tbRecord");
     recordAction.setCheckable(true);
     recordToolBar.addAction(&recordAction);
     ui->pbRecord->setDefaultAction(&recordAction);
     connect(ui->pbBrowse, &QPushButton::clicked,
             this, &RecordPanel::selectFile);
     connect(&recordAction, &QAction::triggered,
             this, &RecordPanel::onRecord);
     connect(ui->cbRecordPaused, SIGNAL(toggled(bool)),
             this, SIGNAL(recordPausedChanged(bool)));
     connect(ui->cbDisableBuffering, &QCheckBox::toggled,
             [this](bool enabled)
+            {
                 _recorder->disableBuffering = enabled;
             });
     connect(ui->cbWindowsLE, &QCheckBox::toggled,
             [this](bool enabled)
+            {
                 _recorder->windowsLE = enabled;
             });
     connect(&recordAction, &QAction::toggled, ui->cbWindowsLE, &QWidget::setDisabled);
+}
 RecordPanel::~RecordPanel()
+{
     delete ui;
+}
 QToolBar* RecordPanel::toolbar()
+{
     return &recordToolBar;
+}
 bool RecordPanel::isRecording()
+{
     return recordAction.isChecked();
+}
 bool RecordPanel::recordPaused()
+{
     return ui->cbRecordPaused->isChecked();
+}
 bool RecordPanel::selectFile()
+{

src/recordpanel.ui

➞

Show inline comments

 <?xml version="1.0" encoding="UTF-8"?>
 <ui version="4.0">
  <class>RecordPanel</class>
  <widget class="QWidget" name="RecordPanel">
   <property name="geometry">
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>532</width>
+    <width>627</width>
     <height>261</height>
    </rect>
   </property>
   <property name="windowTitle">
    <string>Form</string>
   </property>
   <layout class="QHBoxLayout" name="horizontalLayout_2">
    <item>
     <layout class="QVBoxLayout" name="verticalLayout">
      <item>
       <layout class="QHBoxLayout" name="horizontalLayout">
        <item>
         <widget class="QPushButton" name="pbBrowse">
          <property name="toolTip">
           <string>Select record file</string>
          </property>
          <property name="text">
           <string>Browse</string>
          </property>
         </widget>
        </item>
        <item>
         <widget class="QLabel" name="lbFileName">
          <property name="sizePolicy">
           <sizepolicy hsizetype="MinimumExpanding" vsizetype="Preferred">
            <horstretch>0</horstretch>
            <verstretch>0</verstretch>
           </sizepolicy>
          </property>
          <property name="text">
           <string>Select file...</string>
          </property>
         </widget>
        </item>
       </layout>
      </item>
      <item>
       <widget class="QCheckBox" name="cbAutoIncrement">
        <property name="toolTip">
         <string>Increments file name automatically everytime a new recording starts</string>
        </property>
        <property name="text">
         <string>Auto increment file name</string>
        </property>
        <property name="checked">
         <bool>true</bool>
        </property>
       </widget>
      </item>
      <item>
       <widget class="QCheckBox" name="cbRecordPaused">
        <property name="toolTip">
         <string>Continue recording to file even when plotting is paused</string>
        </property>
        <property name="text">
         <string>Record while paused</string>
        </property>
        <property name="checked">
         <bool>true</bool>
        </property>
       </widget>
      </item>
      <item>
       <widget class="QCheckBox" name="cbStopOnClose">
        <property name="text">
         <string>Stop recording when port closed</string>
        </property>
        <property name="checked">
         <bool>true</bool>
        </property>
       </widget>
      </item>
      <item>
       <widget class="QCheckBox" name="cbHeader">
        <property name="toolTip">
         <string>Channel names are written to the first line of record file</string>
        </property>
        <property name="text">
         <string>Write header line</string>
        </property>
        <property name="checked">
         <bool>true</bool>
        </property>
       </widget>
       <layout class="QGridLayout" name="gridLayout">
        <item row="1" column="1">
         <widget class="QCheckBox" name="cbHeader">
          <property name="toolTip">
           <string>Channel names are written to the first line of record file</string>
          </property>
          <property name="text">
           <string>Write header line</string>
          </property>
          <property name="checked">
           <bool>true</bool>
          </property>
         </widget>
        </item>
        <item row="2" column="0">
         <widget class="QCheckBox" name="cbRecordPaused">
          <property name="toolTip">
           <string>Continue recording to file even when plotting is paused</string>
          </property>
          <property name="text">
           <string>Record while paused</string>
          </property>
          <property name="checked">
           <bool>true</bool>
          </property>
         </widget>
        </item>
        <item row="3" column="0">
         <widget class="QCheckBox" name="cbDisableBuffering">
          <property name="toolTip">
           <string>Do not buffer when writing to file. Check this if you are using other software to open the file during recording.</string>
          </property>
          <property name="text">
           <string>Disable buffering</string>
          </property>
         </widget>
        </item>
        <item row="2" column="1">
         <widget class="QCheckBox" name="cbStopOnClose">
          <property name="text">
           <string>Stop recording when port closed</string>
          </property>
          <property name="checked">
           <bool>true</bool>
          </property>
         </widget>
        </item>
        <item row="1" column="0">
         <widget class="QCheckBox" name="cbAutoIncrement">
          <property name="toolTip">
           <string>Increments file name automatically everytime a new recording starts</string>
          </property>
          <property name="text">
           <string>Auto increment file name</string>
          </property>
          <property name="checked">
           <bool>true</bool>
          </property>
         </widget>
        </item>
        <item row="3" column="1">
         <widget class="QCheckBox" name="cbWindowsLE">
          <property name="toolTip">
           <string>Use CR+LF as line endings. Some windows software may not show lines correctly otherwise. Can't be changed during recording.</string>
          </property>
          <property name="text">
           <string>Windows Style Line Endings</string>
          </property>
          <property name="checked">
           <bool>false</bool>
          </property>
         </widget>
        </item>
        <item row="1" column="2">
         <spacer name="horizontalSpacer_2">
          <property name="orientation">
           <enum>Qt::Horizontal</enum>
          </property>
          <property name="sizeHint" stdset="0">
           <size>
            <width>1</width>
            <height>20</height>
           </size>
          </property>
         </spacer>
        </item>
       </layout>
      </item>
      <item>
       <layout class="QHBoxLayout" name="horizontalLayout_3">
        <item>
         <widget class="QLabel" name="label">
          <property name="text">
           <string>Column Separator:</string>
          </property>
         </widget>
        </item>
        <item>
         <widget class="QLineEdit" name="leSeparator">
          <property name="maximumSize">
           <size>
            <width>30</width>
            <height>16777215</height>
           </size>
          </property>
          <property name="toolTip">
           <string>For TAB character enter \t</string>
          </property>
          <property name="text">
           <string>,</string>
          </property>
         </widget>
        </item>
        <item>
         <spacer name="horizontalSpacer">
          <property name="orientation">
           <enum>Qt::Horizontal</enum>
          </property>
          <property name="sizeHint" stdset="0">
           <size>
            <width>40</width>
            <height>20</height>
           </size>
          </property>
         </spacer>
        </item>
       </layout>
      </item>
      <item>
       <widget class="QCheckBox" name="cbDisableBuffering">
        <property name="toolTip">
         <string>Do not buffer when writing to file. Check this if you are using other software to open the file during recording.</string>
        </property>
        <property name="text">
         <string>Disable buffering</string>
        </property>
       </widget>
      </item>
      <item>
       <spacer name="verticalSpacer">
        <property name="orientation">
         <enum>Qt::Vertical</enum>
        </property>
        <property name="sizeHint" stdset="0">
         <size>
          <width>20</width>
          <height>1</height>
         </size>
        </property>
       </spacer>
      </item>
     </layout>
    </item>
    <item>
     <layout class="QVBoxLayout" name="verticalLayout_2">
      <item>
       <widget class="QToolButton" name="pbRecord">
        <property name="minimumSize">
         <size>
          <width>85</width>
          <height>50</height>
         </size>
        </property>

0 comments (0 inline, 0 general)