HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/SciQLOPCore Files · include/Variable/VariableSynchronizationGroup2.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:

r12:4e36a737f884


                r16:5da3a19e8770

Download file

             VariableSynchronizationGroup2.h
        
                    71 lines
            
             | 1.9 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / include / Variable / VariableSynchronizationGroup2.h
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #ifndef SCIQLOP_VARIABLESYNCHRONIZATIONGROUP2_H

      #define SCIQLOP_VARIABLESYNCHRONIZATIONGROUP2_H

      #include <QUuid>

      #include <set>

      #include "CoreGlobal.h"

      #include <Common/spimpl.h>

      #include <Common/containers.h>

      /**

       * @brief The VariableSynchronizationGroup2 class holds a list of Variables uuid which are synchronized

       * @note This class is part of SciQLop internals, as a normal user you shouldn't have to care about it

       */

      class SCIQLOP_CORE_EXPORT VariableSynchronizationGroup2

      {

      public:

          explicit VariableSynchronizationGroup2()=default;

          /**

           * @brief VariableSynchronizationGroup2 is a convenience ctor to build a group with a default variable

           * @param variable

           */

          explicit VariableSynchronizationGroup2(QUuid variable)

              :_variables{{variable}}

          {}

          /**

           * @brief addVariable adds the given variable to the group, does nothing if the varaible is alredy in the group

           * @param variable

           * @sa removeVariable

           */

          void addVariable(QUuid variable) noexcept

          {

              this->_variables.insert(variable);

          }

          /**

           * @brief removeVariable removes the given variable from the group, does nothing if the varaible is not in the group

           * @param variable

           * @sa addVariable

           */

          void removeVariable(QUuid variable) noexcept

          {

              this->_variables.erase(variable);

          }

          /**

           * @brief contains checks if the given variable is in the group

           * @param variable

           * @return true if the variable is in the group

           */

          bool contains(QUuid variable) const noexcept

          {

              return SciQLop::containers::contains(this->_variables,variable);

          }

          /**

           * @brief variables

           * @return the list of synchronized variables in this group as a std::set

           */

          const std::set<QUuid> &variables() const noexcept

          {

              return this->_variables;

          }

      private:

          std::set<QUuid> _variables;

      };

      #endif // SCIQLOP_VARIABLESYNCHRONIZATIONGROUP2_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_VARIABLESYNCHRONIZATIONGROUP2_H
				#define SCIQLOP_VARIABLESYNCHRONIZATIONGROUP2_H

				#include <QUuid>
				#include <set>

				#include "CoreGlobal.h"
				#include <Common/spimpl.h>
				#include <Common/containers.h>

				/**
				* @brief The VariableSynchronizationGroup2 class holds a list of Variables uuid which are synchronized
				* @note This class is part of SciQLop internals, as a normal user you shouldn't have to care about it
				*/
				class SCIQLOP_CORE_EXPORT VariableSynchronizationGroup2
				{

				public:
				explicit VariableSynchronizationGroup2()=default;
				/**
				* @brief VariableSynchronizationGroup2 is a convenience ctor to build a group with a default variable
				* @param variable
				*/
				explicit VariableSynchronizationGroup2(QUuid variable)
				:_variables{{variable}}
				{}

				/**
				* @brief addVariable adds the given variable to the group, does nothing if the varaible is alredy in the group
				* @param variable
				* @sa removeVariable
				*/
				void addVariable(QUuid variable) noexcept
				{
				this->_variables.insert(variable);
				}

				/**
				* @brief removeVariable removes the given variable from the group, does nothing if the varaible is not in the group
				* @param variable
				* @sa addVariable
				*/
				void removeVariable(QUuid variable) noexcept
				{
				this->_variables.erase(variable);
				}

				/**
				* @brief contains checks if the given variable is in the group
				* @param variable
				* @return true if the variable is in the group
				*/
				bool contains(QUuid variable) const noexcept
				{
				return SciQLop::containers::contains(this->_variables,variable);
				}

				/**
				* @brief variables
				* @return the list of synchronized variables in this group as a std::set
				*/
				const std::set<QUuid> &variables() const noexcept
				{
				return this->_variables;
				}

				private:
				std::set<QUuid> _variables;
				};

				#endif // SCIQLOP_VARIABLESYNCHRONIZATIONGROUP2_H