iio-widgets: Add empty data strategy

Signed-off-by: Andrei-Fabian-Pop <Andreifabian.Pop@analog.com>

Author: Andrei-Fabian-Pop

iio-widgets/include/iio-widgets/datastrategy/emptydatastrategy.h

@@ -0,0 +1,36 @@
+#ifndef EMPTYDATASTRATEGY_H
+#define EMPTYDATASTRATEGY_H
+
+#include <QObject>
+#include "datastrategy/datastrategyinterface.h"
+#include "scopy-iio-widgets_export.h"
+
+namespace scopy {
+class SCOPY_IIO_WIDGETS_EXPORT EmptyDataStrategy : public QObject, public DataStrategyInterface
+{
+	Q_OBJECT
+	Q_INTERFACES(scopy::DataStrategyInterface)
+public:
+	explicit EmptyDataStrategy(QObject *parent = nullptr);
+
+	QString data() override;
+	QString optionalData() override;
+
+public Q_SLOTS:
+	int write(QString data) override;
+	QPair<QString, QString> read() override;
+	void writeAsync(QString data) override;
+	void readAsync() override;
+
+Q_SIGNALS:
+	void sendData(QString data, QString dataOptions) override;
+	void aboutToWrite(QString oldData, QString newData) override;
+	void emitStatus(QDateTime timestamp, QString oldData, QString newData, int returnCode, bool isReadOp) override;
+
+private:
+	QString m_data;
+	QString m_previousData;
+};
+} // namespace scopy
+
+#endif // EMPTYDATASTRATEGY_H

iio-widgets/include/iio-widgets/iioconfigurationpopup.h

@@ -25,6 +25,7 @@ class SCOPY_IIO_WIDGETS_EXPORT IIOConfigurationPopup : public QWidget
 
 Q_SIGNALS:
 	void selectButtonClicked(IIOItem *selected);
+	void emptyButtonClicked();
 	void exitButtonClicked();
 
 protected Q_SLOTS:
@@ -39,6 +40,7 @@ protected Q_SLOTS:
 	IIOWidgetSelector *m_widgetSelector;
 	QPushButton *m_exitButton;
 	QPushButton *m_selectButton;
+	QPushButton *m_emptyButton;
 	IIOItem *m_root;
 };
 } // namespace scopy

iio-widgets/include/iio-widgets/iiowidget.h

@@ -124,7 +124,20 @@ class SCOPY_IIO_WIDGETS_EXPORT IIOWidget : public QWidget
 	 */
 	int lastReturnCode();
 
+	/**
+	 * @brief setUItoDataConversion Adds a function that is called before sending the data given as imput by the
+	 * user and modifies this data. The function receives as parameter a QString, converts it and returns the
+	 * converted string that will be sent to the DS after.
+	 * @param func std::function<QString(QString)>
+	 */
 	void setUItoDataConversion(std::function<QString(QString)> func);
+
+	/**
+	 * @brief setDataToUIConversion Adds a function that is called before sending the data read by the IIOWidget
+	 * and modifies this data. The function receives as parameter a QString, converts it and returns the
+	 * converted string that will be sent to the UI after.
+	 * @param func std::function<QString(QString)>
+	 */
 	void setDataToUIConversion(std::function<QString(QString)> func);
 
 	/**
@@ -239,12 +252,12 @@ protected Q_SLOTS:
 	void setLastOperationTimestamp(QDateTime timestamp);
 	void setLastOperationState(IIOWidget::State state);
 
-	// Core variables
+	/* Core variables */
 	GuiStrategyInterface *m_uiStrategy;
 	DataStrategyInterface *m_dataStrategy;
 	IIOWidgetFactoryRecipe m_recipe;
 
-	// Logged data
+	/* Logged data */
 	QString m_lastData;
 	SmallProgressBar *m_progressBar;
 	QDateTime *m_lastOpTimestamp;
@@ -255,7 +268,7 @@ protected Q_SLOTS:
 	std::function<QString(QString)> m_UItoDS;
 	std::function<QString(QString)> m_DStoUI;
 
-	// Optional configuration
+	/* Optional configuration */
 	QPushButton *m_configBtn;
 	IIOConfigurationPopup *m_configPopup;
 	bool m_isConfigurable;

iio-widgets/include/iio-widgets/iiowidgetbuilder.h

@@ -42,6 +42,7 @@ class SCOPY_IIO_WIDGETS_EXPORT IIOWidgetBuilder : public QObject
 		TriggerData,
 		DeviceAttrData,
 		ContextAttrData,
+		EmptyData,
 	};
 
 	enum UIS
@@ -53,7 +54,7 @@ class SCOPY_IIO_WIDGETS_EXPORT IIOWidgetBuilder : public QObject
 		RangeUi,
 	};
 
-	explicit IIOWidgetBuilder(QObject *parent = nullptr);
+	explicit IIOWidgetBuilder(QWidget *parent = nullptr);
 	~IIOWidgetBuilder();
 
 	/**
@@ -109,6 +110,13 @@ class SCOPY_IIO_WIDGETS_EXPORT IIOWidgetBuilder : public QObject
 	 */
 	IIOWidgetBuilder &configMode(bool isConfigurable);
 
+	/**
+	 * @brief title Sets the title of the IIOWidget
+	 * @param title QString
+	 * @return
+	 */
+	IIOWidgetBuilder &title(QString title);
+
 	/**
 	 * @brief Sets the context that will be used, if no iio_device or iio_channel
 	 * is set, the build functions will work with the context.
@@ -168,12 +176,6 @@ class SCOPY_IIO_WIDGETS_EXPORT IIOWidgetBuilder : public QObject
 	 */
 	IIOWidgetBuilder &uiStrategy(IIOWidgetBuilder::UIS uiStrategy);
 
-	/**
-	 * @brief Sets the parent of the IIOWidget that will be built.
-	 * @param parent
-	 */
-	IIOWidgetBuilder &parent(QWidget *parent);
-
 private:
 	DataStrategyInterface *createDS();
 	GuiStrategyInterface *createUIS();
@@ -188,6 +190,7 @@ class SCOPY_IIO_WIDGETS_EXPORT IIOWidgetBuilder : public QObject
 	QString m_attribute;
 	QString m_optionsAttribute;
 	QString m_optionsValues;
+	QString m_title;
 	IIOWidgetBuilder::DS m_dataStrategy;
 	IIOWidgetBuilder::UIS m_uiStrategy;
 	QWidget *m_widgetParent;

iio-widgets/src/datastrategy/emptydatastrategy.cpp

@@ -0,0 +1,38 @@
+#include "emptydatastrategy.h"
+
+using namespace scopy;
+
+EmptyDataStrategy::EmptyDataStrategy(QObject *parent)
+	: QObject{parent}
+	, m_data("")
+	, m_previousData("")
+{}
+
+QString EmptyDataStrategy::data() { return m_data; }
+
+QString EmptyDataStrategy::optionalData() { return ""; }
+
+int EmptyDataStrategy::write(QString data)
+{
+	m_previousData = data;
+	m_data = data;
+	return 0;
+}
+
+QPair<QString, QString> EmptyDataStrategy::read() { return {m_data, ""}; }
+
+void EmptyDataStrategy::writeAsync(QString data)
+{
+	int res = write(data);
+	Q_EMIT emitStatus(QDateTime::currentDateTime(), m_data, data, (int)(res), false);
+	readAsync();
+}
+
+void EmptyDataStrategy::readAsync()
+{
+	QPair<QString, QString> res = read();
+	Q_EMIT emitStatus(QDateTime::currentDateTime(), m_previousData, m_data, 0, true);
+	Q_EMIT sendData(res.first, res.second);
+}
+
+#include "moc_emptydatastrategy.cpp"

iio-widgets/src/iioconfigurationpopup.cpp

@@ -134,6 +134,7 @@ void IIOConfigurationPopup::init()
 
 		Q_EMIT selectButtonClicked(iioItem);
 	});
+	QObject::connect(m_emptyButton, &QPushButton::clicked, this, &IIOConfigurationPopup::emptyButtonClicked);
 	QObject::connect(m_exitButton, &QPushButton::clicked, this, &IIOConfigurationPopup::exitButtonClicked);
 	m_selectButton->setDisabled(true);
 }
@@ -161,12 +162,11 @@ void IIOConfigurationPopup::initUI()
 	buttonGroupLayout->setSpacing(10);
 
 	m_selectButton = new QPushButton("Select", buttonGroup);
-	m_selectButton->setObjectName("selectButton");
-
+	m_emptyButton = new QPushButton("No Data", buttonGroup);
 	m_exitButton = new QPushButton("Exit", buttonGroup);
-	m_exitButton->setObjectName("exitButton");
 
 	buttonGroupLayout->addWidget(m_exitButton);
+	buttonGroupLayout->addWidget(m_emptyButton);
 	buttonGroupLayout->addWidget(m_selectButton);
 
 	backgroundLayout->addWidget(m_titleLabel);
@@ -175,9 +175,10 @@ void IIOConfigurationPopup::initUI()
 
 	backgroundWidget->setLayout(backgroundLayout);
 
-	StyleHelper::TutorialChapterTitleLabel(m_titleLabel, "titleLabel");
-	StyleHelper::BlueButton(m_selectButton, "selectButton");
-	StyleHelper::BlueButton(m_exitButton, "exitButton");
+	StyleHelper::TutorialChapterTitleLabel(m_titleLabel, "TitleLabel");
+	StyleHelper::BlueButton(m_selectButton, "SelectButton");
+	StyleHelper::BlueButton(m_emptyButton, "EmptyButton");
+	StyleHelper::BlueButton(m_exitButton, "ExitButton");
 	StyleHelper::OverlayMenu(this, "IIOConfigurationPopupOverlay");
 }
 

iio-widgets/src/iiowidget.cpp

@@ -19,16 +19,18 @@
  */
 
 #include "iiowidget.h"
-#include "channelattrdatastrategy.h"
-#include "contextattrdatastrategy.h"
-#include "deviceattrdatastrategy.h"
-#include "iiowidgetselector.h"
+#include "datastrategy/channelattrdatastrategy.h"
+#include "datastrategy/contextattrdatastrategy.h"
+#include "datastrategy/deviceattrdatastrategy.h"
+#include "datastrategy/emptydatastrategy.h"
+
 #include <iioutil/connectionprovider.h>
-#include <QDateTime>
-#include <QApplication>
 #include <pluginbase/preferences.h>
 #include <gui/utils.h>
 
+#include <QDateTime>
+#include <QApplication>
+
 using namespace scopy;
 
 Q_LOGGING_CATEGORY(CAT_IIOWIDGET, "iioWidget")
@@ -46,15 +48,27 @@ IIOWidget::IIOWidget(GuiStrategyInterface *uiStrategy, DataStrategyInterface *da
 	, m_DStoUI(nullptr)
 	, m_isConfigurable(false)
 {
+	// Config button
+	m_configBtn->setStyleSheet("border-image: url(\":/gui/icons/scopy-default/icons/gear_wheel.svg\");");
+	m_configBtn->setVisible(m_isConfigurable);
+
+	// General layout
 	setLayout(new QVBoxLayout(this));
 	layout()->setContentsMargins(0, 0, 0, 0);
 	layout()->setSpacing(0);
 	setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Fixed);
 
+	QWidget *topWidget = new QWidget(this);
+	topWidget->setLayout(new QHBoxLayout(topWidget));
+	topWidget->layout()->setContentsMargins(0, 0, 0, 0);
+
 	QWidget *ui = m_uiStrategy->ui();
 	if(ui) {
-		layout()->addWidget(ui);
+		topWidget->layout()->addWidget(ui);
 	}
+	topWidget->layout()->addWidget(m_configBtn);
+
+	layout()->addWidget(topWidget);
 	layout()->addWidget(m_progressBar);
 
 	QObject *uiStrategyObject = dynamic_cast<QObject *>(m_uiStrategy);
@@ -65,23 +79,31 @@ IIOWidget::IIOWidget(GuiStrategyInterface *uiStrategy, DataStrategyInterface *da
 
 	connect(m_progressBar, &SmallProgressBar::progressFinished, this,
 		[this]() { this->convertUItoDS(m_lastData); });
+	connect(m_configBtn, &QPushButton::clicked, this, &IIOWidget::reconfigure);
 
 	connect(uiStrategyObject, SIGNAL(emitData(QString)), this, SLOT(startTimer(QString)));
+	connect(uiStrategyObject, SIGNAL(emitData(QString)), this, SIGNAL(emitData(QString)));
+	connect(uiStrategyObject, SIGNAL(displayedNewData(QString, QString)), this,
+		SIGNAL(displayedNewData(QString, QString)));
 
 	connect(dataStrategyObject, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
 		SLOT(emitDataStatus(QDateTime, QString, QString, int, bool)));
 
 	// forward data request from ui strategy to data strategy
 	connect(uiStrategyObject, SIGNAL(requestData()), dataStrategyObject, SLOT(readAsync()));
+	connect(dataStrategyObject, SIGNAL(sendData(QString, QString)), this, SIGNAL(sendData(QString, QString)));
+	connect(dataStrategyObject, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
+		SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)));
 
 	// forward data from data strategy to ui strategy
 	connect(dataStrategyObject, SIGNAL(sendData(QString, QString)), this, SLOT(convertDStoUI(QString, QString)));
+	connect(dataStrategyObject, SIGNAL(aboutToWrite(QString, QString)), this,
+		SIGNAL(aboutToWrite(QString, QString)));
 
 	// intercept the sendData from dataStrategy to collect information
 	connect(dataStrategyObject, SIGNAL(sendData(QString, QString)), this, SLOT(storeReadInfo(QString, QString)));
 
-	// The data will be populated here
-	bool useLazyLoading = Preferences::GetInstance()->get("iiowidgets_use_lazy_loading").toBool();
+	bool useLazyLoading = Preferences::get("iiowidgets_use_lazy_loading").toBool();
 	if(!useLazyLoading) { // force skip lazy load
 		LAZY_LOAD(initialize);
 	}
@@ -97,41 +119,41 @@ void IIOWidget::writeAsync(QString data) { m_dataStrategy->writeAsync(data); }
 
 DataStrategyInterface *IIOWidget::swapDataStrategy(DataStrategyInterface *dataStrategy)
 {
-	QWidget *dataStrategyWidget = dynamic_cast<QWidget *>(m_dataStrategy);
-	QWidget *uiStrategyWidget = dynamic_cast<QWidget *>(m_uiStrategy);
-	QWidget *newDataStrategyWidget = dynamic_cast<QWidget *>(dataStrategy);
+	QObject *dataStrategyObject = dynamic_cast<QObject *>(m_dataStrategy);
+	QObject *uiStrategyObject = dynamic_cast<QObject *>(m_uiStrategy);
+	QObject *newDataStrategyObject = dynamic_cast<QObject *>(dataStrategy);
 
 	// disconnect old data strategy
-	disconnect(dataStrategyWidget, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
+	disconnect(dataStrategyObject, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
 		   SLOT(emitDataStatus(QDateTime, QString, QString, int, bool)));
-	disconnect(uiStrategyWidget, SIGNAL(requestData()), dataStrategyWidget, SLOT(readAsync()));
-	disconnect(dataStrategyWidget, SIGNAL(sendData(QString, QString)), uiStrategyWidget,
+	disconnect(uiStrategyObject, SIGNAL(requestData()), dataStrategyObject, SLOT(readAsync()));
+	disconnect(dataStrategyObject, SIGNAL(sendData(QString, QString)), uiStrategyObject,
 		   SLOT(receiveData(QString, QString)));
-	disconnect(dataStrategyWidget, SIGNAL(sendData(QString, QString)), this,
+	disconnect(dataStrategyObject, SIGNAL(sendData(QString, QString)), this,
 		   SLOT(storeReadInfo(QString, QString))); // TODO: maybe do something with this slot..
-	disconnect(dataStrategyWidget, SIGNAL(sendData(QString, QString)), this, SIGNAL(sendData(QString, QString)));
-	disconnect(dataStrategyWidget, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
+	disconnect(dataStrategyObject, SIGNAL(sendData(QString, QString)), this, SIGNAL(sendData(QString, QString)));
+	disconnect(dataStrategyObject, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
 		   SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)));
-	disconnect(dataStrategyWidget, SIGNAL(aboutToWrite(QString, QString)), this,
+	disconnect(dataStrategyObject, SIGNAL(aboutToWrite(QString, QString)), this,
 		   SIGNAL(aboutToWrite(QString, QString)));
-	disconnect(uiStrategyWidget, SIGNAL(emitData(QString)), this, SIGNAL(emitData(QString)));
-	disconnect(uiStrategyWidget, SIGNAL(displayedNewData(QString, QString)), this,
+	disconnect(uiStrategyObject, SIGNAL(emitData(QString)), this, SIGNAL(emitData(QString)));
+	disconnect(uiStrategyObject, SIGNAL(displayedNewData(QString, QString)), this,
 		   SIGNAL(displayedNewData(QString, QString)));
 
 	// connect new data strategy
-	connect(newDataStrategyWidget, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
+	connect(newDataStrategyObject, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
 		SLOT(emitDataStatus(QDateTime, QString, QString, int, bool)));
-	connect(uiStrategyWidget, SIGNAL(requestData()), newDataStrategyWidget, SLOT(readAsync()));
-	connect(newDataStrategyWidget, SIGNAL(sendData(QString, QString)), uiStrategyWidget,
+	connect(uiStrategyObject, SIGNAL(requestData()), newDataStrategyObject, SLOT(readAsync()));
+	connect(newDataStrategyObject, SIGNAL(sendData(QString, QString)), uiStrategyObject,
 		SLOT(receiveData(QString, QString)));
-	connect(newDataStrategyWidget, SIGNAL(sendData(QString, QString)), this, SLOT(storeReadInfo(QString, QString)));
-	connect(dataStrategyWidget, SIGNAL(sendData(QString, QString)), this, SIGNAL(sendData(QString, QString)));
-	connect(dataStrategyWidget, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
+	connect(newDataStrategyObject, SIGNAL(sendData(QString, QString)), this, SLOT(storeReadInfo(QString, QString)));
+	connect(dataStrategyObject, SIGNAL(sendData(QString, QString)), this, SLOT(convertDStoUI(QString, QString)));
+	connect(dataStrategyObject, SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)), this,
 		SIGNAL(emitStatus(QDateTime, QString, QString, int, bool)));
-	connect(dataStrategyWidget, SIGNAL(aboutToWrite(QString, QString)), this,
+	connect(dataStrategyObject, SIGNAL(aboutToWrite(QString, QString)), this,
 		SIGNAL(aboutToWrite(QString, QString)));
-	connect(uiStrategyWidget, SIGNAL(emitData(QString)), this, SIGNAL(emitData(QString)));
-	connect(uiStrategyWidget, SIGNAL(displayedNewData(QString, QString)), this,
+	connect(uiStrategyObject, SIGNAL(emitData(QString)), this, SIGNAL(emitData(QString)));
+	connect(uiStrategyObject, SIGNAL(displayedNewData(QString, QString)), this,
 		SIGNAL(displayedNewData(QString, QString)));
 
 	// save the new data strategy and return the old one
@@ -263,6 +285,13 @@ void IIOWidget::reconfigure()
 
 	connect(m_configPopup, &IIOConfigurationPopup::exitButtonClicked, this,
 		[&]() { m_configPopup->deleteLater(); });
+	connect(m_configPopup, &IIOConfigurationPopup::emptyButtonClicked, this, [&]() {
+		DataStrategyInterface *ds = new EmptyDataStrategy(this);
+		DataStrategyInterface *oldDS = swapDataStrategy(ds);
+		delete oldDS;
+		delete m_configPopup;
+		m_uiStrategy->changeName("Empty");
+	});
 	connect(m_configPopup, &IIOConfigurationPopup::selectButtonClicked, this, [&](IIOItem *item) {
 		DataStrategyInterface *dsCreated = nullptr;
 		switch(item->type()) {