HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/SciQLOPCore Files · include/Data/IDataProvider.h

Updated libcatalogs -> fixes catalog issue...

Updated libcatalogs -> fixes catalog issue Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>

jeandet - - Load All Authors

File last commit:

r28:a05b0ab23493


                r51:9aec54f98372

Download file

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

      #ifndef SCIQLOP_IDATAPROVIDER_H

      #define SCIQLOP_IDATAPROVIDER_H

      #include "CoreGlobal.h"

      #include <Common/deprecate.h>

      #include <memory>

      #include <QObject>

      #include <QUuid>

      #include <Common/MetaTypes.h>

      #include <Data/DateTimeRange.h>

      #include <functional>

      class DataProviderParameters;

      class IDataSeries;

      DEPRECATE(

          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.)

       * Since its client mihgt use it from different threads it has to be either stateless  and/or thread safe

       *

       * @sa IDataSeries

       */

      class SCIQLOP_CORE_EXPORT IDataProvider : public QObject {

          Q_OBJECT

      public:

          virtual ~IDataProvider() noexcept = default;

          virtual std::shared_ptr<IDataProvider> clone() const = 0;

          // Synchronous call -> asyncGetData may be written for asynchronous get

          virtual IDataSeries* getData(const DataProviderParameters &parameters) = 0;

      signals:

          void progress(QUuid requestID, double progress);

      };

      // 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 "CoreGlobal.h"
				#include <Common/deprecate.h>

				#include <memory>

				#include <QObject>
				#include <QUuid>

				#include <Common/MetaTypes.h>

				#include <Data/DateTimeRange.h>

				#include <functional>

				class DataProviderParameters;
				class IDataSeries;
				DEPRECATE(
				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.)
				* Since its client mihgt use it from different threads it has to be either stateless and/or thread safe
				*
				* @sa IDataSeries
				*/
				class SCIQLOP_CORE_EXPORT IDataProvider : public QObject {

				Q_OBJECT
				public:
				virtual ~IDataProvider() noexcept = default;
				virtual std::shared_ptr<IDataProvider> clone() const = 0;

				// Synchronous call -> asyncGetData may be written for asynchronous get
				virtual IDataSeries* getData(const DataProviderParameters &parameters) = 0;

				signals:

				void progress(QUuid requestID, double progress);

				};

				// 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