GIT_REPOSITORIES/LPP/Users/mperrinel/SciQLop-fork Files · core/include/Data/DataSeriesIterator.h

Add unit test of variable deletion in VariableController

Alexandre Leroux - - Load All Authors

File last commit:

r639:ec7e67b5ba15


                r665:130573c63dd1

Download file

             DataSeriesIterator.h
        
                    60 lines
            
             | 1.9 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / Data / DataSeriesIterator.h
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Alexandre Leroux
    
Defines an iterator for a data series...

              r595
            
      #ifndef SCIQLOP_DATASERIESITERATOR_H

      #define SCIQLOP_DATASERIESITERATOR_H

      #include "CoreGlobal.h"

        Alexandre Leroux
    
Updates DataSeriesIterator to make an iterator general to SciQlop

              r639
            
      #include "Data/SqpIterator.h"

        Alexandre Leroux
    
Defines an iterator for a data series...

              r595
            
      #include <memory>

      /**

       * @brief The DataSeriesIteratorValue class represents the current value of a data series iterator.

       * It offers standard access methods for the data in the series (x-axis, values), but it is up to

       * each series to define its own implementation of how to retrieve this data, by implementing the

       * DataSeriesIteratorValue::Impl interface

       *

       * @sa DataSeriesIterator

       */

      class SCIQLOP_CORE_EXPORT DataSeriesIteratorValue {

      public:

          struct Impl {

              virtual ~Impl() noexcept = default;

              virtual std::unique_ptr<Impl> clone() const = 0;

              virtual bool equals(const Impl &other) const = 0;

              virtual void next() = 0;

              virtual void prev() = 0;

              virtual double x() const = 0;

              virtual double value() const = 0;

              virtual double value(int componentIndex) const = 0;

        Alexandre Leroux
    
Implements method to get min/max values of a dataseries giving a range (2)

              r609
            
              virtual double minValue() const = 0;

              virtual double maxValue() const = 0;

        Alexandre Leroux
    
Defines an iterator for a data series...

              r595
            
          };

          explicit DataSeriesIteratorValue(std::unique_ptr<Impl> impl);

          DataSeriesIteratorValue(const DataSeriesIteratorValue &other);

          DataSeriesIteratorValue(DataSeriesIteratorValue &&other) = default;

          DataSeriesIteratorValue &operator=(DataSeriesIteratorValue other);

          bool equals(const DataSeriesIteratorValue &other) const;

          /// Advances to the next value

          void next();

          /// Moves back to the previous value

          void prev();

          /// Gets x-axis data

          double x() const;

          /// Gets value data

          double value() const;

          /// Gets value data depending on an index

          double value(int componentIndex) const;

        Alexandre Leroux
    
Implements method to get min/max values of a dataseries giving a range (2)

              r609
            
          /// Gets min of all values data

          double minValue() const;

          /// Gets max of all values data

          double maxValue() const;

        Alexandre Leroux
    
Defines an iterator for a data series...

              r595
            
      private:

          std::unique_ptr<Impl> m_Impl;

      };

        Alexandre Leroux
    
Updates DataSeriesIterator to make an iterator general to SciQlop

              r639
            
      using DataSeriesIterator = SqpIterator<DataSeriesIteratorValue>;

        Alexandre Leroux
    
Defines an iterator for a data series...

              r595
            
      #endif // SCIQLOP_DATASERIESITERATOR_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 Defines an iterator for a data series...	r595	#ifndef SCIQLOP_DATASERIESITERATOR_H
		#define SCIQLOP_DATASERIESITERATOR_H

		#include "CoreGlobal.h"
Alexandre Leroux Updates DataSeriesIterator to make an iterator general to SciQlop	r639	#include "Data/SqpIterator.h"
Alexandre Leroux Defines an iterator for a data series...	r595
		#include <memory>

		/**
		* @brief The DataSeriesIteratorValue class represents the current value of a data series iterator.
		* It offers standard access methods for the data in the series (x-axis, values), but it is up to
		* each series to define its own implementation of how to retrieve this data, by implementing the
		* DataSeriesIteratorValue::Impl interface
		*
		* @sa DataSeriesIterator
		*/
		class SCIQLOP_CORE_EXPORT DataSeriesIteratorValue {
		public:
		struct Impl {
		virtual ~Impl() noexcept = default;
		virtual std::unique_ptr<Impl> clone() const = 0;
		virtual bool equals(const Impl &other) const = 0;
		virtual void next() = 0;
		virtual void prev() = 0;
		virtual double x() const = 0;
		virtual double value() const = 0;
		virtual double value(int componentIndex) const = 0;
Alexandre Leroux Implements method to get min/max values of a dataseries giving a range (2)	r609	virtual double minValue() const = 0;
		virtual double maxValue() const = 0;
Alexandre Leroux Defines an iterator for a data series...	r595	};

		explicit DataSeriesIteratorValue(std::unique_ptr<Impl> impl);
		DataSeriesIteratorValue(const DataSeriesIteratorValue &other);
		DataSeriesIteratorValue(DataSeriesIteratorValue &&other) = default;
		DataSeriesIteratorValue &operator=(DataSeriesIteratorValue other);

		bool equals(const DataSeriesIteratorValue &other) const;

		/// Advances to the next value
		void next();
		/// Moves back to the previous value
		void prev();
		/// Gets x-axis data
		double x() const;
		/// Gets value data
		double value() const;
		/// Gets value data depending on an index
		double value(int componentIndex) const;
Alexandre Leroux Implements method to get min/max values of a dataseries giving a range (2)	r609	/// Gets min of all values data
		double minValue() const;
		/// Gets max of all values data
		double maxValue() const;
Alexandre Leroux Defines an iterator for a data series...	r595
		private:
		std::unique_ptr<Impl> m_Impl;
		};

Alexandre Leroux Updates DataSeriesIterator to make an iterator general to SciQlop	r639	using DataSeriesIterator = SqpIterator<DataSeriesIteratorValue>;
Alexandre Leroux Defines an iterator for a data series...	r595
		#endif // SCIQLOP_DATASERIESITERATOR_H