HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Commit - r605:06b66012b93b

(Refactoring) Renames IDataSeries::subData()

Alexandre Leroux -

r605:06b66012b93b

parent child

Context file:

r605:06b66012b93b

Collapse all files

core/include/Data/DataSeries.h +10 -11

             #ifndef SCIQLOP_DATASERIES_H
             #define SCIQLOP_DATASERIES_H
             #include "CoreGlobal.h"
             #include <Common/SortUtils.h>
             #include <Data/ArrayData.h>
             #include <Data/IDataSeries.h>
             #include <QLoggingCategory>
             #include <QReadLocker>
             #include <QReadWriteLock>
             #include <memory>
             // We don't use the Qt macro since the log is used in the header file, which causes multiple log
             // definitions with inheritance. Inline method is used instead
             inline const QLoggingCategory &LOG_DataSeries()
             {
                 static const QLoggingCategory category{"DataSeries"};
                 return category;
             }
             template <int Dim>
             class DataSeries;
             namespace dataseries_detail {
             template <int Dim>
             class IteratorValue : public DataSeriesIteratorValue::Impl {
             public:
                 explicit IteratorValue(const DataSeries<Dim> &dataSeries, bool begin)
                         : m_XIt(begin ? dataSeries.xAxisData()->cbegin() : dataSeries.xAxisData()->cend()),
                           m_ValuesIt(begin ? dataSeries.valuesData()->cbegin()
                                            : dataSeries.valuesData()->cend())
                 {
                 }
                 IteratorValue(const IteratorValue &other) = default;
                 std::unique_ptr<DataSeriesIteratorValue::Impl> clone() const override
                 {
                     return std::make_unique<IteratorValue<Dim> >(*this);
                 }
                 bool equals(const DataSeriesIteratorValue::Impl &other) const override try {
                     const auto &otherImpl = dynamic_cast<const IteratorValue &>(other);
                     return std::tie(m_XIt, m_ValuesIt) == std::tie(otherImpl.m_XIt, otherImpl.m_ValuesIt);
                 }
                 catch (const std::bad_cast &) {
                     return false;
                 }
                 void next() override
                 {
                     ++m_XIt;
                     ++m_ValuesIt;
                 }
                 void prev() override
                 {
                     --m_XIt;
                     --m_ValuesIt;
                 }
                 double x() const override { return m_XIt->at(0); }
                 double value() const override { return m_ValuesIt->at(0); }
                 double value(int componentIndex) const override { return m_ValuesIt->at(componentIndex); }
             private:
                 ArrayData<1>::Iterator m_XIt;
                 typename ArrayData<Dim>::Iterator m_ValuesIt;
             };
             } // namespace dataseries_detail
             /**
              * @brief The DataSeries class is the base (abstract) implementation of IDataSeries.
              *
              * It proposes to set a dimension for the values data.
              *
              * A DataSeries is always sorted on its x-axis data.
              *
              * @tparam Dim The dimension of the values data
              *
              */
             template <int Dim>
             class SCIQLOP_CORE_EXPORT DataSeries : public IDataSeries {
             public:
                 /// @sa IDataSeries::xAxisData()
                 std::shared_ptr<ArrayData<1> > xAxisData() override { return m_XAxisData; }
                 const std::shared_ptr<ArrayData<1> > xAxisData() const { return m_XAxisData; }
                 /// @sa IDataSeries::xAxisUnit()
                 Unit xAxisUnit() const override { return m_XAxisUnit; }
                 /// @return the values dataset
                 std::shared_ptr<ArrayData<Dim> > valuesData() { return m_ValuesData; }
                 const std::shared_ptr<ArrayData<Dim> > valuesData() const { return m_ValuesData; }
                 /// @sa IDataSeries::valuesUnit()
                 Unit valuesUnit() const override { return m_ValuesUnit; }
                 SqpRange range() const override
                 {
                     if (!m_XAxisData->cdata().isEmpty()) {
                         return SqpRange{m_XAxisData->cdata().first(), m_XAxisData->cdata().last()};
                     }
                     return SqpRange{};
                 }
                 void clear()
                 {
                     m_XAxisData->clear();
                     m_ValuesData->clear();
                 }
                 /// Merges into the data series an other data series
                 /// @remarks the data series to merge with is cleared after the operation
                 void merge(IDataSeries *dataSeries) override
                 {
                     dataSeries->lockWrite();
                     lockWrite();
                     if (auto other = dynamic_cast<DataSeries<Dim> *>(dataSeries)) {
                         const auto &otherXAxisData = other->xAxisData()->cdata();
                         const auto &xAxisData = m_XAxisData->cdata();
                         // As data series are sorted, we can improve performances of merge, by call the sort
                         // method only if the two data series overlap.
                         if (!otherXAxisData.empty()) {
                             auto firstValue = otherXAxisData.front();
                             auto lastValue = otherXAxisData.back();
                             auto xAxisDataBegin = xAxisData.cbegin();
                             auto xAxisDataEnd = xAxisData.cend();
                             bool prepend;
                             bool sortNeeded;
                             if (std::lower_bound(xAxisDataBegin, xAxisDataEnd, firstValue) == xAxisDataEnd) {
                                 // Other data series if after data series
                                 prepend = false;
                                 sortNeeded = false;
                             }
                             else if (std::upper_bound(xAxisDataBegin, xAxisDataEnd, lastValue)
                                      == xAxisDataBegin) {
                                 // Other data series if before data series
                                 prepend = true;
                                 sortNeeded = false;
                             }
                             else {
                                 // The two data series overlap
                                 prepend = false;
                                 sortNeeded = true;
                             }
                             // Makes the merge
                             m_XAxisData->add(*other->xAxisData(), prepend);
                             m_ValuesData->add(*other->valuesData(), prepend);
                             if (sortNeeded) {
                                 sort();
                             }
                         }
                         // Clears the other data series
                         other->clear();
                     }
                     else {
                         qCWarning(LOG_DataSeries())
                             << QObject::tr("Detection of a type of IDataSeries we cannot merge with !");
                     }
                     unlock();
                     dataSeries->unlock();
                 }
                 // ///////// //
                 // Iterators //
                 // ///////// //
                 DataSeriesIterator cbegin() const override
                 {
                     return DataSeriesIterator{DataSeriesIteratorValue{
                         std::make_unique<dataseries_detail::IteratorValue<Dim> >(*this, true)}};
                 }
                 DataSeriesIterator cend() const override
                 {
                     return DataSeriesIterator{DataSeriesIteratorValue{
                         std::make_unique<dataseries_detail::IteratorValue<Dim> >(*this, false)}};
                 }
                 /// @sa IDataSeries::minXAxisData()
                 DataSeriesIterator minXAxisData(double minXAxisData) const override
                 {
                     return std::lower_bound(
                         cbegin(), cend(), minXAxisData,
                         [](const auto &itValue, const auto &value) { return itValue.x() < value; });
                 }
                 /// @sa IDataSeries::maxXAxisData()
                 DataSeriesIterator maxXAxisData(double maxXAxisData) const override
                 {
                     // Gets the first element that greater than max value
                     auto it = std::upper_bound(
                         cbegin(), cend(), maxXAxisData,
                         [](const auto &value, const auto &itValue) { return value < itValue.x(); });
                     return it == cbegin() ? cend() : --it;
                 }
-                std::pair<DataSeriesIterator, DataSeriesIterator> subData(double min, double max) const override
+                std::pair<DataSeriesIterator, DataSeriesIterator> xAxisRange(double minXAxisData,
+                                                                             double maxXAxisData) const override
                 {
-                    if (min > max) {
+                    if (minXAxisData > maxXAxisData) {
-                        std::swap(min, max);
+                        std::swap(minXAxisData, maxXAxisData);
                     }
                     auto begin = cbegin();
                     auto end = cend();
-                    auto lowerIt
+                    auto lowerIt = std::lower_bound(
-                        = std::lower_bound(begin, end, min, [](const auto &itValue, const auto &value) {
+                        begin, end, minXAxisData,
-                              return itValue.x() < value;
+                        [](const auto &itValue, const auto &value) { return itValue.x() < value; });
-                          });
+                    auto upperIt = std::upper_bound(
-                    auto upperIt
+                        begin, end, maxXAxisData,
-                        = std::upper_bound(begin, end, max, [](const auto &value, const auto &itValue) {
+                        [](const auto &value, const auto &itValue) { return value < itValue.x(); });
-                              return value < itValue.x();
-                          });
                     return std::make_pair(lowerIt, upperIt);
                 }
                 // /////// //
                 // Mutexes //
                 // /////// //
                 virtual void lockRead() { m_Lock.lockForRead(); }
                 virtual void lockWrite() { m_Lock.lockForWrite(); }
                 virtual void unlock() { m_Lock.unlock(); }
             protected:
                 /// Protected ctor (DataSeries is abstract). The vectors must have the same size, otherwise a
                 /// DataSeries with no values will be created.
                 /// @remarks data series is automatically sorted on its x-axis data
                 explicit DataSeries(std::shared_ptr<ArrayData<1> > xAxisData, const Unit &xAxisUnit,
                                     std::shared_ptr<ArrayData<Dim> > valuesData, const Unit &valuesUnit)
                         : m_XAxisData{xAxisData},
                           m_XAxisUnit{xAxisUnit},
                           m_ValuesData{valuesData},
                           m_ValuesUnit{valuesUnit}
                 {
                     if (m_XAxisData->size() != m_ValuesData->size()) {
                         clear();
                     }
                     // Sorts data if it's not the case
                     const auto &xAxisCData = m_XAxisData->cdata();
                     if (!std::is_sorted(xAxisCData.cbegin(), xAxisCData.cend())) {
                         sort();
                     }
                 }
                 /// Copy ctor
                 explicit DataSeries(const DataSeries<Dim> &other)
                         : m_XAxisData{std::make_shared<ArrayData<1> >(*other.m_XAxisData)},
                           m_XAxisUnit{other.m_XAxisUnit},
                           m_ValuesData{std::make_shared<ArrayData<Dim> >(*other.m_ValuesData)},
                           m_ValuesUnit{other.m_ValuesUnit}
                 {
                     // Since a series is ordered from its construction and is always ordered, it is not
                     // necessary to call the sort method here ('other' is sorted)
                 }
                 /// Assignment operator
                 template <int D>
                 DataSeries &operator=(DataSeries<D> other)
                 {
                     std::swap(m_XAxisData, other.m_XAxisData);
                     std::swap(m_XAxisUnit, other.m_XAxisUnit);
                     std::swap(m_ValuesData, other.m_ValuesData);
                     std::swap(m_ValuesUnit, other.m_ValuesUnit);
                     return *this;
                 }
             private:
                 /**
                  * Sorts data series on its x-axis data
                  */
                 void sort() noexcept
                 {
                     auto permutation = SortUtils::sortPermutation(*m_XAxisData, std::less<double>());
                     m_XAxisData = m_XAxisData->sort(permutation);
                     m_ValuesData = m_ValuesData->sort(permutation);
                 }
                 std::shared_ptr<ArrayData<1> > m_XAxisData;
                 Unit m_XAxisUnit;
                 std::shared_ptr<ArrayData<Dim> > m_ValuesData;
                 Unit m_ValuesUnit;
                 QReadWriteLock m_Lock;
             };
             #endif // SCIQLOP_DATASERIES_H

core/include/Data/IDataSeries.h +4 -2

             #ifndef SCIQLOP_IDATASERIES_H
             #define SCIQLOP_IDATASERIES_H
             #include <Common/MetaTypes.h>
             #include <Data/DataSeriesIterator.h>
             #include <Data/SqpRange.h>
             #include <memory>
             #include <QString>
             template <int Dim>
             class ArrayData;
             struct Unit {
                 explicit Unit(const QString &name = {}, bool timeUnit = false)
                         : m_Name{name}, m_TimeUnit{timeUnit}
                 {
                 }
                 inline bool operator==(const Unit &other) const
                 {
                     return std::tie(m_Name, m_TimeUnit) == std::tie(other.m_Name, other.m_TimeUnit);
                 }
                 inline bool operator!=(const Unit &other) const { return !(*this == other); }
                 QString m_Name;  ///< Unit name
                 bool m_TimeUnit; ///< The unit is a unit of time (UTC)
             };
             /**
              * @brief The IDataSeries aims to declare a data series.
              *
              * A data series is an entity that contains at least :
              * - one dataset representing the x-axis
              * - one dataset representing the values
              *
              * Each dataset is represented by an ArrayData, and is associated with a unit.
              *
              * An ArrayData can be unidimensional or two-dimensional, depending on the implementation of the
              * IDataSeries. The x-axis dataset is always unidimensional.
              *
              * @sa ArrayData
              */
             class IDataSeries {
             public:
                 virtual ~IDataSeries() noexcept = default;
                 /// Returns the x-axis dataset
                 virtual std::shared_ptr<ArrayData<1> > xAxisData() = 0;
                 /// Returns the x-axis dataset (as const)
                 virtual const std::shared_ptr<ArrayData<1> > xAxisData() const = 0;
                 virtual Unit xAxisUnit() const = 0;
                 virtual Unit valuesUnit() const = 0;
                 virtual void merge(IDataSeries *dataSeries) = 0;
                 /// @todo Review the name and signature of this method
                 virtual std::shared_ptr<IDataSeries> subDataSeries(const SqpRange &range) = 0;
                 virtual std::unique_ptr<IDataSeries> clone() const = 0;
                 virtual SqpRange range() const = 0;
                 // ///////// //
                 // Iterators //
                 // ///////// //
                 virtual DataSeriesIterator cbegin() const = 0;
                 virtual DataSeriesIterator cend() const = 0;
                 /// @return the iterator to the first entry of the data series whose x-axis data is greater than
                 /// or equal to the value passed in parameter, or the end iterator if there is no matching value
                 virtual DataSeriesIterator minXAxisData(double minXAxisData) const = 0;
                 /// @return the iterator to the last entry of the data series whose x-axis data is less than or
                 /// equal to the value passed in parameter, or the end iterator if there is no matching value
                 virtual DataSeriesIterator maxXAxisData(double maxXAxisData) const = 0;
-                virtual std::pair<DataSeriesIterator, DataSeriesIterator> subData(double min,
+                /// @return the iterators pointing to the range of data whose x-axis values are between min and
-                                                                                  double max) const = 0;
+                /// max passed in parameters
+                virtual std::pair<DataSeriesIterator, DataSeriesIterator>
+                xAxisRange(double minXAxisData, double maxXAxisData) const = 0;
                 // /////// //
                 // Mutexes //
                 // /////// //
                 virtual void lockRead() = 0;
                 virtual void lockWrite() = 0;
                 virtual void unlock() = 0;
             };
             // Required for using shared_ptr in signals/slots
             SCIQLOP_REGISTER_META_TYPE(IDATASERIES_PTR_REGISTRY, std::shared_ptr<IDataSeries>)
             #endif // SCIQLOP_IDATASERIES_H

core/src/Data/ScalarSeries.cpp +1 -1

             #include <Data/ScalarSeries.h>
             ScalarSeries::ScalarSeries(QVector<double> xAxisData, QVector<double> valuesData,
                                        const Unit &xAxisUnit, const Unit &valuesUnit)
                     : DataSeries{std::make_shared<ArrayData<1> >(std::move(xAxisData)), xAxisUnit,
                                  std::make_shared<ArrayData<1> >(std::move(valuesData)), valuesUnit}
             {
             }
             std::unique_ptr<IDataSeries> ScalarSeries::clone() const
             {
                 return std::make_unique<ScalarSeries>(*this);
             }
             std::shared_ptr<IDataSeries> ScalarSeries::subDataSeries(const SqpRange &range)
             {
                 auto subXAxisData = QVector<double>();
                 auto subValuesData = QVector<double>();
                 this->lockRead();
                 {
-                    auto bounds = subData(range.m_TStart, range.m_TEnd);
+                    auto bounds = xAxisRange(range.m_TStart, range.m_TEnd);
                     for (auto it = bounds.first; it != bounds.second; ++it) {
                         subXAxisData.append(it->x());
                         subValuesData.append(it->value());
                     }
                 }
                 this->unlock();
                 return std::make_shared<ScalarSeries>(subXAxisData, subValuesData, this->xAxisUnit(),
                                                       this->valuesUnit());
             }

core/src/Data/VectorSeries.cpp +1 -1

             #include "Data/VectorSeries.h"
             VectorSeries::VectorSeries(QVector<double> xAxisData, QVector<double> xValuesData,
                                        QVector<double> yValuesData, QVector<double> zValuesData,
                                        const Unit &xAxisUnit, const Unit &valuesUnit)
                     : DataSeries{std::make_shared<ArrayData<1> >(std::move(xAxisData)), xAxisUnit,
                                  std::make_shared<ArrayData<2> >(QVector<QVector<double> >{
                                      std::move(xValuesData), std::move(yValuesData), std::move(zValuesData)}),
                                  valuesUnit}
             {
             }
             std::unique_ptr<IDataSeries> VectorSeries::clone() const
             {
                 return std::make_unique<VectorSeries>(*this);
             }
             std::shared_ptr<IDataSeries> VectorSeries::subDataSeries(const SqpRange &range)
             {
                 auto subXAxisData = QVector<double>();
                 auto subXValuesData = QVector<double>();
                 auto subYValuesData = QVector<double>();
                 auto subZValuesData = QVector<double>();
                 this->lockRead();
                 {
-                    auto bounds = subData(range.m_TStart, range.m_TEnd);
+                    auto bounds = xAxisRange(range.m_TStart, range.m_TEnd);
                     for (auto it = bounds.first; it != bounds.second; ++it) {
                         subXAxisData.append(it->x());
                         subXValuesData.append(it->value(0));
                         subYValuesData.append(it->value(1));
                         subZValuesData.append(it->value(2));
                     }
                 }
                 this->unlock();
                 return std::make_shared<VectorSeries>(subXAxisData, subXValuesData, subYValuesData,
                                                       subZValuesData, this->xAxisUnit(), this->valuesUnit());
             }

core/tests/Data/TestDataSeries.cpp +37 -29

             #include "Data/DataSeries.h"
             #include "Data/ScalarSeries.h"
             #include <QObject>
             #include <QtTest>
             Q_DECLARE_METATYPE(std::shared_ptr<ScalarSeries>)
             class TestDataSeries : public QObject {
                 Q_OBJECT
             private slots:
                 /// Input test data
                 /// @sa testCtor()
                 void testCtor_data();
                 /// Tests construction of a data series
                 void testCtor();
                 /// Input test data
                 /// @sa testMerge()
                 void testMerge_data();
                 /// Tests merge of two data series
                 void testMerge();
                 /// Input test data
                 /// @sa testMinXAxisData()
                 void testMinXAxisData_data();
                 /// Tests get min x-axis data of a data series
                 void testMinXAxisData();
                 /// Input test data
                 /// @sa testMaxXAxisData()
                 void testMaxXAxisData_data();
                 /// Tests get max x-axis data of a data series
                 void testMaxXAxisData();
                 /// Input test data
-                /// @sa testSubdata()
+                /// @sa testXAxisRange()
-                void testSubdata_data();
+                void testXAxisRange_data();
-                /// Tests get subdata of two data series
+                /// Tests get x-axis range of a data series
-                void testSubdata();
+                void testXAxisRange();
             };
             void TestDataSeries::testCtor_data()
             {
                 // ////////////// //
                 // Test structure //
                 // ////////////// //
                 // x-axis data
                 QTest::addColumn<QVector<double> >("xAxisData");
                 // values data
                 QTest::addColumn<QVector<double> >("valuesData");
                 // expected x-axis data
                 QTest::addColumn<QVector<double> >("expectedXAxisData");
                 // expected values data
                 QTest::addColumn<QVector<double> >("expectedValuesData");
                 // ////////// //
                 // Test cases //
                 // ////////// //
                 QTest::newRow("invalidData (different sizes of vectors)")
                     << QVector<double>{1., 2., 3., 4., 5.} << QVector<double>{100., 200., 300.}
                     << QVector<double>{} << QVector<double>{};
                 QTest::newRow("sortedData") << QVector<double>{1., 2., 3., 4., 5.}
                                             << QVector<double>{100., 200., 300., 400., 500.}
                                             << QVector<double>{1., 2., 3., 4., 5.}
                                             << QVector<double>{100., 200., 300., 400., 500.};
                 QTest::newRow("unsortedData") << QVector<double>{5., 4., 3., 2., 1.}
                                               << QVector<double>{100., 200., 300., 400., 500.}
                                               << QVector<double>{1., 2., 3., 4., 5.}
                                               << QVector<double>{500., 400., 300., 200., 100.};
                 QTest::newRow("unsortedData2")
                     << QVector<double>{1., 4., 3., 5., 2.} << QVector<double>{100., 200., 300., 400., 500.}
                     << QVector<double>{1., 2., 3., 4., 5.} << QVector<double>{100., 500., 300., 200., 400.};
             }
             void TestDataSeries::testCtor()
             {
                 // Creates series
                 QFETCH(QVector<double>, xAxisData);
                 QFETCH(QVector<double>, valuesData);
                 auto series = std::make_shared<ScalarSeries>(std::move(xAxisData), std::move(valuesData),
                                                              Unit{}, Unit{});
                 // Validates results : we check that the data series is sorted on its x-axis data
                 QFETCH(QVector<double>, expectedXAxisData);
                 QFETCH(QVector<double>, expectedValuesData);
                 auto seriesXAxisData = series->xAxisData()->data();
                 auto seriesValuesData = series->valuesData()->data();
                 QVERIFY(
                     std::equal(expectedXAxisData.cbegin(), expectedXAxisData.cend(), seriesXAxisData.cbegin()));
                 QVERIFY(std::equal(expectedValuesData.cbegin(), expectedValuesData.cend(),
                                    seriesValuesData.cbegin()));
             }
             namespace {
             std::shared_ptr<ScalarSeries> createSeries(QVector<double> xAxisData, QVector<double> valuesData)
             {
                 return std::make_shared<ScalarSeries>(std::move(xAxisData), std::move(valuesData), Unit{},
                                                       Unit{});
             }
             } // namespace
             void TestDataSeries::testMerge_data()
             {
                 // ////////////// //
                 // Test structure //
                 // ////////////// //
                 // Data series to merge
                 QTest::addColumn<std::shared_ptr<ScalarSeries> >("dataSeries");
                 QTest::addColumn<std::shared_ptr<ScalarSeries> >("dataSeries2");
                 // Expected values in the first data series after merge
                 QTest::addColumn<QVector<double> >("expectedXAxisData");
                 QTest::addColumn<QVector<double> >("expectedValuesData");
                 // ////////// //
                 // Test cases //
                 // ////////// //
                 QTest::newRow("sortedMerge")
                     << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                     << createSeries({6., 7., 8., 9., 10.}, {600., 700., 800., 900., 1000.})
                     << QVector<double>{1., 2., 3., 4., 5., 6., 7., 8., 9., 10.}
                     << QVector<double>{100., 200., 300., 400., 500., 600., 700., 800., 900., 1000.};
                 QTest::newRow("unsortedMerge")
                     << createSeries({6., 7., 8., 9., 10.}, {600., 700., 800., 900., 1000.})
                     << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                     << QVector<double>{1., 2., 3., 4., 5., 6., 7., 8., 9., 10.}
                     << QVector<double>{100., 200., 300., 400., 500., 600., 700., 800., 900., 1000.};
                 QTest::newRow("unsortedMerge2")
                     << createSeries({1., 2., 8., 9., 10}, {100., 200., 300., 400., 500.})
                     << createSeries({3., 4., 5., 6., 7.}, {600., 700., 800., 900., 1000.})
                     << QVector<double>{1., 2., 3., 4., 5., 6., 7., 8., 9., 10.}
                     << QVector<double>{100., 200., 600., 700., 800., 900., 1000., 300., 400., 500.};
                 QTest::newRow("unsortedMerge3")
                     << createSeries({3., 5., 8., 7., 2}, {100., 200., 300., 400., 500.})
                     << createSeries({6., 4., 9., 10., 1.}, {600., 700., 800., 900., 1000.})
                     << QVector<double>{1., 2., 3., 4., 5., 6., 7., 8., 9., 10.}
                     << QVector<double>{1000., 500., 100., 700., 200., 600., 400., 300., 800., 900.};
             }
             void TestDataSeries::testMerge()
             {
                 // Merges series
                 QFETCH(std::shared_ptr<ScalarSeries>, dataSeries);
                 QFETCH(std::shared_ptr<ScalarSeries>, dataSeries2);
                 dataSeries->merge(dataSeries2.get());
                 // Validates results : we check that the merge is valid and the data series is sorted on its
                 // x-axis data
                 QFETCH(QVector<double>, expectedXAxisData);
                 QFETCH(QVector<double>, expectedValuesData);
                 auto seriesXAxisData = dataSeries->xAxisData()->data();
                 auto seriesValuesData = dataSeries->valuesData()->data();
                 QVERIFY(
                     std::equal(expectedXAxisData.cbegin(), expectedXAxisData.cend(), seriesXAxisData.cbegin()));
                 QVERIFY(std::equal(expectedValuesData.cbegin(), expectedValuesData.cend(),
                                    seriesValuesData.cbegin()));
             }
             void TestDataSeries::testMinXAxisData_data()
             {
                 // ////////////// //
                 // Test structure //
                 // ////////////// //
                 // Data series to get min data
                 QTest::addColumn<std::shared_ptr<ScalarSeries> >("dataSeries");
                 // Min data
                 QTest::addColumn<double>("min");
                 // Expected results
                 QTest::addColumn<bool>(
                     "expectedOK"); // if true, expects to have a result (i.e. the iterator != end iterator)
                 QTest::addColumn<double>(
                     "expectedMin"); // Expected value when method doesn't return end iterator
                 // ////////// //
                 // Test cases //
                 // ////////// //
                 QTest::newRow("minData1") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 0. << true << 1.;
                 QTest::newRow("minData2") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 1. << true << 1.;
                 QTest::newRow("minData3") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 1.1 << true << 2.;
                 QTest::newRow("minData4") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 5. << true << 5.;
                 QTest::newRow("minData5") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 5.1 << false << std::numeric_limits<double>::quiet_NaN();
                 QTest::newRow("minData6") << createSeries({}, {}) << 1.1 << false
                                           << std::numeric_limits<double>::quiet_NaN();
             }
             void TestDataSeries::testMinXAxisData()
             {
                 QFETCH(std::shared_ptr<ScalarSeries>, dataSeries);
                 QFETCH(double, min);
                 QFETCH(bool, expectedOK);
                 QFETCH(double, expectedMin);
                 auto it = dataSeries->minXAxisData(min);
                 QCOMPARE(expectedOK, it != dataSeries->cend());
                 // If the method doesn't return a end iterator, checks with expected value
                 if (expectedOK) {
                     QCOMPARE(expectedMin, it->x());
                 }
             }
             void TestDataSeries::testMaxXAxisData_data()
             {
                 // ////////////// //
                 // Test structure //
                 // ////////////// //
                 // Data series to get max data
                 QTest::addColumn<std::shared_ptr<ScalarSeries> >("dataSeries");
                 // Max data
                 QTest::addColumn<double>("max");
                 // Expected results
                 QTest::addColumn<bool>(
                     "expectedOK"); // if true, expects to have a result (i.e. the iterator != end iterator)
                 QTest::addColumn<double>(
                     "expectedMax"); // Expected value when method doesn't return end iterator
                 // ////////// //
                 // Test cases //
                 // ////////// //
                 QTest::newRow("maxData1") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 6. << true << 5.;
                 QTest::newRow("maxData2") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 5. << true << 5.;
                 QTest::newRow("maxData3") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 4.9 << true << 4.;
                 QTest::newRow("maxData4") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 1.1 << true << 1.;
                 QTest::newRow("maxData5") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                                           << 1. << true << 1.;
                 QTest::newRow("maxData6") << createSeries({}, {}) << 1.1 << false
                                           << std::numeric_limits<double>::quiet_NaN();
             }
             void TestDataSeries::testMaxXAxisData()
             {
                 QFETCH(std::shared_ptr<ScalarSeries>, dataSeries);
                 QFETCH(double, max);
                 QFETCH(bool, expectedOK);
                 QFETCH(double, expectedMax);
                 auto it = dataSeries->maxXAxisData(max);
                 QCOMPARE(expectedOK, it != dataSeries->cend());
                 // If the method doesn't return a end iterator, checks with expected value
                 if (expectedOK) {
                     QCOMPARE(expectedMax, it->x());
                 }
             }
-            void TestDataSeries::testSubdata_data()
+            void TestDataSeries::testXAxisRange_data()
             {
                 // ////////////// //
                 // Test structure //
                 // ////////////// //
-                // Data series to get subdata
+                // Data series to get x-axis range
                 QTest::addColumn<std::shared_ptr<ScalarSeries> >("dataSeries");
                 // Min/max values
                 QTest::addColumn<double>("min");
                 QTest::addColumn<double>("max");
-                // Expected values after subdata
+                // Expected values
                 QTest::addColumn<QVector<double> >("expectedXAxisData");
                 QTest::addColumn<QVector<double> >("expectedValuesData");
                 // ////////// //
                 // Test cases //
                 // ////////// //
-                QTest::newRow("subData1") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                QTest::newRow("xAxisRange1") << createSeries({1., 2., 3., 4., 5.},
-                                          << -1. << 3.2 << QVector<double>{1., 2., 3.}
+                                                             {100., 200., 300., 400., 500.})
-                                          << QVector<double>{100., 200., 300.};
+                                             << -1. << 3.2 << QVector<double>{1., 2., 3.}
-                QTest::newRow("subData2") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                             << QVector<double>{100., 200., 300.};
-                                          << 1. << 4. << QVector<double>{1., 2., 3., 4.}
+                QTest::newRow("xAxisRange2") << createSeries({1., 2., 3., 4., 5.},
-                                          << QVector<double>{100., 200., 300., 400.};
+                                                             {100., 200., 300., 400., 500.})
-                QTest::newRow("subData3") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                             << 1. << 4. << QVector<double>{1., 2., 3., 4.}
-                                          << 1. << 3.9 << QVector<double>{1., 2., 3.}
+                                             << QVector<double>{100., 200., 300., 400.};
-                                          << QVector<double>{100., 200., 300.};
+                QTest::newRow("xAxisRange3") << createSeries({1., 2., 3., 4., 5.},
-                QTest::newRow("subData4") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                                             {100., 200., 300., 400., 500.})
-                                          << 0. << 0.9 << QVector<double>{} << QVector<double>{};
+                                             << 1. << 3.9 << QVector<double>{1., 2., 3.}
-                QTest::newRow("subData5") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                             << QVector<double>{100., 200., 300.};
-                                          << 0. << 1. << QVector<double>{1.} << QVector<double>{100.};
+                QTest::newRow("xAxisRange4") << createSeries({1., 2., 3., 4., 5.},
-                QTest::newRow("subData6") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                                             {100., 200., 300., 400., 500.})
-                                          << 2.1 << 6. << QVector<double>{3., 4., 5.}
+                                             << 0. << 0.9 << QVector<double>{} << QVector<double>{};
-                                          << QVector<double>{300., 400., 500.};
+                QTest::newRow("xAxisRange5") << createSeries({1., 2., 3., 4., 5.},
-                QTest::newRow("subData7") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                                             {100., 200., 300., 400., 500.})
-                                          << 6. << 9. << QVector<double>{} << QVector<double>{};
+                                             << 0. << 1. << QVector<double>{1.} << QVector<double>{100.};
-                QTest::newRow("subData8") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                QTest::newRow("xAxisRange6") << createSeries({1., 2., 3., 4., 5.},
-                                          << 5. << 9. << QVector<double>{5.} << QVector<double>{500.};
+                                                             {100., 200., 300., 400., 500.})
+                                             << 2.1 << 6. << QVector<double>{3., 4., 5.}
+                                             << QVector<double>{300., 400., 500.};
+                QTest::newRow("xAxisRange7") << createSeries({1., 2., 3., 4., 5.},
+                                                             {100., 200., 300., 400., 500.})
+                                             << 6. << 9. << QVector<double>{} << QVector<double>{};
+                QTest::newRow("xAxisRange8") << createSeries({1., 2., 3., 4., 5.},
+                                                             {100., 200., 300., 400., 500.})
+                                             << 5. << 9. << QVector<double>{5.} << QVector<double>{500.};
             }
-            void TestDataSeries::testSubdata()
+            void TestDataSeries::testXAxisRange()
             {
                 QFETCH(std::shared_ptr<ScalarSeries>, dataSeries);
                 QFETCH(double, min);
                 QFETCH(double, max);
                 QFETCH(QVector<double>, expectedXAxisData);
                 QFETCH(QVector<double>, expectedValuesData);
-                auto bounds = dataSeries->subData(min, max);
+                auto bounds = dataSeries->xAxisRange(min, max);
                 QVERIFY(std::equal(bounds.first, bounds.second, expectedXAxisData.cbegin(),
                                    expectedXAxisData.cend(),
                                    [](const auto &it, const auto &expectedX) { return it.x() == expectedX; }));
                 QVERIFY(std::equal(
                     bounds.first, bounds.second, expectedValuesData.cbegin(), expectedValuesData.cend(),
                     [](const auto &it, const auto &expectedVal) { return it.value() == expectedVal; }));
             }
             QTEST_MAIN(TestDataSeries)
             #include "TestDataSeries.moc"

gui/src/Visualization/VisualizationGraphHelper.cpp +1 -1

             #include "Visualization/VisualizationGraphHelper.h"
             #include "Visualization/qcustomplot.h"
             #include <Common/ColorUtils.h>
             #include <Data/ScalarSeries.h>
             #include <Data/VectorSeries.h>
             #include <Variable/Variable.h>
             Q_LOGGING_CATEGORY(LOG_VisualizationGraphHelper, "VisualizationGraphHelper")
             namespace {
             class SqpDataContainer : public QCPGraphDataContainer {
             public:
                 void appendGraphData(const QCPGraphData &data) { mData.append(data); }
             };
             /// Format for datetimes on a axis
             const auto DATETIME_TICKER_FORMAT = QStringLiteral("yyyy/MM/dd \nhh:mm:ss");
             /// Generates the appropriate ticker for an axis, depending on whether the axis displays time or
             /// non-time data
             QSharedPointer<QCPAxisTicker> axisTicker(bool isTimeAxis)
             {
                 if (isTimeAxis) {
                     auto dateTicker = QSharedPointer<QCPAxisTickerDateTime>::create();
                     dateTicker->setDateTimeFormat(DATETIME_TICKER_FORMAT);
                     dateTicker->setDateTimeSpec(Qt::UTC);
                     return dateTicker;
                 }
                 else {
                     // default ticker
                     return QSharedPointer<QCPAxisTicker>::create();
                 }
             }
             /// Sets axes properties according to the properties of a data series
             template <int Dim>
             void setAxesProperties(const DataSeries<Dim> &dataSeries, QCustomPlot &plot) noexcept
             {
                 /// @todo : for the moment, no control is performed on the axes: the units and the tickers
                 /// are fixed for the default x-axis and y-axis of the plot, and according to the new graph
                 auto setAxisProperties = [](auto axis, const auto &unit) {
                     // label (unit name)
                     axis->setLabel(unit.m_Name);
                     // ticker (depending on the type of unit)
                     axis->setTicker(axisTicker(unit.m_TimeUnit));
                 };
                 setAxisProperties(plot.xAxis, dataSeries.xAxisUnit());
                 setAxisProperties(plot.yAxis, dataSeries.valuesUnit());
             }
             /**
              * Struct used to create plottables, depending on the type of the data series from which to create
              * them
              * @tparam T the data series' type
              * @remarks Default implementation can't create plottables
              */
             template <typename T, typename Enabled = void>
             struct PlottablesCreator {
                 static PlottablesMap createPlottables(T &, QCustomPlot &)
                 {
                     qCCritical(LOG_DataSeries())
                         << QObject::tr("Can't create plottables: unmanaged data series type");
                     return {};
                 }
             };
             /**
              * Specialization of PlottablesCreator for scalars and vectors
              * @sa ScalarSeries
              * @sa VectorSeries
              */
             template <typename T>
             struct PlottablesCreator<T,
                                      typename std::enable_if_t<std::is_base_of<ScalarSeries, T>::value
                                                                or std::is_base_of<VectorSeries, T>::value> > {
                 static PlottablesMap createPlottables(T &dataSeries, QCustomPlot &plot)
                 {
                     PlottablesMap result{};
                     // Gets the number of components of the data series
                     auto componentCount = dataSeries.valuesData()->componentCount();
                     auto colors = ColorUtils::colors(Qt::blue, Qt::red, componentCount);
                     // For each component of the data series, creates a QCPGraph to add to the plot
                     for (auto i = 0; i < componentCount; ++i) {
                         auto graph = plot.addGraph();
                         graph->setPen(QPen{colors.at(i)});
                         result.insert({i, graph});
                     }
                     // Axes properties
                     setAxesProperties(dataSeries, plot);
                     plot.replot();
                     return result;
                 }
             };
             /**
              * Struct used to update plottables, depending on the type of the data series from which to update
              * them
              * @tparam T the data series' type
              * @remarks Default implementation can't update plottables
              */
             template <typename T, typename Enabled = void>
             struct PlottablesUpdater {
                 static void updatePlottables(T &, PlottablesMap &, const SqpRange &, bool)
                 {
                     qCCritical(LOG_DataSeries())
                         << QObject::tr("Can't update plottables: unmanaged data series type");
                 }
             };
             /**
              * Specialization of PlottablesUpdater for scalars and vectors
              * @sa ScalarSeries
              * @sa VectorSeries
              */
             template <typename T>
             struct PlottablesUpdater<T,
                                      typename std::enable_if_t<std::is_base_of<ScalarSeries, T>::value
                                                                or std::is_base_of<VectorSeries, T>::value> > {
                 static void updatePlottables(T &dataSeries, PlottablesMap &plottables, const SqpRange &range,
                                              bool rescaleAxes)
                 {
                     dataSeries.lockRead();
                     // For each plottable to update, resets its data
                     std::map<int, QSharedPointer<SqpDataContainer> > dataContainers{};
                     for (const auto &plottable : plottables) {
                         if (auto graph = dynamic_cast<QCPGraph *>(plottable.second)) {
                             auto dataContainer = QSharedPointer<SqpDataContainer>::create();
                             graph->setData(dataContainer);
                             dataContainers.insert({plottable.first, dataContainer});
                         }
                     }
                     // - Gets the data of the series included in the current range
                     // - Updates each plottable by adding, for each data item, a point that takes x-axis data
                     // and value data. The correct value is retrieved according to the index of the component
-                    auto subDataIts = dataSeries.subData(range.m_TStart, range.m_TEnd);
+                    auto subDataIts = dataSeries.xAxisRange(range.m_TStart, range.m_TEnd);
                     for (auto it = subDataIts.first; it != subDataIts.second; ++it) {
                         for (const auto &dataContainer : dataContainers) {
                             auto componentIndex = dataContainer.first;
                             dataContainer.second->appendGraphData(
                                 QCPGraphData(it->x(), it->value(componentIndex)));
                         }
                     }
                     dataSeries.unlock();
                     if (!plottables.empty()) {
                         auto plot = plottables.begin()->second->parentPlot();
                         if (rescaleAxes) {
                             plot->rescaleAxes();
                         }
                         plot->replot();
                     }
                 }
             };
             /**
              * Helper used to create/update plottables
              */
             struct IPlottablesHelper {
                 virtual ~IPlottablesHelper() noexcept = default;
                 virtual PlottablesMap create(QCustomPlot &plot) const = 0;
                 virtual void update(PlottablesMap &plottables, const SqpRange &range,
                                     bool rescaleAxes = false) const = 0;
             };
             /**
              * Default implementation of IPlottablesHelper, which takes data series to create/update plottables
              * @tparam T the data series' type
              */
             template <typename T>
             struct PlottablesHelper : public IPlottablesHelper {
                 explicit PlottablesHelper(T &dataSeries) : m_DataSeries{dataSeries} {}
                 PlottablesMap create(QCustomPlot &plot) const override
                 {
                     return PlottablesCreator<T>::createPlottables(m_DataSeries, plot);
                 }
                 void update(PlottablesMap &plottables, const SqpRange &range, bool rescaleAxes) const override
                 {
                     PlottablesUpdater<T>::updatePlottables(m_DataSeries, plottables, range, rescaleAxes);
                 }
                 T &m_DataSeries;
             };
             /// Creates IPlottablesHelper according to a data series
             std::unique_ptr<IPlottablesHelper> createHelper(std::shared_ptr<IDataSeries> dataSeries) noexcept
             {
                 if (auto scalarSeries = std::dynamic_pointer_cast<ScalarSeries>(dataSeries)) {
                     return std::make_unique<PlottablesHelper<ScalarSeries> >(*scalarSeries);
                 }
                 else if (auto vectorSeries = std::dynamic_pointer_cast<VectorSeries>(dataSeries)) {
                     return std::make_unique<PlottablesHelper<VectorSeries> >(*vectorSeries);
                 }
                 else {
                     return std::make_unique<PlottablesHelper<IDataSeries> >(*dataSeries);
                 }
             }
             } // namespace
             PlottablesMap VisualizationGraphHelper::create(std::shared_ptr<Variable> variable,
                                                            QCustomPlot &plot) noexcept
             {
                 if (variable) {
                     auto helper = createHelper(variable->dataSeries());
                     auto plottables = helper->create(plot);
                     return plottables;
                 }
                 else {
                     qCDebug(LOG_VisualizationGraphHelper())
                         << QObject::tr("Can't create graph plottables : the variable is null");
                     return PlottablesMap{};
                 }
             }
             void VisualizationGraphHelper::updateData(PlottablesMap &plottables,
                                                       std::shared_ptr<IDataSeries> dataSeries,
                                                       const SqpRange &dateTime)
             {
                 auto helper = createHelper(dataSeries);
                 helper->update(plottables, dateTime);
             }

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages