src/GeomAPI/GeomAPI_IndexedMapOfShape.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   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
  20 #ifndef GeomAPI_IndexedMapOfShape_H_
  21 #define GeomAPI_IndexedMapOfShape_H_
  22
  23 #include <GeomAPI_Interface.h>
  24 #include <GeomAPI_Shape.h>
  25
  26 /**\class GeomAPI_IndexedMapOfShape
  27  * \ingroup DataModel
  28  * \brief IndexedMap of Shape defined by TopoDS_Shape
  29  */
  30 class GeomAPI_IndexedMapOfShape : public GeomAPI_Interface
  31 {
  32  public:
  33   /// Constructor.
  34   GEOMAPI_EXPORT
  35   GeomAPI_IndexedMapOfShape() {};
  36
  37   /// Constructor.
  38   GEOMAPI_EXPORT
  39   GeomAPI_IndexedMapOfShape(const std::shared_ptr<GeomAPI_Shape> theMainShape);
  40
  41   /// Initialize the Map.
  42   GEOMAPI_EXPORT
  43   void MapShapes(const std::shared_ptr<GeomAPI_Shape> theMainShape);
  44
  45   /// \return index of the Key in the Map.
  46   GEOMAPI_EXPORT
  47   int FindIndex(const std::shared_ptr<GeomAPI_Shape> theKey);
  48
  49   /// \return index of the Key in the Map.
  50   /// It works also for the case of equal locations
  51   GEOMAPI_EXPORT
  52   int FindIndexEqualLocations(const std::shared_ptr<GeomAPI_Shape> theKey);
  53
  54   /// Destructor
  55   GEOMAPI_EXPORT
  56   ~GeomAPI_IndexedMapOfShape();
  57 };
  58
  59 #endif
  60