HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Commit - r408:49f712bf7e59

Updates IDataProvider::requestDataLoading() method's signature...

Alexandre Leroux -

r408:49f712bf7e59

parent child

Context file:

r408:49f712bf7e59

Collapse all files

core/include/Data/DataProviderParameters.h +1 -1

             #ifndef SCIQLOP_DATAPROVIDERPARAMETERS_H
             #define SCIQLOP_DATAPROVIDERPARAMETERS_H
             #include "SqpDateTime.h"
             /**
              * @brief The DataProviderParameters struct holds the information needed to retrieve data from a
              * data provider
              * @sa IDataProvider
              */
             struct DataProviderParameters {
-                SqpDateTime m_Time;
+                QVector<SqpDateTime> m_Times;
             };
             #endif // SCIQLOP_DATAPROVIDERPARAMETERS_H

core/include/Data/IDataProvider.h +2 -3

             #ifndef SCIQLOP_IDATAPROVIDER_H
             #define SCIQLOP_IDATAPROVIDER_H
             #include <memory>
             #include <QObject>
             #include <QUuid>
             #include <Common/MetaTypes.h>
             #include <Data/SqpDateTime.h>
             class DataProviderParameters;
             class IDataSeries;
             class QNetworkReply;
             class QNetworkRequest;
             /**
              * @brief The IDataProvider interface aims to declare a data provider.
              *
              * A data provider is an entity that generates data and returns it according to various parameters
              * (time interval, product to retrieve the data, etc.)
              *
              * @sa IDataSeries
              */
             class IDataProvider : public QObject {
                 Q_OBJECT
             public:
                 virtual ~IDataProvider() noexcept = default;
                 /**
-                 * @brief requestDataLoading provide datas for the data identified by identifier for all
+                 * @brief requestDataLoading provide datas for the data identified by identifier and parameters
-                 * SqpDateTime of dateTimeList
                  */
-                virtual void requestDataLoading(QUuid identifier, const QVector<SqpDateTime> &dateTimeList) = 0;
+                virtual void requestDataLoading(QUuid identifier, const DataProviderParameters &parameters) = 0;
             signals:
                 /**
                  * @brief dataProvided send dataSeries under dateTime and that corresponds of the data
                  * identified by identifier
                  */
                 void dataProvided(QUuid identifier, std::shared_ptr<IDataSeries> dateSerie,
                                   const SqpDateTime &dateTime);
                 /**
                  * @brief requestConstructed send a request for the data identified by identifier
                  * @callback is the methode call by the reply of the request when it is finished.
                  */
                 void requestConstructed(const QNetworkRequest &request, QUuid identifier,
                                         std::function<void(QNetworkReply *, QUuid)> callback);
             };
             // Required for using shared_ptr in signals/slots
             SCIQLOP_REGISTER_META_TYPE(IDATAPROVIDER_PTR_REGISTRY, std::shared_ptr<IDataProvider>)
             SCIQLOP_REGISTER_META_TYPE(IDATAPROVIDER_FUNCTION_REGISTRY,
                                        std::function<void(QNetworkReply *, QUuid)>)
             #endif // SCIQLOP_IDATAPROVIDER_H

core/src/Variable/VariableController.cpp +1 -1

             #include <Variable/Variable.h>
             #include <Variable/VariableCacheController.h>
             #include <Variable/VariableController.h>
             #include <Variable/VariableModel.h>
             #include <Data/DataProviderParameters.h>
             #include <Data/IDataProvider.h>
             #include <Data/IDataSeries.h>
             #include <Time/TimeController.h>
             #include <QDateTime>
             #include <QMutex>
             #include <QThread>
             #include <QUuid>
             #include <QtCore/QItemSelectionModel>
             #include <unordered_map>
             Q_LOGGING_CATEGORY(LOG_VariableController, "VariableController")
             struct VariableController::VariableControllerPrivate {
                 explicit VariableControllerPrivate(VariableController *parent)
                         : m_WorkingMutex{},
                           m_VariableModel{new VariableModel{parent}},
                           m_VariableSelectionModel{new QItemSelectionModel{m_VariableModel, parent}},
                           m_VariableCacheController{std::make_unique<VariableCacheController>()}
                 {
                 }
                 QMutex m_WorkingMutex;
                 /// Variable model. The VariableController has the ownership
                 VariableModel *m_VariableModel;
                 QItemSelectionModel *m_VariableSelectionModel;
                 TimeController *m_TimeController{nullptr};
                 std::unique_ptr<VariableCacheController> m_VariableCacheController;
                 std::unordered_map<std::shared_ptr<Variable>, std::shared_ptr<IDataProvider> >
                     m_VariableToProviderMap;
                 std::unordered_map<std::shared_ptr<Variable>, QUuid> m_VariableToIdentifier;
             };
             VariableController::VariableController(QObject *parent)
                     : QObject{parent}, impl{spimpl::make_unique_impl<VariableControllerPrivate>(this)}
             {
                 qCDebug(LOG_VariableController()) << tr("VariableController construction")
                                                   << QThread::currentThread();
             }
             VariableController::~VariableController()
             {
                 qCDebug(LOG_VariableController()) << tr("VariableController destruction")
                                                   << QThread::currentThread();
                 this->waitForFinish();
             }
             VariableModel *VariableController::variableModel() noexcept
             {
                 return impl->m_VariableModel;
             }
             QItemSelectionModel *VariableController::variableSelectionModel() noexcept
             {
                 return impl->m_VariableSelectionModel;
             }
             void VariableController::setTimeController(TimeController *timeController) noexcept
             {
                 impl->m_TimeController = timeController;
             }
             void VariableController::deleteVariable(std::shared_ptr<Variable> variable) noexcept
             {
                 if (!variable) {
                     qCCritical(LOG_VariableController()) << "Can't delete variable: variable is null";
                     return;
                 }
                 // Spreads in SciQlop that the variable will be deleted, so that potential receivers can
                 // make some treatments before the deletion
                 emit variableAboutToBeDeleted(variable);
                 // Deletes provider
                 auto nbProvidersDeleted = impl->m_VariableToProviderMap.erase(variable);
                 qCDebug(LOG_VariableController())
                     << tr("Number of providers deleted for variable %1: %2")
                            .arg(variable->name(), QString::number(nbProvidersDeleted));
                 // Clears cache
                 impl->m_VariableCacheController->clear(variable);
                 // Deletes from model
                 impl->m_VariableModel->deleteVariable(variable);
             }
             void VariableController::deleteVariables(
                 const QVector<std::shared_ptr<Variable> > &variables) noexcept
             {
                 for (auto variable : qAsConst(variables)) {
                     deleteVariable(variable);
                 }
             }
             void VariableController::createVariable(const QString &name,
                                                     std::shared_ptr<IDataProvider> provider) noexcept
             {
                 if (!impl->m_TimeController) {
                     qCCritical(LOG_VariableController())
                         << tr("Impossible to create variable: The time controller is null");
                     return;
                 }
                 /// @todo : for the moment :
                 /// - the provider is only used to retrieve data from the variable for its initialization, but
                 /// it will be retained later
                 /// - default data are generated for the variable, without taking into account the timerange set
                 /// in sciqlop
                 auto dateTime = impl->m_TimeController->dateTime();
                 if (auto newVariable = impl->m_VariableModel->createVariable(name, dateTime)) {
                     auto identifier = QUuid::createUuid();
                     // store the provider
                     impl->m_VariableToProviderMap[newVariable] = provider;
                     impl->m_VariableToIdentifier[newVariable] = identifier;
                     auto addDateTimeAcquired = [ this, varW = std::weak_ptr<Variable>{newVariable} ](
                         QUuid identifier, auto dataSeriesAcquired, auto dateTimeToPutInCache)
                     {
                         if (auto variable = varW.lock()) {
                             auto varIdentifier = impl->m_VariableToIdentifier.at(variable);
                             if (varIdentifier == identifier) {
                                 impl->m_VariableCacheController->addDateTime(variable, dateTimeToPutInCache);
                                 variable->setDataSeries(dataSeriesAcquired);
                             }
                         }
                     };
                     connect(provider.get(), &IDataProvider::dataProvided, addDateTimeAcquired);
                     this->onRequestDataLoading(newVariable, dateTime);
                 }
             }
             void VariableController::onDateTimeOnSelection(const SqpDateTime &dateTime)
             {
                 qCDebug(LOG_VariableController()) << "VariableController::onDateTimeOnSelection"
                                                   << QThread::currentThread()->objectName();
                 auto selectedRows = impl->m_VariableSelectionModel->selectedRows();
                 for (const auto &selectedRow : qAsConst(selectedRows)) {
                     if (auto selectedVariable = impl->m_VariableModel->variable(selectedRow.row())) {
                         selectedVariable->setDateTime(dateTime);
                         this->onRequestDataLoading(selectedVariable, dateTime);
                     }
                 }
             }
             void VariableController::onVariableRetrieveDataInProgress(QUuid identifier, double progress)
             {
                 auto findReply = [identifier](const auto &entry) { return identifier == entry.second; };
                 auto end = impl->m_VariableToIdentifier.cend();
                 auto it = std::find_if(impl->m_VariableToIdentifier.cbegin(), end, findReply);
                 if (it != end) {
                     impl->m_VariableModel->setDataProgress(it->first, progress);
                 }
             }
             void VariableController::onRequestDataLoading(std::shared_ptr<Variable> variable,
                                                           const SqpDateTime &dateTime)
             {
                 qCDebug(LOG_VariableController()) << "VariableController::onRequestDataLoading"
                                                   << QThread::currentThread()->objectName();
                 // we want to load data of the variable for the dateTime.
                 // First we check if the cache contains some of them.
                 // For the other, we ask the provider to give them.
                 if (variable) {
                     auto dateTimeListNotInCache
                         = impl->m_VariableCacheController->provideNotInCacheDateTimeList(variable, dateTime);
                     if (!dateTimeListNotInCache.empty()) {
                         // Ask the provider for each data on the dateTimeListNotInCache
                         auto identifier = impl->m_VariableToIdentifier.at(variable);
                         impl->m_VariableToProviderMap.at(variable)->requestDataLoading(
-                            identifier, std::move(dateTimeListNotInCache));
+                            identifier, DataProviderParameters{std::move(dateTimeListNotInCache)});
                     }
                     else {
                         emit variable->updated();
                     }
                 }
                 else {
                     qCCritical(LOG_VariableController()) << tr("Impossible to load data of a variable null");
                 }
             }
             void VariableController::initialize()
             {
                 qCDebug(LOG_VariableController()) << tr("VariableController init") << QThread::currentThread();
                 impl->m_WorkingMutex.lock();
                 qCDebug(LOG_VariableController()) << tr("VariableController init END");
             }
             void VariableController::finalize()
             {
                 impl->m_WorkingMutex.unlock();
             }
             void VariableController::waitForFinish()
             {
                 QMutexLocker locker{&impl->m_WorkingMutex};
             }

plugins/amda/include/AmdaProvider.h +2 -2

             #ifndef SCIQLOP_AMDAPROVIDER_H
             #define SCIQLOP_AMDAPROVIDER_H
             #include "AmdaGlobal.h"
             #include <Common/spimpl.h>
             #include <Data/IDataProvider.h>
             #include <QLoggingCategory>
             Q_DECLARE_LOGGING_CATEGORY(LOG_AmdaProvider)
             class QNetworkReply;
             /**
              * @brief The AmdaProvider class is an example of how a data provider can generate data
              */
             class SCIQLOP_AMDA_EXPORT AmdaProvider : public IDataProvider {
             public:
                 explicit AmdaProvider();
-                void requestDataLoading(QUuid token, const QVector<SqpDateTime> &dateTimeList) override;
+                void requestDataLoading(QUuid token, const DataProviderParameters &parameters) override;
             private:
-                void retrieveData(QUuid token, const DataProviderParameters &parameters);
+                void retrieveData(QUuid token, const SqpDateTime &dateTime);
                 class AmdaProviderPrivate;
                 spimpl::unique_impl_ptr<AmdaProviderPrivate> impl;
                 // private slots:
                 //    void httpFinished(QNetworkReply *reply, QUuid dataId) noexcept;
                 //    void httpDownloadFinished(QNetworkReply *reply, QUuid dataId) noexcept;
                 //    void httpDownloadReadyRead(QNetworkReply *reply, QUuid dataId) noexcept;
             };
             #endif // SCIQLOP_AMDAPROVIDER_H

plugins/amda/src/AmdaProvider.cpp +10 -9

             #include "AmdaProvider.h"
             #include "AmdaResultParser.h"
             #include <Data/DataProviderParameters.h>
             #include <Network/NetworkController.h>
             #include <SqpApplication.h>
             #include <Variable/Variable.h>
             #include <QNetworkAccessManager>
             #include <QNetworkReply>
             #include <QTemporaryFile>
             #include <QThread>
             Q_LOGGING_CATEGORY(LOG_AmdaProvider, "AmdaProvider")
             namespace {
             /// URL format for a request on AMDA server. The parameters are as follows:
             /// - %1: start date
             /// - %2: end date
             /// - %3: parameter id
             const auto AMDA_URL_FORMAT = QStringLiteral(
                 "http://amda.irap.omp.eu/php/rest/"
                 "getParameter.php?startTime=%1&stopTime=%2&parameterID=%3&sampling=60&outputFormat=ASCII&"
                 "timeFormat=ISO8601&gzip=0");
             /// Dates format passed in the URL (e.g 2013-09-23T09:00)
             const auto AMDA_TIME_FORMAT = QStringLiteral("yyyy-MM-ddThh:ss");
             /// Formats a time to a date that can be passed in URL
             QString dateFormat(double sqpDateTime) noexcept
             {
                 auto dateTime = QDateTime::fromMSecsSinceEpoch(sqpDateTime * 1000.);
                 return dateTime.toString(AMDA_TIME_FORMAT);
             }
             } // namespace
             struct AmdaProvider::AmdaProviderPrivate {
-                DataProviderParameters m_Params{};
+                SqpDateTime m_DateTime{};
                 std::unique_ptr<QNetworkAccessManager> m_AccessManager{nullptr};
                 QNetworkReply *m_Reply{nullptr};
                 //    std::unique_ptr<QTemporaryFile> m_File{nullptr};
                 QUuid m_Token;
             };
             AmdaProvider::AmdaProvider() : impl{spimpl::make_unique_impl<AmdaProviderPrivate>()}
             {
                 qCDebug(LOG_NetworkController()) << tr("AmdaProvider::AmdaProvider")
                                                  << QThread::currentThread();
                 if (auto app = sqpApp) {
                     auto &networkController = app->networkController();
                     connect(this, &AmdaProvider::requestConstructed, &networkController,
                             &NetworkController::onProcessRequested);
                 }
             }
-            void AmdaProvider::requestDataLoading(QUuid token, const QVector<SqpDateTime> &dateTimeList)
+            void AmdaProvider::requestDataLoading(QUuid token, const DataProviderParameters &parameters)
             {
                 // NOTE: Try to use multithread if possible
-                for (const auto &dateTime : dateTimeList) {
+                const auto times = parameters.m_Times;
-                    retrieveData(token, DataProviderParameters{dateTime});
+                for (const auto &dateTime : qAsConst(times)) {
+                    retrieveData(token, dateTime);
                 }
             }
-            void AmdaProvider::retrieveData(QUuid token, const DataProviderParameters &parameters)
+            void AmdaProvider::retrieveData(QUuid token, const SqpDateTime &dateTime)
             {
                 // /////////// //
                 // Creates URL //
                 // /////////// //
-                auto startDate = dateFormat(parameters.m_Time.m_TStart);
+                auto startDate = dateFormat(dateTime.m_TStart);
-                auto endDate = dateFormat(parameters.m_Time.m_TEnd);
+                auto endDate = dateFormat(dateTime.m_TEnd);
                 auto productId = QStringLiteral("imf(0)");
                 auto url = QUrl{QString{AMDA_URL_FORMAT}.arg(startDate, endDate, productId)};
                 auto tempFile = std::make_shared<QTemporaryFile>();
                 // LAMBDA
                 auto httpDownloadFinished = [this, tempFile](QNetworkReply *reply, QUuid dataId) noexcept {
                     if (tempFile) {
                         auto replyReadAll = reply->readAll();
                         if (!replyReadAll.isEmpty()) {
                             tempFile->write(replyReadAll);
                         }
                         tempFile->close();
                         // Parse results file
                         if (auto dataSeries = AmdaResultParser::readTxt(tempFile->fileName())) {
-                            emit dataProvided(impl->m_Token, dataSeries, impl->m_Params.m_Time);
+                            emit dataProvided(impl->m_Token, dataSeries, impl->m_DateTime);
                         }
                         else {
                             /// @todo ALX : debug
                         }
                     }
                     // Deletes reply
                     reply->deleteLater();
                     reply = nullptr;
                 };
                 auto httpFinishedLambda = [this, httpDownloadFinished, tempFile](QNetworkReply *reply,
                                                                                  QUuid dataId) noexcept {
                     auto downloadFileUrl = QUrl{QString{reply->readAll()}};
                     // Deletes old reply
                     reply->deleteLater();
                     // Executes request for downloading file //
                     // Creates destination file
                     if (tempFile->open()) {
                         // Executes request
                         emit requestConstructed(QNetworkRequest{downloadFileUrl}, dataId, httpDownloadFinished);
                     }
                 };
                 // //////////////// //
                 // Executes request //
                 // //////////////// //
                 impl->m_Token = token;
-                impl->m_Params = parameters;
+                impl->m_DateTime = dateTime;
                 emit requestConstructed(QNetworkRequest{url}, token, httpFinishedLambda);
             }

plugins/mockplugin/include/CosinusProvider.h +2 -3

             #ifndef SCIQLOP_COSINUSPROVIDER_H
             #define SCIQLOP_COSINUSPROVIDER_H
             #include "MockPluginGlobal.h"
             #include <Data/IDataProvider.h>
             #include <QLoggingCategory>
             Q_DECLARE_LOGGING_CATEGORY(LOG_CosinusProvider)
             /**
              * @brief The CosinusProvider class is an example of how a data provider can generate data
              */
             class SCIQLOP_MOCKPLUGIN_EXPORT CosinusProvider : public IDataProvider {
             public:
-                void requestDataLoading(QUuid token, const QVector<SqpDateTime> &dateTimeList) override;
+                void requestDataLoading(QUuid token, const DataProviderParameters &parameters) override;
             private:
                 /// @sa IDataProvider::retrieveData()
-                std::shared_ptr<IDataSeries> retrieveData(const DataProviderParameters &parameters) const;
+                std::shared_ptr<IDataSeries> retrieveData(const SqpDateTime &dateTime) const;
-                std::shared_ptr<IDataSeries> retrieveDataSeries(const SqpDateTime &dateTime);
             };
             #endif // SCIQLOP_COSINUSPROVIDER_H

plugins/mockplugin/src/CosinusProvider.cpp +5 -7

             #include "CosinusProvider.h"
             #include <Data/DataProviderParameters.h>
             #include <Data/ScalarSeries.h>
             #include <cmath>
             #include <QDateTime>
             #include <QThread>
             Q_LOGGING_CATEGORY(LOG_CosinusProvider, "CosinusProvider")
-            std::shared_ptr<IDataSeries>
+            std::shared_ptr<IDataSeries> CosinusProvider::retrieveData(const SqpDateTime &dateTime) const
-            CosinusProvider::retrieveData(const DataProviderParameters &parameters) const
             {
-                auto dateTime = parameters.m_Time;
                 auto dataIndex = 0;
                 // Gets the timerange from the parameters
                 double freq = 100.0;
                 double start = dateTime.m_TStart * freq; // 100 htz
                 double end = dateTime.m_TEnd * freq;     // 100 htz
                 // We assure that timerange is valid
                 if (end < start) {
                     std::swap(start, end);
                 }
                 // Generates scalar series containing cosinus values (one value per second)
                 auto scalarSeries
                     = std::make_shared<ScalarSeries>(end - start, Unit{QStringLiteral("t"), true}, Unit{});
                 for (auto time = start; time < end; ++time, ++dataIndex) {
                     const auto timeOnFreq = time / freq;
                     scalarSeries->setData(dataIndex, timeOnFreq, std::cos(timeOnFreq));
                 }
                 return scalarSeries;
             }
-            void CosinusProvider::requestDataLoading(QUuid token, const QVector<SqpDateTime> &dateTimeList)
+            void CosinusProvider::requestDataLoading(QUuid token, const DataProviderParameters &parameters)
             {
                 qCDebug(LOG_CosinusProvider()) << "CosinusProvider::requestDataLoading"
                                                << QThread::currentThread()->objectName();
                 // NOTE: Try to use multithread if possible
-                for (const auto &dateTime : dateTimeList) {
+                const auto times = parameters.m_Times;
-                    auto scalarSeries = this->retrieveData(DataProviderParameters{dateTime});
+                for (const auto &dateTime : qAsConst(times)) {
+                    auto scalarSeries = this->retrieveData(dateTime);
                     emit dataProvided(token, scalarSeries, 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