HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Commit - r209:7ef1d04a5917

Creates a interface that defines a variable container...

Alexandre Leroux -

r209:7ef1d04a5917

parent child

Context file:

r209:7ef1d04a5917

Collapse all files

gui/include/Visualization/IVariableContainer.h created 644 +19 0

@@ -0,0 +1,19
	1	#ifndef SCIQLOP_IVARIABLECONTAINER_H
	2	#define SCIQLOP_IVARIABLECONTAINER_H
	3
	4	class Variable;
	5
	6	/**
	7	* @brief The IVariableContainer interface represents an UI object that can accommodate a variable
	8	*/
	9	class IVariableContainer {
	10
	11	public:
	12	virtual ~IVariableContainer() = default;
	13
	14	/// Checks if the container can handle the variable passed in parameter
	15	virtual bool canDrop(const Variable &variable) const = 0;
	16	};
	17
	18
	19	#endif // SCIQLOP_IVARIABLECONTAINER_H

gui/include/Visualization/IVisualizationWidget.h +2 -1

             #ifndef SCIQLOP_IVISUALIZATIONWIDGET_H
             #define SCIQLOP_IVISUALIZATIONWIDGET_H
+            #include "Visualization/IVariableContainer.h"
             #include <QString>
             #include <memory>
             class IVisualizationWidgetVisitor;
             /**
              * @brief The IVisualizationWidget handles the visualization widget.
              */
-            class IVisualizationWidget {
+            class IVisualizationWidget : public IVariableContainer {
             public:
                 virtual ~IVisualizationWidget() = default;
                 /// Initializes the plugin
                 virtual void accept(IVisualizationWidgetVisitor *visitor) = 0;
                 virtual void close() = 0;
                 virtual QString name() const = 0;
             };
             #endif // SCIQLOP_IVISUALIZATIONWIDGET_H

gui/include/Visualization/VisualizationGraphWidget.h +1 0

             #ifndef SCIQLOP_VISUALIZATIONGRAPHWIDGET_H
             #define SCIQLOP_VISUALIZATIONGRAPHWIDGET_H
             #include "Visualization/IVisualizationWidget.h"
             #include <QWidget>
             #include <memory>
             #include <Common/spimpl.h>
             class Variable;
             namespace Ui {
             class VisualizationGraphWidget;
             } // namespace Ui
             class VisualizationGraphWidget : public QWidget, public IVisualizationWidget {
                 Q_OBJECT
             public:
                 explicit VisualizationGraphWidget(const QString &name = {}, QWidget *parent = 0);
                 virtual ~VisualizationGraphWidget();
                 void addVariable(std::shared_ptr<Variable> variable);
                 // IVisualizationWidget interface
                 void accept(IVisualizationWidgetVisitor *visitor) override;
+                bool canDrop(const Variable &variable) const override;
                 void close() override;
                 QString name() const;
             private:
                 Ui::VisualizationGraphWidget *ui;
                 class VisualizationGraphWidgetPrivate;
                 spimpl::unique_impl_ptr<VisualizationGraphWidgetPrivate> impl;
             private slots:
                 /// Slot called when a mouse wheel was made, to perform some processing before the zoom is done
                 void onMouseWheel(QWheelEvent *event) noexcept;
             };
             #endif // SCIQLOP_VISUALIZATIONGRAPHWIDGET_H

gui/include/Visualization/VisualizationTabWidget.h +1 0

             #ifndef SCIQLOP_VISUALIZATIONTABWIDGET_H
             #define SCIQLOP_VISUALIZATIONTABWIDGET_H
             #include "Visualization/IVisualizationWidget.h"
             #include <Common/spimpl.h>
             #include <QWidget>
             class Variable;
             class VisualizationZoneWidget;
             namespace Ui {
             class VisualizationTabWidget;
             } // namespace Ui
             class VisualizationTabWidget : public QWidget, public IVisualizationWidget {
                 Q_OBJECT
             public:
                 explicit VisualizationTabWidget(const QString &name = {}, QWidget *parent = 0);
                 virtual ~VisualizationTabWidget();
                 /// Add a zone widget
                 void addZone(VisualizationZoneWidget *zoneWidget);
                 /**
                  * Creates a zone using a variable. The variable will be displayed in a new graph of the new
                  * zone.
                  * @param variable the variable for which to create the zone
                  * @return the pointer to the created zone
                  */
                 VisualizationZoneWidget *createZone(std::shared_ptr<Variable> variable);
                 /// Remove a zone
                 void removeZone(VisualizationZoneWidget *zone);
                 // IVisualizationWidget interface
                 void accept(IVisualizationWidgetVisitor *visitor) override;
+                bool canDrop(const Variable &variable) const override;
                 void close() override;
                 QString name() const override;
             private:
                 Ui::VisualizationTabWidget *ui;
                 class VisualizationTabWidgetPrivate;
                 spimpl::unique_impl_ptr<VisualizationTabWidgetPrivate> impl;
             };
             #endif // SCIQLOP_VISUALIZATIONTABWIDGET_H

gui/include/Visualization/VisualizationWidget.h +1 0

             #ifndef SCIQLOP_VISUALIZATIONWIDGET_H
             #define SCIQLOP_VISUALIZATIONWIDGET_H
             #include "Visualization/IVisualizationWidget.h"
             #include <QLoggingCategory>
             #include <QWidget>
             class Variable;
             class VisualizationTabWidget;
             Q_DECLARE_LOGGING_CATEGORY(LOG_VisualizationWidget)
             namespace Ui {
             class VisualizationWidget;
             } // namespace Ui
             class VisualizationWidget : public QWidget, public IVisualizationWidget {
                 Q_OBJECT
             public:
                 explicit VisualizationWidget(QWidget *parent = 0);
                 virtual ~VisualizationWidget();
                 /// Add a zone widget
                 virtual void addTab(VisualizationTabWidget *tabWidget);
                 /// Create a tab using a Variable
                 VisualizationTabWidget *createTab();
                 /// Remove a tab
                 void removeTab(VisualizationTabWidget *tab);
                 // IVisualizationWidget interface
                 void accept(IVisualizationWidgetVisitor *visitor) override;
+                bool canDrop(const Variable &variable) const override;
                 void close() override;
                 QString name() const;
             public slots:
                 /**
                  * Displays a variable in a new graph of a new zone of the current tab
                  * @param variable the variable to display
                  * @todo this is a temporary method that will be replaced by own actions for each type of
                  * visualization widget
                  */
                 void displayVariable(std::shared_ptr<Variable> variable) noexcept;
             private:
                 Ui::VisualizationWidget *ui;
             };
             #endif // VISUALIZATIONWIDGET_H

gui/include/Visualization/VisualizationZoneWidget.h +1 0

             #ifndef SCIQLOP_VISUALIZATIONZONEWIDGET_H
             #define SCIQLOP_VISUALIZATIONZONEWIDGET_H
             #include "Visualization/IVisualizationWidget.h"
             #include <QWidget>
             namespace Ui {
             class VisualizationZoneWidget;
             } // Ui
             class Variable;
             class VisualizationGraphWidget;
             class VisualizationZoneWidget : public QWidget, public IVisualizationWidget {
                 Q_OBJECT
             public:
                 explicit VisualizationZoneWidget(const QString &name = {}, QWidget *parent = 0);
                 virtual ~VisualizationZoneWidget();
                 /// Add a graph widget
                 void addGraph(VisualizationGraphWidget *graphWidget);
                 /**
                  * Creates a graph using a variable. The variable will be displayed in the new graph.
                  * @param variable the variable for which to create the graph
                  * @return the pointer to the created graph
                  */
                 VisualizationGraphWidget *createGraph(std::shared_ptr<Variable> variable);
                 /// Remove a graph
                 void removeGraph(VisualizationGraphWidget *graph);
                 // IVisualizationWidget interface
                 void accept(IVisualizationWidgetVisitor *visitor) override;
+                bool canDrop(const Variable &variable) const override;
                 void close() override;
                 QString name() const override;
             private:
                 Ui::VisualizationZoneWidget *ui;
             };
             #endif // SCIQLOP_VISUALIZATIONZONEWIDGET_H

gui/src/Visualization/VisualizationGraphWidget.cpp +7 0

             #include "Visualization/VisualizationGraphWidget.h"
             #include "Visualization/GraphPlottablesFactory.h"
             #include "Visualization/IVisualizationWidgetVisitor.h"
             #include "ui_VisualizationGraphWidget.h"
             #include <Variable/Variable.h>
             #include <unordered_map>
             namespace {
             /// Key pressed to enable zoom on horizontal axis
             const auto HORIZONTAL_ZOOM_MODIFIER = Qt::NoModifier;
             /// Key pressed to enable zoom on vertical axis
             const auto VERTICAL_ZOOM_MODIFIER = Qt::ControlModifier;
             } // namespace
             struct VisualizationGraphWidget::VisualizationGraphWidgetPrivate {
                 // 1 variable -> n qcpplot
                 std::unordered_map<std::shared_ptr<Variable>, QCPAbstractPlottable *> m_VariableToPlotMap;
             };
             VisualizationGraphWidget::VisualizationGraphWidget(const QString &name, QWidget *parent)
                     : QWidget{parent},
                       ui{new Ui::VisualizationGraphWidget},
                       impl{spimpl::make_unique_impl<VisualizationGraphWidgetPrivate>()}
             {
                 ui->setupUi(this);
                 // qcpplot title
                 ui->widget->plotLayout()->insertRow(0);
                 ui->widget->plotLayout()->addElement(0, 0, new QCPTextElement{ui->widget, name});
                 // Set qcpplot properties :
                 // - Drag (on x-axis) and zoom are enabled
                 // - Mouse wheel on qcpplot is intercepted to determine the zoom orientation
                 ui->widget->setInteractions(QCP::iRangeDrag | QCP::iRangeZoom);
                 ui->widget->axisRect()->setRangeDrag(Qt::Horizontal);
                 connect(ui->widget, &QCustomPlot::mouseWheel, this, &VisualizationGraphWidget::onMouseWheel);
             }
             VisualizationGraphWidget::~VisualizationGraphWidget()
             {
                 delete ui;
             }
             void VisualizationGraphWidget::addVariable(std::shared_ptr<Variable> variable)
             {
                 // Uses delegate to create the qcpplot components according to the variable
                 auto createdPlottables = GraphPlottablesFactory::create(variable, *ui->widget);
                 for (auto createdPlottable : qAsConst(createdPlottables)) {
                     impl->m_VariableToPlotMap.insert({variable, createdPlottable});
                 }
             }
             void VisualizationGraphWidget::accept(IVisualizationWidgetVisitor *visitor)
             {
                 if (visitor) {
                     visitor->visit(this);
                 }
             }
+            bool VisualizationGraphWidget::canDrop(const Variable &variable) const
+            {
+                /// @todo : for the moment, a graph can always accomodate a variable
+                Q_UNUSED(variable);
+                return true;
+            }
             void VisualizationGraphWidget::close()
             {
                 // The main view cannot be directly closed.
                 return;
             }
             QString VisualizationGraphWidget::name() const
             {
                 if (auto title = dynamic_cast<QCPTextElement *>(ui->widget->plotLayout()->elementAt(0))) {
                     return title->text();
                 }
                 else {
                     return QString{};
                 }
             }
             void VisualizationGraphWidget::onMouseWheel(QWheelEvent *event) noexcept
             {
                 auto zoomOrientations = QFlags<Qt::Orientation>{};
                 // Lambda that enables a zoom orientation if the key modifier related to this orientation has
                 // been pressed
                 auto enableOrientation
                     = [&zoomOrientations, event](const auto &orientation, const auto &modifier) {
                           auto orientationEnabled = event->modifiers().testFlag(modifier);
                           zoomOrientations.setFlag(orientation, orientationEnabled);
                       };
                 enableOrientation(Qt::Vertical, VERTICAL_ZOOM_MODIFIER);
                 enableOrientation(Qt::Horizontal, HORIZONTAL_ZOOM_MODIFIER);
                 ui->widget->axisRect()->setRangeZoom(zoomOrientations);
             }

gui/src/Visualization/VisualizationTabWidget.cpp +7 0

             #include "Visualization/VisualizationTabWidget.h"
             #include "Visualization/IVisualizationWidgetVisitor.h"
             #include "ui_VisualizationTabWidget.h"
             #include "Visualization/VisualizationZoneWidget.h"
             namespace {
             /// Generates a default name for a new zone, according to the number of zones already displayed in
             /// the tab
             QString defaultZoneName(const QLayout &layout)
             {
                 auto count = 0;
                 for (auto i = 0; i < layout.count(); ++i) {
                     if (dynamic_cast<VisualizationZoneWidget *>(layout.itemAt(i)->widget())) {
                         count++;
                     }
                 }
                 return QObject::tr("Zone %1").arg(count + 1);
             }
             } // namespace
             struct VisualizationTabWidget::VisualizationTabWidgetPrivate {
                 explicit VisualizationTabWidgetPrivate(const QString &name) : m_Name{name} {}
                 QString m_Name;
             };
             VisualizationTabWidget::VisualizationTabWidget(const QString &name, QWidget *parent)
                     : QWidget{parent},
                       ui{new Ui::VisualizationTabWidget},
                       impl{spimpl::make_unique_impl<VisualizationTabWidgetPrivate>(name)}
             {
                 ui->setupUi(this);
             }
             VisualizationTabWidget::~VisualizationTabWidget()
             {
                 delete ui;
             }
             void VisualizationTabWidget::addZone(VisualizationZoneWidget *zoneWidget)
             {
                 this->layout()->addWidget(zoneWidget);
             }
             VisualizationZoneWidget *VisualizationTabWidget::createZone(std::shared_ptr<Variable> variable)
             {
                 auto zoneWidget = new VisualizationZoneWidget{defaultZoneName(*layout()), this};
                 this->addZone(zoneWidget);
                 // Creates a new graph into the zone
                 zoneWidget->createGraph(variable);
                 return zoneWidget;
             }
             void VisualizationTabWidget::removeZone(VisualizationZoneWidget *zone)
             {
             }
             void VisualizationTabWidget::accept(IVisualizationWidgetVisitor *visitor)
             {
                 if (visitor) {
                     visitor->visitEnter(this);
                     // Apply visitor to zone children
                     for (auto i = 0; i < layout()->count(); ++i) {
                         if (auto item = layout()->itemAt(i)) {
                             if (auto visualizationZoneWidget
                                 = dynamic_cast<VisualizationZoneWidget *>(item->widget())) {
                                 visualizationZoneWidget->accept(visitor);
                             }
                         }
                     }
                     visitor->visitLeave(this);
                 }
             }
+            bool VisualizationTabWidget::canDrop(const Variable &variable) const
+            {
+                // A tab can always accomodate a variable
+                Q_UNUSED(variable);
+                return true;
+            }
             void VisualizationTabWidget::close()
             {
                 // The main view cannot be directly closed.
                 return;
             }
             QString VisualizationTabWidget::name() const
             {
                 return impl->m_Name;
             }

gui/src/Visualization/VisualizationWidget.cpp +7 0

             #include "Visualization/VisualizationWidget.h"
             #include "Visualization/IVisualizationWidgetVisitor.h"
             #include "Visualization/VisualizationGraphWidget.h"
             #include "Visualization/VisualizationTabWidget.h"
             #include "Visualization/VisualizationZoneWidget.h"
             #include "Visualization/qcustomplot.h"
             #include "ui_VisualizationWidget.h"
             #include <QToolButton>
             Q_LOGGING_CATEGORY(LOG_VisualizationWidget, "VisualizationWidget")
             VisualizationWidget::VisualizationWidget(QWidget *parent)
                     : QWidget{parent}, ui{new Ui::VisualizationWidget}
             {
                 ui->setupUi(this);
                 auto addTabViewButton = new QToolButton{ui->tabWidget};
                 addTabViewButton->setText(tr("Add View"));
                 addTabViewButton->setCursor(Qt::ArrowCursor);
                 ui->tabWidget->setCornerWidget(addTabViewButton, Qt::TopRightCorner);
                 auto enableMinimumCornerWidgetSize = [this](bool enable) {
                     auto tabViewCornerWidget = ui->tabWidget->cornerWidget();
                     auto width = enable ? tabViewCornerWidget->width() : 0;
                     auto height = enable ? tabViewCornerWidget->height() : 0;
                     tabViewCornerWidget->setMinimumHeight(height);
                     tabViewCornerWidget->setMinimumWidth(width);
                     ui->tabWidget->setMinimumHeight(height);
                     ui->tabWidget->setMinimumWidth(width);
                 };
                 auto addTabView = [this, enableMinimumCornerWidgetSize]() {
                     auto widget = new VisualizationTabWidget{QString{"View %1"}.arg(ui->tabWidget->count() + 1),
                                                              ui->tabWidget};
                     auto index = ui->tabWidget->addTab(widget, widget->name());
                     if (ui->tabWidget->count() > 0) {
                         enableMinimumCornerWidgetSize(false);
                     }
                     qCInfo(LOG_VisualizationWidget()) << tr("add the tab of index %1").arg(index);
                 };
                 auto removeTabView = [this, enableMinimumCornerWidgetSize](int index) {
                     if (ui->tabWidget->count() == 1) {
                         enableMinimumCornerWidgetSize(true);
                     }
                     ui->tabWidget->removeTab(index);
                     qCInfo(LOG_VisualizationWidget()) << tr("remove the tab of index %1").arg(index);
                 };
                 ui->tabWidget->setTabsClosable(true);
                 connect(addTabViewButton, &QToolButton::clicked, addTabView);
                 connect(ui->tabWidget, &QTabWidget::tabCloseRequested, removeTabView);
                 // Adds default tab
                 addTabView();
             }
             VisualizationWidget::~VisualizationWidget()
             {
                 delete ui;
             }
             void VisualizationWidget::addTab(VisualizationTabWidget *tabWidget)
             {
                 // NOTE: check is this method has to be deleted because of its dupplicated version visible as
                 // lambda function (in the constructor)
             }
             VisualizationTabWidget *VisualizationWidget::createTab()
             {
             }
             void VisualizationWidget::removeTab(VisualizationTabWidget *tab)
             {
                 // NOTE: check is this method has to be deleted because of its dupplicated version visible as
                 // lambda function (in the constructor)
             }
             void VisualizationWidget::accept(IVisualizationWidgetVisitor *visitor)
             {
                 if (visitor) {
                     visitor->visitEnter(this);
                     // Apply visitor for tab children
                     for (auto i = 0; i < ui->tabWidget->count(); ++i) {
                         if (auto visualizationTabWidget
                             = dynamic_cast<VisualizationTabWidget *>(ui->tabWidget->widget(i))) {
                             visualizationTabWidget->accept(visitor);
                         }
                     }
                     visitor->visitLeave(this);
                 }
             }
+            bool VisualizationWidget::canDrop(const Variable &variable) const
+            {
+                // The main widget can never accomodate a variable
+                Q_UNUSED(variable);
+                return false;
+            }
             void VisualizationWidget::close()
             {
                 // The main view cannot be directly closed.
                 return;
             }
             QString VisualizationWidget::name() const
             {
                 return QStringLiteral("MainView");
             }
             void VisualizationWidget::displayVariable(std::shared_ptr<Variable> variable) noexcept
             {
                 if (auto currentTab = dynamic_cast<VisualizationTabWidget *>(ui->tabWidget->currentWidget())) {
                     if (!currentTab->createZone(variable)) {
                         qCCritical(LOG_VisualizationWidget())
                             << tr("Can't display the variable : can't create a new zone in the current tab");
                     }
                 }
                 else {
                     qCCritical(LOG_VisualizationWidget())
                         << tr("Can't display the variable : there is no current tab");
                 }
             }

gui/src/Visualization/VisualizationZoneWidget.cpp +7 0

             #include "Visualization/VisualizationZoneWidget.h"
             #include "Visualization/IVisualizationWidgetVisitor.h"
             #include "ui_VisualizationZoneWidget.h"
             #include "Visualization/VisualizationGraphWidget.h"
             namespace {
             /// Generates a default name for a new graph, according to the number of graphs already displayed in
             /// the zone
             QString defaultGraphName(const QLayout &layout)
             {
                 auto count = 0;
                 for (auto i = 0; i < layout.count(); ++i) {
                     if (dynamic_cast<VisualizationGraphWidget *>(layout.itemAt(i)->widget())) {
                         count++;
                     }
                 }
                 return QObject::tr("Graph %1").arg(count + 1);
             }
             } // namespace
             VisualizationZoneWidget::VisualizationZoneWidget(const QString &name, QWidget *parent)
                     : QWidget{parent}, ui{new Ui::VisualizationZoneWidget}
             {
                 ui->setupUi(this);
                 ui->zoneNameLabel->setText(name);
             }
             VisualizationZoneWidget::~VisualizationZoneWidget()
             {
                 delete ui;
             }
             void VisualizationZoneWidget::addGraph(VisualizationGraphWidget *graphWidget)
             {
                 ui->visualizationZoneFrame->layout()->addWidget(graphWidget);
             }
             VisualizationGraphWidget *VisualizationZoneWidget::createGraph(std::shared_ptr<Variable> variable)
             {
                 auto graphWidget = new VisualizationGraphWidget{
                     defaultGraphName(*ui->visualizationZoneFrame->layout()), this};
                 this->addGraph(graphWidget);
                 graphWidget->addVariable(variable);
                 return graphWidget;
             }
             void VisualizationZoneWidget::removeGraph(VisualizationGraphWidget *graph)
             {
             }
             void VisualizationZoneWidget::accept(IVisualizationWidgetVisitor *visitor)
             {
                 if (visitor) {
                     visitor->visitEnter(this);
                     // Apply visitor to graph children
                     auto layout = ui->visualizationZoneFrame->layout();
                     for (auto i = 0; i < layout->count(); ++i) {
                         if (auto item = layout->itemAt(i)) {
                             if (auto visualizationGraphWidget
                                 = dynamic_cast<VisualizationGraphWidget *>(item->widget())) {
                                 visualizationGraphWidget->accept(visitor);
                             }
                         }
                     }
                     visitor->visitLeave(this);
                 }
             }
+            bool VisualizationZoneWidget::canDrop(const Variable &variable) const
+            {
+                // A tab can always accomodate a variable
+                Q_UNUSED(variable);
+                return true;
+            }
             void VisualizationZoneWidget::close()
             {
                 // The main view cannot be directly closed.
                 return;
             }
             QString VisualizationZoneWidget::name() const
             {
                 return ui->zoneNameLabel->text();
             }

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