src/MEDCoupling/MEDCouplingTimeLabel.hxx

   1 // Copyright (C) 2007-2020  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19 // Author : Anthony Geay (CEA/DEN)
  20
  21 #ifndef __PARAMEDMEM_TIMELABEL_HXX__
  22 #define __PARAMEDMEM_TIMELABEL_HXX__
  23
  24 #include "MEDCoupling.hxx"
  25
  26 #include <atomic>
  27 #include <cstddef>
  28
  29 namespace MEDCoupling
  30 {
  31   /*!
  32    * Class representing a label of time of the lastely modified part of this.
  33    * More _time is high more the object has been modified recently.
  34    */
  35   class TimeLabel
  36   {
  37   public:
  38     MEDCOUPLING_EXPORT TimeLabel(const TimeLabel& other) = default;
  39     MEDCOUPLING_EXPORT TimeLabel& operator=(const TimeLabel& other);
  40     //! This method should be called when write access has been done on this.
  41     MEDCOUPLING_EXPORT void declareAsNew() const;
  42     //! This method should be called on high level classes as Field or Mesh to take into account modifications done in aggregates objects.
  43     MEDCOUPLING_EXPORT virtual void updateTime() const = 0;
  44     MEDCOUPLING_EXPORT std::size_t getTimeOfThis() const { return _time; }
  45   protected:
  46     MEDCOUPLING_EXPORT TimeLabel();
  47     MEDCOUPLING_EXPORT virtual ~TimeLabel();
  48     MEDCOUPLING_EXPORT void updateTimeWith(const TimeLabel& other) const;
  49     MEDCOUPLING_EXPORT void forceTimeOfThis(const TimeLabel& other) const;
  50   private:
  51     static std::atomic<std::size_t> GLOBAL_TIME;
  52     mutable std::size_t _time;
  53   };
  54
  55   class TimeLabelConstOverseer
  56   {
  57   public:
  58     MEDCOUPLING_EXPORT TimeLabelConstOverseer(const TimeLabel *tl);
  59     MEDCOUPLING_EXPORT void checkConst() const;
  60     MEDCOUPLING_EXPORT bool resetState();
  61     MEDCOUPLING_EXPORT bool keepTrackOfNewTL(const TimeLabel *tl);
  62   private:
  63     const TimeLabel *_tl;
  64     std::size_t _ref_time;
  65   };
  66 }
  67
  68 #endif