GIT_REPOSITORIES/LPP/Users/mperrinel/SciQLop-fork Files · core/include/DataSource/DataSourceController.h

Enables the registration of a data source in the controller

Alexandre Leroux - - Load All Authors

File last commit:

r36:cc066d743ead


                r36:cc066d743ead

Download file

             DataSourceController.h
        
                    45 lines
            
             | 1.5 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / DataSource / DataSourceController.h
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #ifndef SCIQLOP_DATASOURCECONTROLLER_H

      #define SCIQLOP_DATASOURCECONTROLLER_H

      #include <QLoggingCategory>

      #include <QObject>

      #include <QUuid>

      #include <Common/spimpl.h>

      Q_DECLARE_LOGGING_CATEGORY(LOG_DataSourceController)

      /**

       * @brief The DataSourceController class aims to make the link between SciQlop and its plugins. This

       * is the intermediate class that SciQlop has to use in the way to connect a data source. Please

       * first use register method to initialize a plugin specified by its metadata name (JSON plugin

       * source) then others specifics method will be able to access it. You can load a data source driver

       * plugin then create a data source.

       */

      class DataSourceController : public QObject {

          Q_OBJECT

      public:

          explicit DataSourceController(QObject *parent = 0);

          virtual ~DataSourceController();

          /**

           * Registers a data source. The method delivers a unique id that can be used afterwards to

           * access to the data source properties (structure, connection parameters, data provider, etc.)

           * @param dataSourceName the name of the data source

           * @return the unique id with which the data source has been registered

           */

          QUuid registerDataSource(const QString &dataSourceName) noexcept;

      public slots:

          /// Manage init/end of the controller

          void initialize();

          void finalize();

      private:

          void waitForFinish();

          class DataSourceControllerPrivate;

          spimpl::unique_impl_ptr<DataSourceControllerPrivate> impl;

      };

      #endif // SCIQLOP_DATASOURCECONTROLLER_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_DATASOURCECONTROLLER_H
				#define SCIQLOP_DATASOURCECONTROLLER_H

				#include <QLoggingCategory>
				#include <QObject>
				#include <QUuid>

				#include <Common/spimpl.h>

				Q_DECLARE_LOGGING_CATEGORY(LOG_DataSourceController)

				/**
				* @brief The DataSourceController class aims to make the link between SciQlop and its plugins. This
				* is the intermediate class that SciQlop has to use in the way to connect a data source. Please
				* first use register method to initialize a plugin specified by its metadata name (JSON plugin
				* source) then others specifics method will be able to access it. You can load a data source driver
				* plugin then create a data source.
				*/
				class DataSourceController : public QObject {
				Q_OBJECT
				public:
				explicit DataSourceController(QObject *parent = 0);
				virtual ~DataSourceController();

				/**
				* Registers a data source. The method delivers a unique id that can be used afterwards to
				* access to the data source properties (structure, connection parameters, data provider, etc.)
				* @param dataSourceName the name of the data source
				* @return the unique id with which the data source has been registered
				*/
				QUuid registerDataSource(const QString &dataSourceName) noexcept;

				public slots:
				/// Manage init/end of the controller
				void initialize();
				void finalize();

				private:
				void waitForFinish();

				class DataSourceControllerPrivate;
				spimpl::unique_impl_ptr<DataSourceControllerPrivate> impl;
				};

				#endif // SCIQLOP_DATASOURCECONTROLLER_H