src/GEOMAlgo/GEOMAlgo_PassKey.hxx

   1 // Copyright (C) 2007-2013  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.
  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 <TColStd_IndexedMapOfInteger.hxx>
  35 #include <Standard_Boolean.hxx>
  36 #include <TColStd_ListOfInteger.hxx>
  37
  38 //=======================================================================
  39 //class : GEOMAlgo_PassKey
  40 //purpose  :
  41 //=======================================================================
  42 class GEOMAlgo_PassKey  {
  43  public:
  44   Standard_EXPORT
  45     GEOMAlgo_PassKey();
  46
  47   Standard_EXPORT
  48     virtual ~GEOMAlgo_PassKey();
  49
  50   Standard_EXPORT
  51     GEOMAlgo_PassKey(const GEOMAlgo_PassKey& Other);
  52
  53   Standard_EXPORT
  54     GEOMAlgo_PassKey& Assign(const GEOMAlgo_PassKey& Other) ;
  55
  56   GEOMAlgo_PassKey& operator =(const GEOMAlgo_PassKey& Other) {
  57     return Assign(Other);
  58   }
  59
  60   Standard_EXPORT
  61     void Clear() ;
  62
  63   Standard_EXPORT
  64     void SetIds(const Standard_Integer aI1) ;
  65
  66   Standard_EXPORT
  67     void SetIds(const Standard_Integer aI1,
  68                 const Standard_Integer aI2) ;
  69
  70   Standard_EXPORT
  71     void SetIds(const Standard_Integer aI1,
  72                 const Standard_Integer aI2,
  73                 const Standard_Integer aI3) ;
  74
  75   Standard_EXPORT
  76     void SetIds(const Standard_Integer aI1,
  77                 const Standard_Integer aI2,
  78                 const Standard_Integer aI3,
  79                 const Standard_Integer aI4) ;
  80
  81   Standard_EXPORT
  82     void SetIds(const TColStd_ListOfInteger& aLS) ;
  83
  84   Standard_EXPORT
  85     Standard_Integer NbIds() const;
  86
  87   Standard_EXPORT
  88     Standard_Boolean IsEqual(const GEOMAlgo_PassKey& aOther) const;
  89
  90   Standard_EXPORT
  91     Standard_Integer HashCode(const Standard_Integer Upper) const;
  92
  93   Standard_EXPORT
  94     Standard_Integer Id(const Standard_Integer aIndex) const;
  95
  96   Standard_EXPORT
  97     void Dump(const Standard_Integer aHex = 0) const;
  98
  99  protected:
 100   Standard_Integer myNbIds;
 101   Standard_Integer mySum;
 102   TColStd_IndexedMapOfInteger myMap;
 103 };
 104 #endif