Salome HOME
remove src/MEDCalc/doc
[modules/med.git] / src / MEDCoupling / MEDCouplingTimeLabel.hxx
1 // Copyright (C) 2007-2015  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 <cstddef>
27
28 namespace ParaMEDMEM
29 {
30   /*!
31    * Class representing a label of time of the lastely modified part of this.
32    * More _time is high more the object has been modified recently.
33    */
34   class TimeLabel
35   {
36   public:
37     MEDCOUPLING_EXPORT TimeLabel& operator=(const TimeLabel& other);
38     //! This method should be called when write access has been done on this.
39     MEDCOUPLING_EXPORT void declareAsNew() const;
40     //! This method should be called on high level classes as Field or Mesh to take into acount modifications done in aggregates objects.
41     MEDCOUPLING_EXPORT virtual void updateTime() const = 0;
42     MEDCOUPLING_EXPORT std::size_t getTimeOfThis() const { return _time; }
43   protected:
44     MEDCOUPLING_EXPORT TimeLabel();
45     MEDCOUPLING_EXPORT virtual ~TimeLabel();
46     MEDCOUPLING_EXPORT void updateTimeWith(const TimeLabel& other) const;
47     MEDCOUPLING_EXPORT void forceTimeOfThis(const TimeLabel& other) const;
48   private:
49     static std::size_t GLOBAL_TIME;
50     mutable std::size_t _time;
51   };
52
53   class TimeLabelConstOverseer
54   {
55   public:
56     MEDCOUPLING_EXPORT TimeLabelConstOverseer(const TimeLabel *tl);
57     MEDCOUPLING_EXPORT void checkConst() const;
58     MEDCOUPLING_EXPORT bool resetState();
59     MEDCOUPLING_EXPORT bool keepTrackOfNewTL(const TimeLabel *tl);
60   private:
61     const TimeLabel *_tl;
62     std::size_t _ref_time;
63   };
64 }
65
66 #endif