X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_DataMapOfShapeShape.h;h=42d811bb08bb3d41b4aa7944fda4ec72745c9bfa;hb=adf26479b37f6238c3fd33b7da5f37dd57b68b00;hp=42c8a86d1329e631ef4c4cb3a595d34545a2dc62;hpb=a95effb94656e5d4721f86ccb6ffbc2572bb1214;p=modules%2Fshaper.git

diff --git a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h
index 42c8a86d1..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,8 +23,7 @@
 #include <memory>
 #include <GeomAPI_Interface.h>
 
-class GeomAPI_Pnt;
-class GeomAPI_Dir;
+#include <GeomAPI_Shape.h>
 
 /**\class GeomAPI_DataMapOfShapeShape
  * \ingroup DataModel
@@ -20,42 +32,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<GeomAPI_Shape> theKey, std::shared_ptr<GeomAPI_Shape> 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<GeomAPI_Shape> theKey,
+             const std::shared_ptr<GeomAPI_Shape> theItem);
 
-  /// Merges two maps
+  /// Merges two maps.
   GEOMAPI_EXPORT void merge(const GeomAPI_DataMapOfShapeShape& theDataMap);
 
-  /// Merges two maps
+  /// Merges two maps.
   GEOMAPI_EXPORT void merge(const std::shared_ptr<GeomAPI_DataMapOfShapeShape> theDataMap);
 
-  /// Returns true if theKey is stored  in the map.
-  GEOMAPI_EXPORT 
-  bool isBound (std::shared_ptr<GeomAPI_Shape> theKey);
+  /// \return true if theKey is stored  in the map.
+  GEOMAPI_EXPORT
+  bool isBound (const 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.
-  GEOMAPI_EXPORT 
-  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
-  GEOMAPI_EXPORT 
-  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_EXPORT
   ~GeomAPI_DataMapOfShapeShape();
 };