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

Merge branch 'feature/VariableModel4' into develop

Alexandre Leroux - - Load All Authors

File last commit:

r177:4c64b786fec1


                r185:fa2e26651269

Download file

             IDataSeries.h
        
                    47 lines
            
             | 1.1 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / Data / IDataSeries.h
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #ifndef SCIQLOP_IDATASERIES_H

      #define SCIQLOP_IDATASERIES_H

      #include <QString>

      #include <memory>

      template <int Dim>

      class ArrayData;

      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

      };

      /**

       * @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;

          virtual Unit xAxisUnit() const = 0;

          virtual Unit valuesUnit() const = 0;

      };

      #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

				#ifndef SCIQLOP_IDATASERIES_H
				#define SCIQLOP_IDATASERIES_H

				#include <QString>

				#include <memory>

				template <int Dim>
				class ArrayData;

				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
				};

				/**
				* @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;

				virtual Unit xAxisUnit() const = 0;

				virtual Unit valuesUnit() const = 0;
				};

				#endif // SCIQLOP_IDATASERIES_H