src/MEDCoupling/MEDCouplingRefCountObject.hxx

   1 // Copyright (C) 2007-2016  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 <map>
  28 #include <atomic>
  29 #include <vector>
  30 #include <string>
  31 #include <cstddef>
  32
  33 namespace MEDCoupling
  34 {
  35   enum class DeallocType
  36   {
  37     C_DEALLOC = 2,
  38     CPP_DEALLOC = 3,
  39     C_DEALLOC_WITH_OFFSET = 4
  40   };
  41
  42   //! The various spatial discretization of a field
  43   typedef enum
  44   {
  45     ON_CELLS = 0,
  46     ON_NODES = 1,
  47     ON_GAUSS_PT = 2,
  48     ON_GAUSS_NE = 3,
  49     ON_NODES_KR = 4
  50   } TypeOfField;
  51
  52   //! The various temporal discretization of a field
  53   typedef enum
  54   {
  55     NO_TIME = 4,
  56     ONE_TIME = 5,
  57     LINEAR_TIME = 6,
  58     CONST_ON_TIME_INTERVAL = 7
  59   } TypeOfTimeDiscretization;
  60
  61   typedef bool (*FunctionToEvaluate)(const double *pos, double *res);
  62
  63   MEDCOUPLING_EXPORT const char *MEDCouplingVersionStr();
  64   MEDCOUPLING_EXPORT int MEDCouplingVersion();
  65   MEDCOUPLING_EXPORT void MEDCouplingVersionMajMinRel(int& maj, int& minor, int& releas);
  66   MEDCOUPLING_EXPORT int MEDCouplingSizeOfVoidStar();
  67   MEDCOUPLING_EXPORT std::size_t MEDCouplingSizeOfIDs();
  68   MEDCOUPLING_EXPORT bool MEDCouplingByteOrder();
  69   MEDCOUPLING_EXPORT const char *MEDCouplingByteOrderStr();
  70   MEDCOUPLING_EXPORT bool IsCXX11Compiled();
  71
  72   class BigMemoryObject
  73   {
  74   public:
  75     MEDCOUPLING_EXPORT std::size_t getHeapMemorySize() const;
  76     MEDCOUPLING_EXPORT std::string getHeapMemorySizeStr() const;
  77     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getDirectChildren() const;
  78     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getAllTheProgeny() const;
  79     MEDCOUPLING_EXPORT bool isObjectInTheProgeny(const BigMemoryObject *obj) const;
  80     MEDCOUPLING_EXPORT static std::size_t GetHeapMemorySizeOfObjs(const std::vector<const BigMemoryObject *>& objs);
  81     MEDCOUPLING_EXPORT virtual std::size_t getHeapMemorySizeWithoutChildren() const = 0;
  82     MEDCOUPLING_EXPORT virtual std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const = 0;
  83     MEDCOUPLING_EXPORT virtual ~BigMemoryObject();
  84   private:
  85     static std::size_t GetHeapMemoryOfSet(std::set<const BigMemoryObject *>& s1, std::set<const BigMemoryObject *>& s2);
  86   };
  87
  88   class RefCountObjectOnly
  89   {
  90   protected:
  91     MEDCOUPLING_EXPORT RefCountObjectOnly();
  92     MEDCOUPLING_EXPORT RefCountObjectOnly(const RefCountObjectOnly& other);
  93   public:
  94     MEDCOUPLING_EXPORT bool decrRef() const;
  95     MEDCOUPLING_EXPORT void incrRef() const;
  96     MEDCOUPLING_EXPORT int getRCValue() const;
  97     MEDCOUPLING_EXPORT RefCountObjectOnly& operator=(const RefCountObjectOnly& other);
  98   protected:
  99     virtual ~RefCountObjectOnly();
 100   private:
 101     mutable std::atomic<int> _cnt;
 102   };
 103
 104   class RefCountObject : public RefCountObjectOnly, public BigMemoryObject
 105   {
 106   protected:
 107     MEDCOUPLING_EXPORT RefCountObject();
 108     MEDCOUPLING_EXPORT RefCountObject(const RefCountObject& other);
 109     MEDCOUPLING_EXPORT virtual ~RefCountObject();
 110   };
 111
 112   class GlobalDict
 113   {
 114   public:
 115     MEDCOUPLING_EXPORT static GlobalDict *GetInstance();
 116     MEDCOUPLING_EXPORT bool hasKey(const std::string& key) const;
 117     MEDCOUPLING_EXPORT std::string value(const std::string& key) const;
 118     MEDCOUPLING_EXPORT std::vector<std::string> keys() const;
 119     MEDCOUPLING_EXPORT void erase(const std::string& key);
 120     MEDCOUPLING_EXPORT void clear();
 121     MEDCOUPLING_EXPORT void setKeyValue(const std::string& key, const std::string& val);
 122     MEDCOUPLING_EXPORT void setKeyValueForce(const std::string& key, const std::string& val);
 123     MEDCOUPLING_EXPORT std::string printSelf() const;
 124   private:
 125     GlobalDict() { }
 126   private:
 127     static GlobalDict *UNIQUE_INSTANCE;
 128   private:
 129     std::map<std::string, std::string> _my_map;
 130   };
 131 }
 132
 133 #endif