Salome HOME
Minor doc: recall conformize3D limitation.
[tools/medcoupling.git] / src / MEDCoupling / MEDCouplingPartDefinition.hxx
1 // Copyright (C) 2007-2021  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 (EDF R&D)
20
21 #pragma once
22
23 #include "MEDCoupling.hxx"
24 #include "MEDCouplingMemArray.hxx"
25 #include "MCAuto.hxx"
26
27 namespace MEDCoupling
28 {
29   class PartDefinition : public RefCountObject, public TimeLabel
30   {
31   public:
32     MEDCOUPLING_EXPORT static PartDefinition *New(mcIdType start, mcIdType stop, mcIdType step);
33     MEDCOUPLING_EXPORT static PartDefinition *New(DataArrayIdType *listOfIds);
34     MEDCOUPLING_EXPORT static PartDefinition *Unserialize(std::vector<mcIdType>& tinyInt, std::vector< MCAuto<DataArrayIdType> >& bigArraysI);
35     MEDCOUPLING_EXPORT virtual bool isEqual(const PartDefinition *other, std::string& what) const = 0;
36     MEDCOUPLING_EXPORT virtual PartDefinition *deepCopy() const = 0;
37     MEDCOUPLING_EXPORT virtual DataArrayIdType *toDAI() const = 0;
38     MEDCOUPLING_EXPORT virtual mcIdType getNumberOfElems() const = 0;
39     MEDCOUPLING_EXPORT virtual PartDefinition *operator+(const PartDefinition& other) const = 0;
40     MEDCOUPLING_EXPORT virtual std::string getRepr() const = 0;
41     MEDCOUPLING_EXPORT virtual PartDefinition *composeWith(const PartDefinition *other) const = 0;
42     MEDCOUPLING_EXPORT virtual void checkConsistencyLight() const = 0;
43     MEDCOUPLING_EXPORT virtual PartDefinition *tryToSimplify() const = 0;
44     MEDCOUPLING_EXPORT virtual void serialize(std::vector<mcIdType>& tinyInt, std::vector< MCAuto<DataArrayIdType> >& bigArraysI) const = 0;
45   protected:
46     virtual ~PartDefinition();
47   };
48
49   class SlicePartDefinition;
50
51   class DataArrayPartDefinition : public PartDefinition
52   {
53   public:
54     MEDCOUPLING_EXPORT static DataArrayPartDefinition *New(DataArrayIdType *listOfIds);
55     MEDCOUPLING_EXPORT std::string getClassName() const override { return std::string("DataArrayPartDefinition"); }
56     MEDCOUPLING_EXPORT bool isEqual(const PartDefinition *other, std::string& what) const;
57     MEDCOUPLING_EXPORT DataArrayPartDefinition *deepCopy() const;
58     MEDCOUPLING_EXPORT DataArrayIdType *toDAI() const;
59     MEDCOUPLING_EXPORT mcIdType getNumberOfElems() const;
60     MEDCOUPLING_EXPORT PartDefinition *operator+(const PartDefinition& other) const;
61     MEDCOUPLING_EXPORT std::string getRepr() const;
62     MEDCOUPLING_EXPORT PartDefinition *composeWith(const PartDefinition *other) const;
63     MEDCOUPLING_EXPORT void checkConsistencyLight() const;
64     MEDCOUPLING_EXPORT PartDefinition *tryToSimplify() const;
65     MEDCOUPLING_EXPORT void serialize(std::vector<mcIdType>& tinyInt, std::vector< MCAuto<DataArrayIdType> >& bigArraysI) const;
66   private:
67     DataArrayPartDefinition(DataArrayIdType *listOfIds);
68     void checkInternalArrayOK() const;
69     static void CheckInternalArrayOK(const DataArrayIdType *listOfIds);
70     MEDCOUPLING_EXPORT void updateTime() const;
71     MEDCOUPLING_EXPORT std::size_t getHeapMemorySizeWithoutChildren() const;
72     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const;
73     DataArrayPartDefinition *add1(const DataArrayPartDefinition *other) const;
74     DataArrayPartDefinition *add2(const SlicePartDefinition *other) const;
75     virtual ~DataArrayPartDefinition();
76   private:
77     MCAuto<DataArrayIdType> _arr;
78   };
79
80   class SlicePartDefinition : public PartDefinition
81   {
82   public:
83     MEDCOUPLING_EXPORT static SlicePartDefinition *New(mcIdType start, mcIdType stop, mcIdType step);
84     MEDCOUPLING_EXPORT std::string getClassName() const override { return std::string("SlicePartDefinition"); }
85     MEDCOUPLING_EXPORT bool isEqual(const PartDefinition *other, std::string& what) const;
86     MEDCOUPLING_EXPORT SlicePartDefinition *deepCopy() const;
87     MEDCOUPLING_EXPORT DataArrayIdType *toDAI() const;
88     MEDCOUPLING_EXPORT mcIdType getNumberOfElems() const;
89     MEDCOUPLING_EXPORT PartDefinition *operator+(const PartDefinition& other) const;
90     MEDCOUPLING_EXPORT std::string getRepr() const;
91     MEDCOUPLING_EXPORT PartDefinition *composeWith(const PartDefinition *other) const;
92     MEDCOUPLING_EXPORT void checkConsistencyLight() const;
93     MEDCOUPLING_EXPORT PartDefinition *tryToSimplify() const;
94     MEDCOUPLING_EXPORT void serialize(std::vector<mcIdType>& tinyInt, std::vector< MCAuto<DataArrayIdType> >& bigArraysI) const;
95     //specific method
96     MEDCOUPLING_EXPORT mcIdType getEffectiveStop() const;
97     MEDCOUPLING_EXPORT void getSlice(mcIdType& start, mcIdType& stop, mcIdType& step) const;
98   private:
99     SlicePartDefinition(mcIdType start, mcIdType stop, mcIdType step);
100     MEDCOUPLING_EXPORT void updateTime() const;
101     MEDCOUPLING_EXPORT std::size_t getHeapMemorySizeWithoutChildren() const;
102     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const;
103     DataArrayPartDefinition *add1(const DataArrayPartDefinition *other) const;
104     PartDefinition *add2(const SlicePartDefinition *other) const;
105     virtual ~SlicePartDefinition();
106   private:
107     mcIdType _start;
108     mcIdType _stop;
109     mcIdType _step;
110   };
111 }