src/GEOMAlgo/GEOMAlgo_PassKey.hxx

   1 // Copyright (C) 2007-2024  CEA, EDF, 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 <Basics_OCCTVersion.hxx>
  32
  33 #include <Standard.hxx>
  34 #include <Standard_Macro.hxx>
  35 #include <Standard_Integer.hxx>
  36 #include <Standard_Boolean.hxx>
  37
  38 #include <TColStd_ListOfInteger.hxx>
  39 #include <TColStd_IndexedMapOfInteger.hxx>
  40
  41 //=======================================================================
  42 //class : GEOMAlgo_PassKey
  43 //purpose  :
  44 //=======================================================================
  45 class GEOMAlgo_PassKey  {
  46  public:
  47   Standard_EXPORT
  48     GEOMAlgo_PassKey();
  49
  50   Standard_EXPORT
  51     virtual ~GEOMAlgo_PassKey();
  52
  53   Standard_EXPORT
  54     GEOMAlgo_PassKey(const GEOMAlgo_PassKey& Other);
  55
  56   Standard_EXPORT
  57     GEOMAlgo_PassKey& Assign(const GEOMAlgo_PassKey& Other) ;
  58
  59   GEOMAlgo_PassKey& operator =(const GEOMAlgo_PassKey& Other) {
  60     return Assign(Other);
  61   }
  62
  63   Standard_EXPORT
  64     void Clear() ;
  65
  66   Standard_EXPORT
  67     void SetIds(const Standard_Integer aI1) ;
  68
  69   Standard_EXPORT
  70     void SetIds(const Standard_Integer aI1,
  71                 const Standard_Integer aI2) ;
  72
  73   Standard_EXPORT
  74     void SetIds(const Standard_Integer aI1,
  75                 const Standard_Integer aI2,
  76                 const Standard_Integer aI3) ;
  77
  78   Standard_EXPORT
  79     void SetIds(const Standard_Integer aI1,
  80                 const Standard_Integer aI2,
  81                 const Standard_Integer aI3,
  82                 const Standard_Integer aI4) ;
  83
  84   Standard_EXPORT
  85     void SetIds(const TColStd_ListOfInteger& aLS) ;
  86
  87   Standard_EXPORT
  88     Standard_Integer NbIds() const;
  89
  90   Standard_EXPORT
  91     Standard_Boolean IsEqual(const GEOMAlgo_PassKey& aOther) const;
  92
  93 #if OCC_VERSION_LARGE < 0x07080000
  94   Standard_EXPORT
  95     Standard_Integer HashCode(const Standard_Integer Upper) const;
  96 #endif
  97
  98   Standard_EXPORT
  99   bool operator==(const GEOMAlgo_PassKey& theOther) const
 100   {
 101     return IsEqual(theOther);
 102   }
 103
 104   Standard_EXPORT
 105   size_t GetSum() const { return (size_t)mySum; }
 106
 107   Standard_EXPORT
 108     Standard_Integer Id(const Standard_Integer aIndex) const;
 109
 110   Standard_EXPORT
 111     void Dump(const Standard_Integer aHex = 0) const;
 112
 113  protected:
 114   Standard_Integer myNbIds;
 115   Standard_Integer mySum;
 116   TColStd_IndexedMapOfInteger myMap;
 117 };
 118
 119 namespace std
 120 {
 121   template <>
 122   struct hash<GEOMAlgo_PassKey>
 123   {
 124     size_t operator()(const GEOMAlgo_PassKey& thePK) const noexcept
 125     {
 126       return thePK.GetSum();
 127     }
 128   };
 129 }
 130 #endif