HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Files · core/include/Data/IDataProvider.h

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

Updates IDataProvider::requestDataLoading() method's signature The parameters needed for data retrieval are passed to a DataProviderParameters object. For now, it concerns only the list of datetimes to process, but the object will be completed with extra data which may be necessary for certain providers

Alexandre Leroux - - Load All Authors

File last commit:

r408:49f712bf7e59


                r408:49f712bf7e59

Download file

             IDataProvider.h
        
                    59 lines
            
             | 1.8 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / Data / IDataProvider.h
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #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 and parameters

           */

          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

	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

				#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 and parameters
				*/
				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