X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_DataMapOfShapeShape.h;h=1d09aff6b1cc102a9df79dadaa6cfd95b0130ec1;hb=f60dc9dd94d5d4b0ea07e3e3cbfd5b3028f0942d;hp=cbc5f113c52947c28e6a74b6ce06c5ef2dc8fa58;hpb=a3508b5b0db5dd5857049f3f046bd628030d9bb9;p=modules%2Fshaper.git diff --git a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h index cbc5f113c..1d09aff6b 100644 --- a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h +++ b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h @@ -1,8 +1,22 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: GeomAPI_DataMapOfShapeShape.h -// Created: 28 Oct 2014 -// Author: Sergey Zaritchny +// Copyright (C) 2014-2017 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,8 +24,7 @@ #include #include -class GeomAPI_Pnt; -class GeomAPI_Dir; +#include /**\class GeomAPI_DataMapOfShapeShape * \ingroup DataModel @@ -20,36 +33,44 @@ class GeomAPI_Dir; class GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface { public: - /// Creation of plane by the point and normal - GEOMAPI_EXPORT + /// Constructor. + GEOMAPI_EXPORT GeomAPI_DataMapOfShapeShape(); - /// Clear - GEOMAPI_EXPORT + /// Clears map. + GEOMAPI_EXPORT void clear(); - /// Size of the map - GEOMAPI_EXPORT + /// 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 (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. - GEOMAPI_EXPORT - 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. - GEOMAPI_EXPORT - const std::shared_ptr find(std::shared_ptr theKey); - - /// Removes the Key from the map. Returns true if the Key was in the Map - GEOMAPI_EXPORT - 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_EXPORT ~GeomAPI_DataMapOfShapeShape(); };