updated copyright message

[modules/shaper.git] / src / GeomValidators / GeomValidators_ShapeType.h

diff --git a/src/GeomValidators/GeomValidators_ShapeType.h b/src/GeomValidators/GeomValidators_ShapeType.h
index fd6e24e1888cd45f9a81070565c545e977d53497..d7cb899e3c7c8c6788849bc254a9e791580d73e3 100644 (file)
--- a/src/GeomValidators/GeomValidators_ShapeType.h
+++ b/src/GeomValidators/GeomValidators_ShapeType.h
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomValidators_ShapeType.h
-// Created:     19 Mar 2015
-// Author:      Natalia ERMOLAEVA
+// Copyright (C) 2014-2023  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 GeomValidators_ShapeType_H
 #define GeomValidators_ShapeType_H
@@ -23,7 +36,7 @@
 class GeomValidators_ShapeType : public ModelAPI_AttributeValidator
 {
  public:
-  //  the edge type
+  /// Type of shape
   enum TypeOfShape
   {
     Empty,
@@ -31,46 +44,57 @@ class GeomValidators_ShapeType : public ModelAPI_AttributeValidator
     Edge,
     Line,
     Circle,
+    Wire,
     Face,
+    Plane,
+    Shell,
     Solid,
+    CompSolid,
     Compound,
-    Plane,
     AnyShape
   };
 
  public:
    GEOMVALIDATORS_EXPORT GeomValidators_ShapeType() {}
   //! Returns true if attribute has shape type listed in the parameter arguments
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
+  //! \param[in] theAttribute the checked attribute
+  //! \param[in] theArguments arguments of the attribute
+  //! \param[out] theError error message.
   GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                              const std::list<std::string>& theArguments,
-                                             std::string& theError) const;
-protected:
+                                             Events_InfoMessage& theError) const;
+
   /// Convert string to TypeOfShape value
   /// \param theType a string value
-  static TypeOfShape shapeType(const std::string& theType);
+  GEOMVALIDATORS_EXPORT static TypeOfShape shapeType(const std::string& theType);
 
+protected:
   /// Returns true if the attibute's object type satisfies the argument value
-  /// \param theAttribute a checked attribute
-  /// \param theArgument a parameter
+  /// \param[in] theAttribute a checked attribute
+  /// \param[in] theShapeType a type of shape
+  /// \param[out] theError error message.
+  GEOMVALIDATORS_EXPORT
   bool isValidAttribute(const AttributePtr& theAttribute,
                         const TypeOfShape theShapeType,
-                        std::string& theError) const;
+                        Events_InfoMessage& theError) const;
 
   /// Returns true if the attibute's object type satisfies the argument value
-  /// \param theAttribute a checked object
-  /// \param theShapeType a shape type
+  /// \param[in] theObject a checked object
+  /// \param[in] theShapeType a shape type
+  /// \param[out] theError error message.
   bool isValidObject(const ObjectPtr& theObject,
                      const TypeOfShape theShapeType,
-                     std::string& theError) const;
+                     const bool theIsGeometricalSelection,
+                     Events_InfoMessage& theError) const;
 
   /// Returns true if the attibute's object type satisfies the argument value
-  /// \param theShape a checked shape
-  /// \param theShapeType a shape type
+  /// \param[in] theShape a checked shape
+  /// \param[in] theShapeType a shape type
+  /// \param[out] theError error message.
   bool isValidShape(const GeomShapePtr theShape,
                     const TypeOfShape theShapeType,
-                    std::string& theError) const;
+                    const bool theIsGeometricalSelection,
+                    Events_InfoMessage& theError) const;
 
 };