Salome HOME
b22d7bb0f7b59f021ede68a7263b20564deb2063
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_PassKey.hxx
1 // Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 // File:        GEOMAlgo_PassKey.hxx
24 // Created:
25 // Author:      Peter KURNEV
26 //              <peter@PREFEX>
27 //
28 #ifndef _GEOMAlgo_PassKey_HeaderFile
29 #define _GEOMAlgo_PassKey_HeaderFile
30
31 #include <Standard.hxx>
32 #include <Standard_Macro.hxx>
33 #include <Standard_Integer.hxx>
34 #include <Standard_Boolean.hxx>
35
36 #include <TColStd_ListOfInteger.hxx>
37 #include <TColStd_IndexedMapOfInteger.hxx>
38
39 //=======================================================================
40 //class : GEOMAlgo_PassKey
41 //purpose  :
42 //=======================================================================
43 class GEOMAlgo_PassKey  {
44  public:
45   Standard_EXPORT
46     GEOMAlgo_PassKey();
47
48   Standard_EXPORT
49     virtual ~GEOMAlgo_PassKey();
50
51   Standard_EXPORT
52     GEOMAlgo_PassKey(const GEOMAlgo_PassKey& Other);
53
54   Standard_EXPORT
55     GEOMAlgo_PassKey& Assign(const GEOMAlgo_PassKey& Other) ;
56
57   GEOMAlgo_PassKey& operator =(const GEOMAlgo_PassKey& Other) {
58     return Assign(Other);
59   }
60
61   Standard_EXPORT
62     void Clear() ;
63
64   Standard_EXPORT
65     void SetIds(const Standard_Integer aI1) ;
66
67   Standard_EXPORT
68     void SetIds(const Standard_Integer aI1,
69                 const Standard_Integer aI2) ;
70
71   Standard_EXPORT
72     void SetIds(const Standard_Integer aI1,
73                 const Standard_Integer aI2,
74                 const Standard_Integer aI3) ;
75
76   Standard_EXPORT
77     void SetIds(const Standard_Integer aI1,
78                 const Standard_Integer aI2,
79                 const Standard_Integer aI3,
80                 const Standard_Integer aI4) ;
81
82   Standard_EXPORT
83     void SetIds(const TColStd_ListOfInteger& aLS) ;
84
85   Standard_EXPORT
86     Standard_Integer NbIds() const;
87
88   Standard_EXPORT
89     Standard_Boolean IsEqual(const GEOMAlgo_PassKey& aOther) const;
90
91   Standard_EXPORT
92     Standard_Integer HashCode(const Standard_Integer Upper) const;
93
94   Standard_EXPORT
95     Standard_Integer Id(const Standard_Integer aIndex) const;
96
97   Standard_EXPORT
98     void Dump(const Standard_Integer aHex = 0) const;
99
100  protected:
101   Standard_Integer myNbIds;
102   Standard_Integer mySum;
103   TColStd_IndexedMapOfInteger myMap;
104 };
105 #endif