X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_ShapeExplorer.h;h=a1835b0536c8564bdaf6c07028c66cd9d950b0c8;hb=4df4bd61da1ea5d357671c819a8ced6ec9ba77ac;hp=fac506fd1589fa20393a039e1e4749fe1dcfffbe;hpb=a3508b5b0db5dd5857049f3f046bd628030d9bb9;p=modules%2Fshaper.git

diff --git a/src/GeomAPI/GeomAPI_ShapeExplorer.h b/src/GeomAPI/GeomAPI_ShapeExplorer.h
index fac506fd1..a1835b053 100644
--- a/src/GeomAPI/GeomAPI_ShapeExplorer.h
+++ b/src/GeomAPI/GeomAPI_ShapeExplorer.h
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomAPI_ShapeExplorer.h
-// Created:     5 June 2015
-// Author:      Dmitry Bobylev
+// 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<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef GeomAPI_ShapeExplorer_H_
 #define GeomAPI_ShapeExplorer_H_
@@ -14,21 +28,21 @@
  *  \ingroup DataModel
  *  \brief This class is used to explore subshapes on shape.
  */
-
 class GeomAPI_ShapeExplorer : public GeomAPI_Interface
 {
 public:
   /// Default constructor. Creates an empty explorer, becomes usefull after Init.
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   GeomAPI_ShapeExplorer();
 
   /** \brief Constructs an explorer to search on theShape, for shapes of type toFind,
    *  that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE,
    *  or if it is the same as, or less complex than the shape toFind it has no effect on the search.
-      \param[in] toFind shape type to find.
-      \param[in] toAvoid shape type to avoid.
+   *  \param[in] theShape shape to explore.
+   *  \param[in] toFind shape type to find.
+   *  \param[in] toAvoid shape type to avoid.
    */
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   GeomAPI_ShapeExplorer(const std::shared_ptr<GeomAPI_Shape>& theShape,
                         const GeomAPI_Shape::ShapeType toFind,
                         const GeomAPI_Shape::ShapeType toAvoid = GeomAPI_Shape::SHAPE);
@@ -36,36 +50,39 @@ public:
   /** \brief Resets this explorer. It is initialized to search on theShape, for shapes of type toFind,
    *  that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE,
    *  or if it is the same as, or less complex than the shape toFind it has no effect on the search.
-      \param[in] toFind shape type to find.
-      \param[in] toAvoid shape type to avoid.
+   *  \param[in] theShape shape to explore.
+   *  \param[in] toFind shape type to find.
+   *  \param[in] toAvoid shape type to avoid.
    */
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void init(const std::shared_ptr<GeomAPI_Shape>& theShape,
             const GeomAPI_Shape::ShapeType toFind,
             const GeomAPI_Shape::ShapeType toAvoid = GeomAPI_Shape::SHAPE);
 
   /// \return true if there are more shapes in the exploration.
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   bool more() const;
 
-  /// Moves to the next Shape in the exploration or do nothing if there are no more shapes to explore.
-  GEOMAPI_EXPORT 
+  /// Moves to the next Shape in the exploration or do nothing
+  /// if there are no more shapes to explore.
+  GEOMAPI_EXPORT
   void next();
 
-  /// Returns the current shape in the exploration or empty pointer if this explorer has no more shapes to explore.
-  GEOMAPI_EXPORT 
+  /// \return the current shape in the exploration or empty pointer
+  /// if this explorer has no more shapes to explore.
+  GEOMAPI_EXPORT
   std::shared_ptr<GeomAPI_Shape> current();
 
   /// Reinitialize the exploration with the original arguments.
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void reinit();
 
-  /// Returns the current depth of the exploration. 0 is the shape to explore itself.
-  GEOMAPI_EXPORT 
+  /// \return the current depth of the exploration. 0 is the shape to explore itself.
+  GEOMAPI_EXPORT
   int depth() const;
 
   /// Clears the content of the explorer. It will return False on more().
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void clear();
 
 };