-// File: GeomAPI_DataMapOfShapeShape.h
-// Created: 28 Oct 2014
-// Author: Sergey Zaritchny
+// Copyright (C) 2014-2019 CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
#ifndef GeomAPI_DataMapOfShapeShape_H_
#define GeomAPI_DataMapOfShapeShape_H_
#include <memory>
#include <GeomAPI_Interface.h>
-class GeomAPI_Pnt;
-class GeomAPI_Dir;
+#include <GeomAPI_Shape.h>
/**\class GeomAPI_DataMapOfShapeShape
* \ingroup DataModel
* \brief DataMap of Shape - Shape defined by TopoDS_Shapes
*/
-
-class GEOMAPI_EXPORT GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface
+class GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface
{
public:
- /// Creation of plane by the point and normal
+ /// Constructor.
+ GEOMAPI_EXPORT
GeomAPI_DataMapOfShapeShape();
- /// Clear
+ /// Clears map.
+ GEOMAPI_EXPORT
void clear();
- /// Adds the Key <K> to the Map <me> with the Item. Returns True if the Key was not already in the map
- bool bind (std::shared_ptr<GeomAPI_Shape> theKey, std::shared_ptr<GeomAPI_Shape> theItem);
+ /// Size of the map.
+ GEOMAPI_EXPORT
+ int size();
+
+ /// Adds \a theKey to me with \a theItem. Returns True if the Key was not already in the map.
+ GEOMAPI_EXPORT
+ bool bind (const std::shared_ptr<GeomAPI_Shape> theKey,
+ const std::shared_ptr<GeomAPI_Shape> theItem);
+
+ /// Merges two maps.
+ GEOMAPI_EXPORT void merge(const GeomAPI_DataMapOfShapeShape& theDataMap);
+
+ /// Merges two maps.
+ GEOMAPI_EXPORT void merge(const std::shared_ptr<GeomAPI_DataMapOfShapeShape> theDataMap);
+
+ /// \return true if theKey is stored in the map.
+ GEOMAPI_EXPORT
+ bool isBound (const std::shared_ptr<GeomAPI_Shape> theKey);
- /// Returns true if theKey is stored in the map.
- bool isBound (std::shared_ptr<GeomAPI_Shape> theKey);
+ /// \return the Item stored with the Key in the Map.
+ GEOMAPI_EXPORT
+ const std::shared_ptr<GeomAPI_Shape> find(const std::shared_ptr<GeomAPI_Shape> theKey);
- /// Returns the Item stored with the Key in the Map.
- const std::shared_ptr<GeomAPI_Shape> find(std::shared_ptr<GeomAPI_Shape> theKey);
-
- /// Removes the Key from the map. Returns true if the Key was in the Map
- bool unBind(std::shared_ptr<GeomAPI_Shape> theKey);
+ /// \brief Removes the Key from the map.
+ /// \return true if the Key was in the Map.
+ GEOMAPI_EXPORT
+ bool unBind(const std::shared_ptr<GeomAPI_Shape> theKey);
/// Destructor
+ GEOMAPI_EXPORT
~GeomAPI_DataMapOfShapeShape();
};
