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

Merge branch 'feature/ApplyOnTimeWidget' into develop

perrinel - - Load All Authors

File last commit:

r233:508df86e5db1


                r306:214febc149fd

Download file

             IDataSeries.h
        
                    54 lines
            
             | 1.3 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / Data / IDataSeries.h
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Alexandre Leroux
    
Creates IDataSeries interface and its default implementation

              r125
            
      #ifndef SCIQLOP_IDATASERIES_H

      #define SCIQLOP_IDATASERIES_H

      #include <memory>

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
      #include <QObject>

      #include <QString>

        Alexandre Leroux
    
Creates IDataSeries interface and its default implementation

              r125
            
      template <int Dim>

      class ArrayData;

        Alexandre Leroux
    
Replaces QString unit by a new struct...

              r177
            
      struct Unit {

          explicit Unit(const QString &name = {}, bool timeUnit = false)

                  : m_Name{name}, m_TimeUnit{timeUnit}

          {

          }

          QString m_Name;  ///< Unit name

          bool m_TimeUnit; ///< The unit is a unit of time

      };

        Alexandre Leroux
    
Creates IDataSeries interface and its default implementation

              r125
            
      /**

       * @brief The IDataSeries aims to declare a data series.

       *

       * A data series is an entity that contains at least :

       * - one dataset representing the x-axis

       * - one dataset representing the values

       *

       * Each dataset is represented by an ArrayData, and is associated with a unit.

       *

       * An ArrayData can be unidimensional or two-dimensional, depending on the implementation of the

       * IDataSeries. The x-axis dataset is always unidimensional.

       *

       * @sa ArrayData

       */

      class IDataSeries {

      public:

          virtual ~IDataSeries() noexcept = default;

          /// Returns the x-axis dataset

          virtual std::shared_ptr<ArrayData<1> > xAxisData() = 0;

        Alexandre Leroux
    
Replaces QString unit by a new struct...

              r177
            
          virtual Unit xAxisUnit() const = 0;

        Alexandre Leroux
    
Creates IDataSeries interface and its default implementation

              r125
            
        Alexandre Leroux
    
Replaces QString unit by a new struct...

              r177
            
          virtual Unit valuesUnit() const = 0;

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
          virtual void merge(IDataSeries *dataSeries) = 0;

        Alexandre Leroux
    
Creates IDataSeries interface and its default implementation

              r125
            
      };

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
      // Required for using shared_ptr in signals/slots

      Q_DECLARE_METATYPE(std::shared_ptr<IDataSeries>)

        Alexandre Leroux
    
Creates IDataSeries interface and its default implementation

              r125
            
      #endif // SCIQLOP_IDATASERIES_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

Alexandre Leroux Creates IDataSeries interface and its default implementation	r125	#ifndef SCIQLOP_IDATASERIES_H
		#define SCIQLOP_IDATASERIES_H


		#include <memory>

perrinel Add merge API and implement it for the DataSeries	r233	#include <QObject>
		#include <QString>

Alexandre Leroux Creates IDataSeries interface and its default implementation	r125	template <int Dim>
		class ArrayData;

Alexandre Leroux Replaces QString unit by a new struct...	r177	struct Unit {
		explicit Unit(const QString &name = {}, bool timeUnit = false)
		: m_Name{name}, m_TimeUnit{timeUnit}
		{
		}

		QString m_Name; ///< Unit name
		bool m_TimeUnit; ///< The unit is a unit of time
		};

Alexandre Leroux Creates IDataSeries interface and its default implementation	r125	/**
		* @brief The IDataSeries aims to declare a data series.
		*
		* A data series is an entity that contains at least :
		* - one dataset representing the x-axis
		* - one dataset representing the values
		*
		* Each dataset is represented by an ArrayData, and is associated with a unit.
		*
		* An ArrayData can be unidimensional or two-dimensional, depending on the implementation of the
		* IDataSeries. The x-axis dataset is always unidimensional.
		*
		* @sa ArrayData
		*/
		class IDataSeries {
		public:
		virtual ~IDataSeries() noexcept = default;

		/// Returns the x-axis dataset
		virtual std::shared_ptr<ArrayData<1> > xAxisData() = 0;

Alexandre Leroux Replaces QString unit by a new struct...	r177	virtual Unit xAxisUnit() const = 0;
Alexandre Leroux Creates IDataSeries interface and its default implementation	r125
Alexandre Leroux Replaces QString unit by a new struct...	r177	virtual Unit valuesUnit() const = 0;
perrinel Add merge API and implement it for the DataSeries	r233
		virtual void merge(IDataSeries *dataSeries) = 0;
Alexandre Leroux Creates IDataSeries interface and its default implementation	r125	};

perrinel Add merge API and implement it for the DataSeries	r233	// Required for using shared_ptr in signals/slots
		Q_DECLARE_METATYPE(std::shared_ptr<IDataSeries>)

Alexandre Leroux Creates IDataSeries interface and its default implementation	r125	#endif // SCIQLOP_IDATASERIES_H