doc/doxygen/input/medcoupling/MEDCouplingTimeLabel.dox

   1
   2 /*!
   3   \page MEDCouplingTimeLabelPage Time label in MEDCoupling
   4
   5 Time label is a **non instantiable** class whose each object consuming potentially big amount of memory inherit from.
   6 The class that incarnates this concept is ParaMEDMEM::TimeLabel.
   7
   8 Here are some of examples of classes that inherit from \ref ParaMEDMEM::TimeLabel "TimeLabel" class :
   9
  10 - ParaMEDMEM::DataArrayInt, ParaMEDMEM::DataArrayDouble
  11 - ParaMEDMEM::MEDCouplingMesh
  12 - ParaMEDMEM::MEDCouplingFieldDouble
  13 - ...
  14
  15 This class is in charge of storing a 32 bits unsigned integer called time label, that allows the user to know easily, if an heavy object in memory has been modified or not.
  16
  17 The usage is simple :
  18
  19 - Call ParaMEDMEM::TimeLabel::getTimeOfThis a first time to retrieve a reference. Store the returned unsigned integer.
  20 - When you need to know if the instance inheriting from ParaMEDMEM::TimeLabel has changed or not simply invoke ParaMEDMEM::TimeLabel::getTimeOfThis again and compare with the stored value.
  21   If the value is different, the instance has changed, if not the instance has **not** changed.
  22
  23 The virtual call to ParaMEDMEM::TimeLabel::updateTime changes the behaviour of ParaMEDMEM::TimeLabel::getTimeOfThis ; it is a bug, so please notify the bug into the salome forum.
  24
  25 */