src/GeomAPI/GeomAPI_DataMapOfShapeShape.h

   1 // Copyright (C) 2014-2023  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_DataMapOfShapeShape_H_
  21 #define GeomAPI_DataMapOfShapeShape_H_
  22
  23 #include <memory>
  24 #include <GeomAPI_Interface.h>
  25
  26 #include <GeomAPI_Shape.h>
  27
  28 /**\class GeomAPI_DataMapOfShapeShape
  29  * \ingroup DataModel
  30  * \brief DataMap of Shape - Shape defined by TopoDS_Shapes
  31  */
  32 class GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface
  33 {
  34  public:
  35   /// Constructor.
  36   GEOMAPI_EXPORT
  37   GeomAPI_DataMapOfShapeShape();
  38
  39   /// Clears map.
  40   GEOMAPI_EXPORT
  41   void clear();
  42
  43   /// Size of the map.
  44   GEOMAPI_EXPORT
  45   int size();
  46
  47   /// Adds \a theKey to me with \a theItem. Returns True if the Key  was not already in the map.
  48   GEOMAPI_EXPORT
  49   bool bind (const std::shared_ptr<GeomAPI_Shape> theKey,
  50              const std::shared_ptr<GeomAPI_Shape> theItem);
  51
  52   /// Merges two maps.
  53   GEOMAPI_EXPORT void merge(const GeomAPI_DataMapOfShapeShape& theDataMap);
  54
  55   /// Merges two maps.
  56   GEOMAPI_EXPORT void merge(const std::shared_ptr<GeomAPI_DataMapOfShapeShape> theDataMap);
  57
  58   /// \return true if theKey is stored  in the map.
  59   GEOMAPI_EXPORT
  60   bool isBound (const std::shared_ptr<GeomAPI_Shape> theKey);
  61
  62   /// \return the Item stored  with the Key in the Map.
  63   GEOMAPI_EXPORT
  64   const std::shared_ptr<GeomAPI_Shape> find(const std::shared_ptr<GeomAPI_Shape> theKey);
  65
  66   /// \brief Removes the Key from the  map.
  67   /// \return true if the Key was in the Map.
  68   GEOMAPI_EXPORT
  69   bool unBind(const std::shared_ptr<GeomAPI_Shape> theKey);
  70
  71   /// Destructor
  72   GEOMAPI_EXPORT
  73   ~GeomAPI_DataMapOfShapeShape();
  74 };
  75
  76 #endif
  77