src/GeomAPI/GeomAPI_DataMapOfShapeShape.h

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