HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/SciQLOPCore Files · include/Variable/Variable.h

Made Variable data update atomic ease thread safety and avoid mixing...

Made Variable data update atomic ease thread safety and avoid mixing abstraction levels Also added few missing override Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>

jeandet - - Load All Authors

File last commit:

r16:5da3a19e8770


                r16:5da3a19e8770

Download file

             Variable.h
        
                    112 lines
            
             | 3.7 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / include / Variable / Variable.h
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        jeandet
    
First init from SciQLop Core module...

              r0
            
      #ifndef SCIQLOP_VARIABLE_H

      #define SCIQLOP_VARIABLE_H

        jeandet
    
Made Variable data update atomic ease thread safety and avoid mixing...

              r16
            
      #include <QLoggingCategory>

      #include <QObject>

      #include <QUuid>

      #include <QReadWriteLock>

        jeandet
    
First init from SciQLop Core module...

              r0
            
        jeandet
    
Made Variable data update atomic ease thread safety and avoid mixing...

              r16
            
      #include "CoreGlobal.h"

        jeandet
    
First init from SciQLop Core module...

              r0
            
      #include <Data/DataSeriesIterator.h>

      #include <Data/DataSeriesType.h>

      #include <Data/DateTimeRange.h>

        jeandet
    
Basic serial variable creation and update...

              r2
            
      #include <Common/deprecate.h>

        jeandet
    
First init from SciQLop Core module...

              r0
            
      #include <Common/MetaTypes.h>

      #include <Common/spimpl.h>

      Q_DECLARE_LOGGING_CATEGORY(LOG_Variable)

      class IDataSeries;

      class QString;

      /**

       * @brief The Variable class represents a variable in SciQlop.

       */

      class SCIQLOP_CORE_EXPORT Variable : public QObject {

          Q_OBJECT

      public:

          explicit Variable(const QString &name, const QVariantHash &metadata = {});

          /// Copy ctor

          explicit Variable(const Variable &other);

          std::shared_ptr<Variable> clone() const;

          QString name() const noexcept;

          void setName(const QString &name) noexcept;

          DateTimeRange range() const noexcept;

        jeandet
    
Many fixes plus implemented var synchronization...

              r9
            
          void setRange(const DateTimeRange &range, bool notify=false) noexcept;

        jeandet
    
First init from SciQLop Core module...

              r0
            
          DateTimeRange cacheRange() const noexcept;

          void setCacheRange(const DateTimeRange &cacheRange) noexcept;

          /// @return the number of points hold by the variable. The number of points is updated each time

          /// the data series changes

        jeandet
    
VariableController2 tests refactoring...

              r3
            
          unsigned int nbPoints() const noexcept;

        jeandet
    
First init from SciQLop Core module...

              r0
            
          /// Returns the real range of the variable, i.e. the min and max x-axis values of the data

          /// series between the range of the variable. The real range is updated each time the variable

          /// range or the data series changed

          /// @return the real range, invalid range if the data series is null or empty

          /// @sa setDataSeries()

          /// @sa setRange()

        jeandet
    
Some refactoring on Variable class...

              r15
            
          std::optional<DateTimeRange> realRange() const noexcept;

        jeandet
    
First init from SciQLop Core module...

              r0
            
          /// @return the data of the variable, nullptr if there is no data

          std::shared_ptr<IDataSeries> dataSeries() const noexcept;

          /// @return the type of data that the variable holds

          DataSeriesType type() const noexcept;

          QVariantHash metadata() const noexcept;

        jeandet
    
Many fixes plus implemented var synchronization...

              r9
            
      DEPRECATE(

        jeandet
    
First init from SciQLop Core module...

              r0
            
          bool contains(const DateTimeRange &range) const noexcept;

          bool intersect(const DateTimeRange &range) const noexcept;

          bool isInside(const DateTimeRange &range) const noexcept;

          bool cacheContains(const DateTimeRange &range) const noexcept;

          bool cacheIntersect(const DateTimeRange &range) const noexcept;

          bool cacheIsInside(const DateTimeRange &range) const noexcept;

        jeandet
    
Many fixes plus implemented var synchronization...

              r9
            
      )

      DEPRECATE(

        jeandet
    
First init from SciQLop Core module...

              r0
            
          QVector<DateTimeRange> provideNotInCacheRangeList(const DateTimeRange &range) const noexcept;

          QVector<DateTimeRange> provideInCacheRangeList(const DateTimeRange &range) const noexcept;

        jeandet
    
Many fixes plus implemented var synchronization...

              r9
            
      )

        jeandet
    
Basic serial variable creation and update...

              r2
            
      DEPRECATE(

        jeandet
    
First init from SciQLop Core module...

              r0
            
          void mergeDataSeries(std::shared_ptr<IDataSeries> dataSeries) noexcept;

        jeandet
    
Basic serial variable creation and update...

              r2
            
          )

        jeandet
    
Made Variable data update atomic ease thread safety and avoid mixing...

              r16
            
          void updateData(const std::vector<IDataSeries*>& dataSeries,

                          const DateTimeRange& newRange, const DateTimeRange& newCacheRange,

                          bool notify=true);

        jeandet
    
First init from SciQLop Core module...

              r0
            
        jeandet
    
Many fixes plus implemented var synchronization...

              r9
            
      DEPRECATE(

        jeandet
    
First init from SciQLop Core module...

              r0
            
          static QVector<DateTimeRange> provideNotInCacheRangeList(const DateTimeRange &oldRange,

                                                              const DateTimeRange &nextRange);

          static QVector<DateTimeRange> provideInCacheRangeList(const DateTimeRange &oldRange,

                                                           const DateTimeRange &nextRange);

        jeandet
    
Many fixes plus implemented var synchronization...

              r9
            
      )

        jeandet
    
First init from SciQLop Core module...

              r0
            
        jeandet
    
Basic serial variable creation and update...

              r2
            
          QUuid ID(){return _uuid;}

        jeandet
    
First init from SciQLop Core module...

              r0
            
      signals:

          void updated();

        jeandet
    
Many fixes plus implemented var synchronization...

              r9
            
      DEPRECATE(

        jeandet
    
First init from SciQLop Core module...

              r0
            
          /// Signal emitted when when the data series of the variable is loaded for the first time

          void dataInitialized();

        jeandet
    
Many fixes plus implemented var synchronization...

              r9
            
          )

        jeandet
    
First init from SciQLop Core module...

              r0
            
      private:

          class VariablePrivate;

          spimpl::unique_impl_ptr<VariablePrivate> impl;

        jeandet
    
Basic serial variable creation and update...

              r2
            
          QUuid _uuid;

        jeandet
    
Made Variable data update atomic ease thread safety and avoid mixing...

              r16
            
          QReadWriteLock m_lock;

        jeandet
    
First init from SciQLop Core module...

              r0
            
      };

      // Required for using shared_ptr in signals/slots

      SCIQLOP_REGISTER_META_TYPE(VARIABLE_PTR_REGISTRY, std::shared_ptr<Variable>)

      SCIQLOP_REGISTER_META_TYPE(VARIABLE_PTR_VECTOR_REGISTRY, QVector<std::shared_ptr<Variable> >)

      #endif // SCIQLOP_VARIABLE_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

jeandet First init from SciQLop Core module...	r0	#ifndef SCIQLOP_VARIABLE_H
		#define SCIQLOP_VARIABLE_H

jeandet Made Variable data update atomic ease thread safety and avoid mixing...	r16	#include <QLoggingCategory>
		#include <QObject>
		#include <QUuid>
		#include <QReadWriteLock>
jeandet First init from SciQLop Core module...	r0
jeandet Made Variable data update atomic ease thread safety and avoid mixing...	r16	#include "CoreGlobal.h"
jeandet First init from SciQLop Core module...	r0	#include <Data/DataSeriesIterator.h>
		#include <Data/DataSeriesType.h>
		#include <Data/DateTimeRange.h>


jeandet Basic serial variable creation and update...	r2	#include <Common/deprecate.h>
jeandet First init from SciQLop Core module...	r0	#include <Common/MetaTypes.h>
		#include <Common/spimpl.h>

		Q_DECLARE_LOGGING_CATEGORY(LOG_Variable)

		class IDataSeries;
		class QString;

		/**
		* @brief The Variable class represents a variable in SciQlop.
		*/
		class SCIQLOP_CORE_EXPORT Variable : public QObject {

		Q_OBJECT

		public:
		explicit Variable(const QString &name, const QVariantHash &metadata = {});

		/// Copy ctor
		explicit Variable(const Variable &other);

		std::shared_ptr<Variable> clone() const;

		QString name() const noexcept;
		void setName(const QString &name) noexcept;
		DateTimeRange range() const noexcept;
jeandet Many fixes plus implemented var synchronization...	r9	void setRange(const DateTimeRange &range, bool notify=false) noexcept;
jeandet First init from SciQLop Core module...	r0	DateTimeRange cacheRange() const noexcept;
		void setCacheRange(const DateTimeRange &cacheRange) noexcept;

		/// @return the number of points hold by the variable. The number of points is updated each time
		/// the data series changes
jeandet VariableController2 tests refactoring...	r3	unsigned int nbPoints() const noexcept;
jeandet First init from SciQLop Core module...	r0
		/// Returns the real range of the variable, i.e. the min and max x-axis values of the data
		/// series between the range of the variable. The real range is updated each time the variable
		/// range or the data series changed
		/// @return the real range, invalid range if the data series is null or empty
		/// @sa setDataSeries()
		/// @sa setRange()
jeandet Some refactoring on Variable class...	r15	std::optional<DateTimeRange> realRange() const noexcept;
jeandet First init from SciQLop Core module...	r0
		/// @return the data of the variable, nullptr if there is no data
		std::shared_ptr<IDataSeries> dataSeries() const noexcept;

		/// @return the type of data that the variable holds
		DataSeriesType type() const noexcept;

		QVariantHash metadata() const noexcept;
jeandet Many fixes plus implemented var synchronization...	r9	DEPRECATE(
jeandet First init from SciQLop Core module...	r0	bool contains(const DateTimeRange &range) const noexcept;
		bool intersect(const DateTimeRange &range) const noexcept;
		bool isInside(const DateTimeRange &range) const noexcept;

		bool cacheContains(const DateTimeRange &range) const noexcept;
		bool cacheIntersect(const DateTimeRange &range) const noexcept;
		bool cacheIsInside(const DateTimeRange &range) const noexcept;
jeandet Many fixes plus implemented var synchronization...	r9	)
		DEPRECATE(
jeandet First init from SciQLop Core module...	r0	QVector<DateTimeRange> provideNotInCacheRangeList(const DateTimeRange &range) const noexcept;
		QVector<DateTimeRange> provideInCacheRangeList(const DateTimeRange &range) const noexcept;
jeandet Many fixes plus implemented var synchronization...	r9	)
jeandet Basic serial variable creation and update...	r2	DEPRECATE(
jeandet First init from SciQLop Core module...	r0	void mergeDataSeries(std::shared_ptr<IDataSeries> dataSeries) noexcept;
jeandet Basic serial variable creation and update...	r2	)
jeandet Made Variable data update atomic ease thread safety and avoid mixing...	r16
		void updateData(const std::vector<IDataSeries*>& dataSeries,
		const DateTimeRange& newRange, const DateTimeRange& newCacheRange,
		bool notify=true);
jeandet First init from SciQLop Core module...	r0
jeandet Many fixes plus implemented var synchronization...	r9	DEPRECATE(
jeandet First init from SciQLop Core module...	r0	static QVector<DateTimeRange> provideNotInCacheRangeList(const DateTimeRange &oldRange,
		const DateTimeRange &nextRange);

		static QVector<DateTimeRange> provideInCacheRangeList(const DateTimeRange &oldRange,
		const DateTimeRange &nextRange);
jeandet Many fixes plus implemented var synchronization...	r9	)
jeandet First init from SciQLop Core module...	r0
jeandet Basic serial variable creation and update...	r2	QUuid ID(){return _uuid;}
jeandet First init from SciQLop Core module...	r0	signals:
		void updated();
jeandet Many fixes plus implemented var synchronization...	r9	DEPRECATE(
jeandet First init from SciQLop Core module...	r0	/// Signal emitted when when the data series of the variable is loaded for the first time
		void dataInitialized();
jeandet Many fixes plus implemented var synchronization...	r9	)
jeandet First init from SciQLop Core module...	r0	private:
		class VariablePrivate;
		spimpl::unique_impl_ptr<VariablePrivate> impl;
jeandet Basic serial variable creation and update...	r2	QUuid _uuid;
jeandet Made Variable data update atomic ease thread safety and avoid mixing...	r16	QReadWriteLock m_lock;
jeandet First init from SciQLop Core module...	r0	};

		// Required for using shared_ptr in signals/slots
		SCIQLOP_REGISTER_META_TYPE(VARIABLE_PTR_REGISTRY, std::shared_ptr<Variable>)
		SCIQLOP_REGISTER_META_TYPE(VARIABLE_PTR_VECTOR_REGISTRY, QVector<std::shared_ptr<Variable> >)

		#endif // SCIQLOP_VARIABLE_H