Salome HOME
Linux porting
[modules/shaper.git] / src / GeomAPI / GeomAPI_ShapeExplorer.h
index 29136a0cb8e21513869d5342e4e84665c25dadeb..a1835b0536c8564bdaf6c07028c66cd9d950b0c8 100644 (file)
@@ -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_
@@ -24,8 +38,9 @@ public:
   /** \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_ShapeExplorer(const std::shared_ptr<GeomAPI_Shape>& theShape,
@@ -35,8 +50,9 @@ 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
   void init(const std::shared_ptr<GeomAPI_Shape>& theShape,
@@ -47,11 +63,13 @@ public:
   GEOMAPI_EXPORT
   bool more() const;
 
-  /// Moves to the next Shape in the exploration or do nothing if there are no more shapes to explore.
+  /// Moves to the next Shape in the exploration or do nothing
+  /// if there are no more shapes to explore.
   GEOMAPI_EXPORT
   void next();
 
-  /// \return the current shape in the exploration or empty pointer if this explorer has no more shapes to explore.
+  /// \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();