doc/user/doxygen/doxfiles/reference/cpp/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 inherits from.
   6 The class that incarnates this concept is MEDCoupling::TimeLabel.
   7
   8 Here are some of examples of classes that inherit from \ref MEDCoupling::TimeLabel "TimeLabel" class :
   9
  10 - MEDCoupling::DataArrayInt, MEDCoupling::DataArrayDouble
  11 - MEDCoupling::MEDCouplingMesh
  12 - MEDCoupling::MEDCouplingFieldDouble
  13 - ...
  14
  15 This class is in charge of storing a 32 bits unsigned integer called the 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 MEDCoupling::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 MEDCoupling::TimeLabel has changed or not simply invoke MEDCoupling::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 MEDCoupling::TimeLabel::updateTime changes the behaviour of MEDCoupling::TimeLabel::getTimeOfThis ; it is a bug, so please notify the bug on the SALOME forum.
  24
  25 */