doc/user/doxygen/doxfiles/reference/cpp/cpp.dox

   1 /*!
   2   \page cpp Note for C++ developpers
   3
   4 Using the C++ API provided by MED requires you to be familiar with some specificities which are not
   5 visible to the Python user.
   6
   7 - \ref MEDCoupling::MEDCouplingAutoRefCountObjectPtr "MEDCouplingAutoRefCountObjectPtr"
   8 - \subpage MEDCouplingTimeLabelPage
   9
  10 \b Note: all the standard (sequential) MEDCoupling API lies in the \ref MEDCoupling "MEDCoupling namespace".
  11 This is quite unfortunate but due to historical reasons. The true parallel functionalities
  12 of the \ref library "MED library" are detailed here: \ref parallel
  13
  14 The memory management of the various strucutres is eased by the class
  15 \ref MEDCoupling::MEDCouplingAutoRefCountObjectPtr "MEDCouplingAutoRefCountObjectPtr". It acts as an auto pointer and takes care of deleting the
  16 memory automatically when going out of scope. See an example usage in \ref cpp_mcfielddouble_WriteVTK .
  17 Beware however that not all functions return a pointer that should be deleted when going out of scope.
  18 Some methods only return an observer to the data, see for example \ref MEDCoupling::MEDCouplingPointSet::getCoords() "getCoords()". The API documentation of each method indicates whether the caller is responsible of the returned
  19 data or not.
  20
  21 For advanced usage, one has to be aware of the stamping mechanism used internally to know
  22 whether an instance has been modified or not. This is described in the second page above:
  23  \ref MEDCouplingTimeLabelPage
  24
  25   */