src/MEDCoupling/MEDCouplingRefCountObject.hxx

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