GIT_REPOSITORIES/LPP/Users/mperrinel/SCIQLOP-Initialisation Files · core/include/Data/DataSeriesIterator.h

push method of worker return the id of the nextRange which is canceled

Alexandre Leroux - - Load All Authors

File last commit:

r570:3d5120e0d250


                r584:d6648352006d

Download file

             DataSeriesIterator.h
        
                    88 lines
            
             | 3.1 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...

              r557
            
      #ifndef SCIQLOP_DATASERIESITERATOR_H

      #define SCIQLOP_DATASERIESITERATOR_H

      #include "CoreGlobal.h"

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

              r570
            
              virtual double minValue() const = 0;

              virtual double maxValue() const = 0;

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

              r557
            
          };

          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)

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

              r557
            
      private:

          std::unique_ptr<Impl> m_Impl;

      };

      /**

       * @brief The DataSeriesIterator class represents an iterator used for data series. It defines all

       * operators needed for a standard forward iterator

       * @sa http://www.cplusplus.com/reference/iterator/

       */

      class SCIQLOP_CORE_EXPORT DataSeriesIterator {

      public:

          using iterator_category = std::forward_iterator_tag;

          using value_type = const DataSeriesIteratorValue;

          using difference_type = std::ptrdiff_t;

          using pointer = value_type *;

          using reference = value_type &;

          explicit DataSeriesIterator(DataSeriesIteratorValue value);

          virtual ~DataSeriesIterator() noexcept = default;

          DataSeriesIterator(const DataSeriesIterator &) = default;

          DataSeriesIterator(DataSeriesIterator &&) = default;

          DataSeriesIterator &operator=(const DataSeriesIterator &) = default;

          DataSeriesIterator &operator=(DataSeriesIterator &&) = default;

          DataSeriesIterator &operator++();

          DataSeriesIterator &operator--();

          pointer operator->() const { return &m_CurrentValue; }

          reference operator*() const { return m_CurrentValue; }

          bool operator==(const DataSeriesIterator &other) const;

          bool operator!=(const DataSeriesIterator &other) const;

      private:

          DataSeriesIteratorValue m_CurrentValue;

      };

      #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...	r557	#ifndef SCIQLOP_DATASERIESITERATOR_H
		#define SCIQLOP_DATASERIESITERATOR_H

		#include "CoreGlobal.h"

		#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)	r570	virtual double minValue() const = 0;
		virtual double maxValue() const = 0;
Alexandre Leroux Defines an iterator for a data series...	r557	};

		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)	r570	/// 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...	r557
		private:
		std::unique_ptr<Impl> m_Impl;
		};

		/**
		* @brief The DataSeriesIterator class represents an iterator used for data series. It defines all
		* operators needed for a standard forward iterator
		* @sa http://www.cplusplus.com/reference/iterator/
		*/
		class SCIQLOP_CORE_EXPORT DataSeriesIterator {
		public:
		using iterator_category = std::forward_iterator_tag;
		using value_type = const DataSeriesIteratorValue;
		using difference_type = std::ptrdiff_t;
		using pointer = value_type *;
		using reference = value_type &;

		explicit DataSeriesIterator(DataSeriesIteratorValue value);
		virtual ~DataSeriesIterator() noexcept = default;
		DataSeriesIterator(const DataSeriesIterator &) = default;
		DataSeriesIterator(DataSeriesIterator &&) = default;
		DataSeriesIterator &operator=(const DataSeriesIterator &) = default;
		DataSeriesIterator &operator=(DataSeriesIterator &&) = default;

		DataSeriesIterator &operator++();
		DataSeriesIterator &operator--();
		pointer operator->() const { return &m_CurrentValue; }
		reference operator*() const { return m_CurrentValue; }
		bool operator==(const DataSeriesIterator &other) const;
		bool operator!=(const DataSeriesIterator &other) const;

		private:
		DataSeriesIteratorValue m_CurrentValue;
		};

		#endif // SCIQLOP_DATASERIESITERATOR_H