1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef GeomValidators_ShapeType_H
21 #define GeomValidators_ShapeType_H
23 #include "GeomValidators.h"
24 #include "ModelAPI_AttributeValidator.h"
26 #include <GeomAPI_Shape.h>
32 * A validator for shape types, such as vertex, line, circe or arc.
33 * If there are some argument parameters, this validator returns true if the attribute satisfied
34 * at least one argument (OR combination of arguments).
36 class GeomValidators_ShapeType : public ModelAPI_AttributeValidator
58 GEOMVALIDATORS_EXPORT GeomValidators_ShapeType() {}
59 //! Returns true if attribute has shape type listed in the parameter arguments
60 //! \param[in] theAttribute the checked attribute
61 //! \param[in] theArguments arguments of the attribute
62 //! \param[out] theError error message.
63 GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
64 const std::list<std::string>& theArguments,
65 Events_InfoMessage& theError) const;
67 /// Convert string to TypeOfShape value
68 /// \param theType a string value
69 GEOMVALIDATORS_EXPORT static TypeOfShape shapeType(const std::string& theType);
71 /// Returns true if the attibute's object type satisfies the argument value
72 /// \param[in] theAttribute a checked attribute
73 /// \param[in] theShapeType a type of shape
74 /// \param[out] theError error message.
76 bool isValidAttribute(const AttributePtr& theAttribute,
77 const TypeOfShape theShapeType,
78 Events_InfoMessage& theError) const;
80 /// Returns true if the attibute's object type satisfies the argument value
81 /// \param[in] theObject a checked object
82 /// \param[in] theShapeType a shape type
83 /// \param[out] theError error message.
84 bool isValidObject(const ObjectPtr& theObject,
85 const TypeOfShape theShapeType,
86 const bool theIsGeometricalSelection,
87 Events_InfoMessage& theError) const;
89 /// Returns true if the attibute's object type satisfies the argument value
90 /// \param[in] theShape a checked shape
91 /// \param[in] theShapeType a shape type
92 /// \param[out] theError error message.
93 bool isValidShape(const GeomShapePtr theShape,
94 const TypeOfShape theShapeType,
95 const bool theIsGeometricalSelection,
96 Events_InfoMessage& theError) const;