VisualizationGraphHelper.cpp
247 lines
| 8.3 KiB
| text/x-c
|
CppLexer
| r243 | #include "Visualization/VisualizationGraphHelper.h" | |||
Alexandre Leroux
|
r181 | #include "Visualization/qcustomplot.h" | ||
|
Alexandre Leroux
|
r584 | #include <Common/ColorUtils.h> | ||
|
Alexandre Leroux
|
r182 | #include <Data/ScalarSeries.h> | ||
|
Alexandre Leroux
|
r583 | #include <Data/VectorSeries.h> | ||
|
Alexandre Leroux
|
r182 | |||
|
Alexandre Leroux
|
r181 | #include <Variable/Variable.h> | ||
| r243 | Q_LOGGING_CATEGORY(LOG_VisualizationGraphHelper, "VisualizationGraphHelper") | |||
|
Alexandre Leroux
|
r181 | |||
|
Alexandre Leroux
|
r182 | namespace { | ||
| r364 | class SqpDataContainer : public QCPGraphDataContainer { | |||
| public: | ||||
|
Alexandre Leroux
|
r453 | void appendGraphData(const QCPGraphData &data) { mData.append(data); } | ||
| r364 | }; | |||
|
Alexandre Leroux
|
r183 | /// 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); | ||||
|
Alexandre Leroux
|
r490 | dateTicker->setDateTimeSpec(Qt::UTC); | ||
|
Alexandre Leroux
|
r183 | |||
| return dateTicker; | ||||
| } | ||||
| else { | ||||
| // default ticker | ||||
| return QSharedPointer<QCPAxisTicker>::create(); | ||||
| } | ||||
| } | ||||
|
Alexandre Leroux
|
r182 | |||
| r636 | /// Sets axes properties according to the properties of a data series. Not thread safe | |||
|
Alexandre Leroux
|
r583 | template <int Dim> | ||
| void setAxesProperties(const DataSeries<Dim> &dataSeries, QCustomPlot &plot) noexcept | ||||
| r235 | { | |||
|
Alexandre Leroux
|
r583 | /// @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()); | ||||
| } | ||||
| r315 | ||||
|
Alexandre Leroux
|
r583 | /** | ||
| r591 | * Struct used to create plottables, depending on the type of the data series from which to create | |||
| * them | ||||
|
Alexandre Leroux
|
r583 | * @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 {}; | ||||
| r235 | } | |||
|
Alexandre Leroux
|
r583 | }; | ||
| r235 | ||||
|
Alexandre Leroux
|
r583 | /** | ||
| * 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 | ||||
| r636 | dataSeries.lockRead(); | |||
|
Alexandre Leroux
|
r583 | auto componentCount = dataSeries.valuesData()->componentCount(); | ||
| r636 | dataSeries.unlock(); | |||
|
Alexandre Leroux
|
r583 | |||
|
Alexandre Leroux
|
r584 | auto colors = ColorUtils::colors(Qt::blue, Qt::red, componentCount); | ||
|
Alexandre Leroux
|
r583 | // 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(); | ||||
|
Alexandre Leroux
|
r584 | graph->setPen(QPen{colors.at(i)}); | ||
|
Alexandre Leroux
|
r583 | |||
| result.insert({i, graph}); | ||||
| } | ||||
| r548 | ||||
| // Axes properties | ||||
| r636 | dataSeries.lockRead(); | |||
|
Alexandre Leroux
|
r583 | setAxesProperties(dataSeries, plot); | ||
| r636 | dataSeries.unlock(); | |||
|
Alexandre Leroux
|
r583 | |||
| plot.replot(); | ||||
| return result; | ||||
| r548 | } | |||
|
Alexandre Leroux
|
r583 | }; | ||
| r548 | ||||
|
Alexandre Leroux
|
r583 | /** | ||
| r591 | * Struct used to update plottables, depending on the type of the data series from which to update | |||
| * them | ||||
|
Alexandre Leroux
|
r583 | * @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"); | ||||
| } | ||||
| }; | ||||
|
Alexandre Leroux
|
r182 | |||
|
Alexandre Leroux
|
r583 | /** | ||
| * 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) | ||||
| { | ||||
| // 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}); | ||||
| } | ||||
| } | ||||
| r636 | dataSeries.lockRead(); | |||
|
Alexandre Leroux
|
r182 | |||
|
Alexandre Leroux
|
r583 | // - Gets the data of the series included in the current range | ||
| r591 | // - 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 | ||||
|
Alexandre Leroux
|
r605 | auto subDataIts = dataSeries.xAxisRange(range.m_TStart, range.m_TEnd); | ||
|
Alexandre Leroux
|
r583 | 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))); | ||||
| } | ||||
| } | ||||
| r235 | ||||
|
Alexandre Leroux
|
r583 | dataSeries.unlock(); | ||
|
Alexandre Leroux
|
r183 | |||
|
Alexandre Leroux
|
r583 | if (!plottables.empty()) { | ||
| auto plot = plottables.begin()->second->parentPlot(); | ||||
|
Alexandre Leroux
|
r183 | |||
|
Alexandre Leroux
|
r583 | if (rescaleAxes) { | ||
| plot->rescaleAxes(); | ||||
| } | ||||
|
Alexandre Leroux
|
r183 | |||
|
Alexandre Leroux
|
r583 | plot->replot(); | ||
| } | ||||
|
Alexandre Leroux
|
r182 | } | ||
|
Alexandre Leroux
|
r583 | }; | ||
| /** | ||||
| * 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); | ||||
|
Alexandre Leroux
|
r182 | } | ||
|
Alexandre Leroux
|
r583 | void update(PlottablesMap &plottables, const SqpRange &range, bool rescaleAxes) const override | ||
| { | ||||
| PlottablesUpdater<T>::updatePlottables(m_DataSeries, plottables, range, rescaleAxes); | ||||
| } | ||||
|
Alexandre Leroux
|
r182 | |||
|
Alexandre Leroux
|
r583 | T &m_DataSeries; | ||
| }; | ||||
|
Alexandre Leroux
|
r182 | |||
|
Alexandre Leroux
|
r583 | /// Creates IPlottablesHelper according to a data series | ||
|
Alexandre Leroux
|
r587 | std::unique_ptr<IPlottablesHelper> createHelper(std::shared_ptr<IDataSeries> dataSeries) noexcept | ||
| r548 | { | |||
|
Alexandre Leroux
|
r587 | if (auto scalarSeries = std::dynamic_pointer_cast<ScalarSeries>(dataSeries)) { | ||
|
Alexandre Leroux
|
r583 | return std::make_unique<PlottablesHelper<ScalarSeries> >(*scalarSeries); | ||
| } | ||||
|
Alexandre Leroux
|
r587 | else if (auto vectorSeries = std::dynamic_pointer_cast<VectorSeries>(dataSeries)) { | ||
|
Alexandre Leroux
|
r583 | return std::make_unique<PlottablesHelper<VectorSeries> >(*vectorSeries); | ||
| r548 | } | |||
| else { | ||||
|
Alexandre Leroux
|
r583 | return std::make_unique<PlottablesHelper<IDataSeries> >(*dataSeries); | ||
| r548 | } | |||
| } | ||||
|
Alexandre Leroux
|
r583 | } // namespace | ||
|
Alexandre Leroux
|
r181 | |||
|
Alexandre Leroux
|
r583 | PlottablesMap VisualizationGraphHelper::create(std::shared_ptr<Variable> variable, | ||
| QCustomPlot &plot) noexcept | ||||
| { | ||||
|
Alexandre Leroux
|
r181 | if (variable) { | ||
|
Alexandre Leroux
|
r587 | auto helper = createHelper(variable->dataSeries()); | ||
|
Alexandre Leroux
|
r583 | auto plottables = helper->create(plot); | ||
| return plottables; | ||||
|
Alexandre Leroux
|
r181 | } | ||
| else { | ||||
| r243 | qCDebug(LOG_VisualizationGraphHelper()) | |||
|
Alexandre Leroux
|
r181 | << QObject::tr("Can't create graph plottables : the variable is null"); | ||
|
Alexandre Leroux
|
r583 | return PlottablesMap{}; | ||
|
Alexandre Leroux
|
r181 | } | ||
| } | ||||
| r235 | ||||
|
Alexandre Leroux
|
r587 | void VisualizationGraphHelper::updateData(PlottablesMap &plottables, | ||
| std::shared_ptr<IDataSeries> dataSeries, | ||||
| r542 | const SqpRange &dateTime) | |||
| r235 | { | |||
|
Alexandre Leroux
|
r583 | auto helper = createHelper(dataSeries); | ||
| helper->update(plottables, dateTime); | ||||
| r235 | } | |||
