src/MEDCoupling/MEDCouplingRefCountObject.hxx

   1 // Copyright (C) 2007-2022  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     ON_NODES_FE = 5
  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 MEDCOUPLING_EXPORT BigMemoryObject
  73   {
  74   public:
  75     std::size_t getHeapMemorySize() const;
  76     std::string getHeapMemorySizeStr() const;
  77     std::vector<const BigMemoryObject *> getDirectChildren() const;
  78     std::vector<const BigMemoryObject *> getAllTheProgeny() const;
  79     bool isObjectInTheProgeny(const BigMemoryObject *obj) const;
  80     static std::size_t GetHeapMemorySizeOfObjs(const std::vector<const BigMemoryObject *>& objs);
  81     virtual std::string getClassName() const { return "BigMemoryObject"; }
  82     virtual std::size_t getHeapMemorySizeWithoutChildren() const = 0;
  83     virtual std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const = 0;
  84     std::string debugHeapMemorySize() const;
  85     virtual ~BigMemoryObject();
  86   private:
  87     static std::size_t GetHeapMemoryOfSet(std::set<const BigMemoryObject *>& s1, std::set<const BigMemoryObject *>& s2);
  88   };
  89
  90   class MEDCOUPLING_EXPORT RefCountObjectOnly
  91   {
  92   protected:
  93     RefCountObjectOnly();
  94     RefCountObjectOnly(const RefCountObjectOnly& other);
  95   public:
  96     bool decrRef() const;
  97     void incrRef() const;
  98     int getRCValue() const;
  99     RefCountObjectOnly& operator=(const RefCountObjectOnly& other);
 100   protected:
 101     virtual ~RefCountObjectOnly();
 102   private:
 103     mutable std::atomic<int> _cnt;
 104   };
 105
 106   class MEDCOUPLING_EXPORT RefCountObject : public RefCountObjectOnly, public BigMemoryObject
 107   {
 108   protected:
 109     RefCountObject();
 110     RefCountObject(const RefCountObject& other);
 111     virtual ~RefCountObject();
 112   };
 113
 114   class MEDCOUPLING_EXPORT GlobalDict
 115   {
 116   public:
 117     static GlobalDict *GetInstance();
 118     bool hasKey(const std::string& key) const;
 119     std::string value(const std::string& key) const;
 120     std::vector<std::string> keys() const;
 121     void erase(const std::string& key);
 122     void clear();
 123     void setKeyValue(const std::string& key, const std::string& val);
 124     void setKeyValueForce(const std::string& key, const std::string& val);
 125     std::string printSelf() const;
 126   private:
 127     GlobalDict() { }
 128   private:
 129     static GlobalDict *UNIQUE_INSTANCE;
 130   private:
 131     std::map<std::string, std::string> _my_map;
 132   };
 133 }
 134