HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Commit - r861:da8b6df7cbcf

Handles y-axis in DataSeries....

Alexandre Leroux -

r861:da8b6df7cbcf

parent child

Context file:

r861:da8b6df7cbcf

Collapse all files

core/include/Data/DataSeries.h +46 -8

             #include <Data/ArrayData.h>
             #include <Data/DataSeriesMergeHelper.h>
             #include <Data/IDataSeries.h>
+            #include <Data/OptionalAxis.h>
             #include <QLoggingCategory>
             #include <QReadLocker>
                 bool isEmpty() const noexcept { return m_XAxisData->size() == 0; }
-                /// Merges into the data series an other data series
+                /// Merges into the data series an other data series.
+                ///
+                /// The two dataseries:
+                /// - must be of the same dimension
+                /// - must have the same y-axis (if defined)
+                ///
+                /// If the prerequisites are not valid, the method does nothing
+                ///
                 /// @remarks the data series to merge with is cleared after the operation
                 void merge(IDataSeries *dataSeries) override
                 {
                     lockWrite();
                     if (auto other = dynamic_cast<DataSeries<Dim> *>(dataSeries)) {
-                        DataSeriesMergeHelper::merge(*other, *this);
+                        if (m_YAxis == other->m_YAxis) {
+                            DataSeriesMergeHelper::merge(*other, *this);
+                        }
+                        else {
+                            qCWarning(LOG_DataSeries())
+                                << QObject::tr("Can't merge data series that have not the same y-axis");
+                        }
                     }
                     else {
                         qCWarning(LOG_DataSeries())
                 virtual void unlock() { m_Lock.unlock(); }
             protected:
-                /// Protected ctor (DataSeries is abstract). The vectors must have the same size, otherwise a
+                /// Protected ctor (DataSeries is abstract).
-                /// DataSeries with no values will be created.
+                ///
+                /// Data vectors must be consistent with each other, otherwise an exception will be thrown (@sa
+                /// class description for consistent rules)
                 /// @remarks data series is automatically sorted on its x-axis data
+                /// @throws std::invalid_argument if the data are inconsistent with each other
                 explicit DataSeries(std::shared_ptr<ArrayData<1> > xAxisData, const Unit &xAxisUnit,
-                                    std::shared_ptr<ArrayData<Dim> > valuesData, const Unit &valuesUnit)
+                                    std::shared_ptr<ArrayData<Dim> > valuesData, const Unit &valuesUnit,
+                                    OptionalAxis yAxis = OptionalAxis{})
                         : m_XAxisData{xAxisData},
                           m_XAxisUnit{xAxisUnit},
                           m_ValuesData{valuesData},
-                          m_ValuesUnit{valuesUnit}
+                          m_ValuesUnit{valuesUnit},
+                          m_YAxis{std::move(yAxis)}
                 {
                     if (m_XAxisData->size() != m_ValuesData->size()) {
-                        clear();
+                        throw std::invalid_argument{
+                            "The number of values by component must be equal to the number of x-axis data"};
+                    }
+                    // Validates y-axis (if defined)
+                    if (yAxis.isDefined() && (yAxis.size() != m_ValuesData->componentCount())) {
+                        throw std::invalid_argument{
+                            "As the y-axis is defined, the number of value components must be equal to the "
+                            "number of y-axis data"};
                     }
                     // Sorts data if it's not the case
                         : 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}
+                          m_ValuesUnit{other.m_ValuesUnit},
+                          m_YAxis{other.m_YAxis}
                 {
                     // 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)
                 }
+                /// @return the y-axis associated to the data series
+                OptionalAxis yAxis() const { return m_YAxis; }
                 /// Assignment operator
                 template <int D>
                 DataSeries &operator=(DataSeries<D> other)
                     std::swap(m_XAxisUnit, other.m_XAxisUnit);
                     std::swap(m_ValuesData, other.m_ValuesData);
                     std::swap(m_ValuesUnit, other.m_ValuesUnit);
+                    std::swap(m_YAxis, other.m_YAxis);
                     return *this;
                 }
                     m_ValuesData = m_ValuesData->sort(permutation);
                 }
+                // x-axis
                 std::shared_ptr<ArrayData<1> > m_XAxisData;
                 Unit m_XAxisUnit;
+                // values
                 std::shared_ptr<ArrayData<Dim> > m_ValuesData;
                 Unit m_ValuesUnit;
+                // y-axis (optional)
+                OptionalAxis m_YAxis;
                 QReadWriteLock m_Lock;
             };

General Comments 0

Write
Preview

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

No TODOs yet

Why an exception?...

	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