X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_DataMapOfShapeShape.h;h=42d811bb08bb3d41b4aa7944fda4ec72745c9bfa;hb=6e421e939851e0de46554ae45a3ca0e1f67cd91d;hp=40c447baed4d31ff5d5c083391ca584a90b4d50e;hpb=3874b57fe5aba25ff5aee2a07654fc23c1ee8eb0;p=modules%2Fshaper.git diff --git a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h index 40c447bae..42d811bb0 100644 --- a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h +++ b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// 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_ @@ -10,39 +23,53 @@ #include #include -class GeomAPI_Pnt; -class GeomAPI_Dir; +#include /**\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(); - /// Size of the map + /// Size of the map. + GEOMAPI_EXPORT int size(); - /// Adds the Key to the Map with the Item. Returns True if the Key was not already in the map - bool bind (std::shared_ptr theKey, std::shared_ptr theItem); + /// 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 theKey, + const std::shared_ptr theItem); + + /// Merges two maps. + GEOMAPI_EXPORT void merge(const GeomAPI_DataMapOfShapeShape& theDataMap); + + /// Merges two maps. + GEOMAPI_EXPORT void merge(const std::shared_ptr theDataMap); + + /// \return true if theKey is stored in the map. + GEOMAPI_EXPORT + bool isBound (const std::shared_ptr theKey); - /// Returns true if theKey is stored in the map. - bool isBound (std::shared_ptr theKey); + /// \return the Item stored with the Key in the Map. + GEOMAPI_EXPORT + const std::shared_ptr find(const std::shared_ptr theKey); - /// Returns the Item stored with the Key in the Map. - const std::shared_ptr find(std::shared_ptr theKey); - - /// Removes the Key from the map. Returns true if the Key was in the Map - bool unBind(std::shared_ptr 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 theKey); /// Destructor + GEOMAPI_EXPORT ~GeomAPI_DataMapOfShapeShape(); };