src/MEDCoupling/MEDCouplingRefCountObject.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_MEDCOUPLINGREFCOUNTOBJECT_HXX__
  22 #define __PARAMEDMEM_MEDCOUPLINGREFCOUNTOBJECT_HXX__
  23
  24 #include "MEDCoupling.hxx"
  25
  26 #include <set>
  27 #include <vector>
  28 #include <string>
  29 #include <cstddef>
  30
  31 namespace MEDCoupling
  32 {
  33   typedef enum
  34   {
  35     C_DEALLOC = 2,
  36     CPP_DEALLOC = 3
  37   } DeallocType;
  38
  39   //! The various spatial discretization of a field
  40   typedef enum
  41   {
  42     ON_CELLS = 0,
  43     ON_NODES = 1,
  44     ON_GAUSS_PT = 2,
  45     ON_GAUSS_NE = 3,
  46     ON_NODES_KR = 4
  47   } TypeOfField;
  48
  49   //! The various temporal discretization of a field
  50   typedef enum
  51   {
  52     NO_TIME = 4,
  53     ONE_TIME = 5,
  54     LINEAR_TIME = 6,
  55     CONST_ON_TIME_INTERVAL = 7
  56   } TypeOfTimeDiscretization;
  57
  58   typedef bool (*FunctionToEvaluate)(const double *pos, double *res);
  59
  60   MEDCOUPLING_EXPORT const char *MEDCouplingVersionStr();
  61   MEDCOUPLING_EXPORT int MEDCouplingVersion();
  62   MEDCOUPLING_EXPORT void MEDCouplingVersionMajMinRel(int& maj, int& minor, int& releas);
  63   MEDCOUPLING_EXPORT int MEDCouplingSizeOfVoidStar();
  64   MEDCOUPLING_EXPORT bool MEDCouplingByteOrder();
  65   MEDCOUPLING_EXPORT const char *MEDCouplingByteOrderStr();
  66
  67   class BigMemoryObject
  68   {
  69   public:
  70     MEDCOUPLING_EXPORT std::size_t getHeapMemorySize() const;
  71     MEDCOUPLING_EXPORT std::string getHeapMemorySizeStr() const;
  72     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getDirectChildren() const;
  73     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getAllTheProgeny() const;
  74     MEDCOUPLING_EXPORT bool isObjectInTheProgeny(const BigMemoryObject *obj) const;
  75     MEDCOUPLING_EXPORT static std::size_t GetHeapMemorySizeOfObjs(const std::vector<const BigMemoryObject *>& objs);
  76     MEDCOUPLING_EXPORT virtual std::size_t getHeapMemorySizeWithoutChildren() const = 0;
  77     MEDCOUPLING_EXPORT virtual std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const = 0;
  78     MEDCOUPLING_EXPORT virtual ~BigMemoryObject();
  79   private:
  80     static std::size_t GetHeapMemoryOfSet(std::set<const BigMemoryObject *>& s1, std::set<const BigMemoryObject *>& s2);
  81   };
  82
  83   class RefCountObjectOnly
  84   {
  85   protected:
  86     MEDCOUPLING_EXPORT RefCountObjectOnly();
  87     MEDCOUPLING_EXPORT RefCountObjectOnly(const RefCountObjectOnly& other);
  88   public:
  89     MEDCOUPLING_EXPORT bool decrRef() const;
  90     MEDCOUPLING_EXPORT void incrRef() const;
  91     MEDCOUPLING_EXPORT int getRCValue() const;
  92     MEDCOUPLING_EXPORT RefCountObjectOnly& operator=(const RefCountObjectOnly& other);
  93   protected:
  94     virtual ~RefCountObjectOnly();
  95   private:
  96     mutable int _cnt;
  97   };
  98
  99   class RefCountObject : public RefCountObjectOnly, public BigMemoryObject
 100   {
 101   protected:
 102     MEDCOUPLING_EXPORT RefCountObject();
 103     MEDCOUPLING_EXPORT RefCountObject(const RefCountObject& other);
 104     MEDCOUPLING_EXPORT virtual ~RefCountObject();
 105   };
 106 }
 107
 108 #endif