1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: GeomValidators_ShapeType.h
4 // Created: 19 Mar 2015
5 // Author: Natalia ERMOLAEVA
7 #ifndef GeomValidators_ShapeType_H
8 #define GeomValidators_ShapeType_H
10 #include "GeomValidators.h"
11 #include "ModelAPI_AttributeValidator.h"
13 #include <GeomAPI_Shape.h>
19 * A validator for shape types, such as vertex, line, circe or arc.
20 * If there are some argument parameters, this validator returns true if the attribute satisfied
21 * at least one argument (OR combination of arguments).
23 class GeomValidators_ShapeType : public ModelAPI_AttributeValidator
42 GEOMVALIDATORS_EXPORT GeomValidators_ShapeType() {}
43 //! Returns true if attribute has shape type listed in the parameter arguments
44 //! \param[in] theAttribute the checked attribute
45 //! \param[in] theArguments arguments of the attribute
46 //! \param[out] theError error message.
47 GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
48 const std::list<std::string>& theArguments,
49 std::string& theError) const;
51 /// Convert string to TypeOfShape value
52 /// \param theType a string value
53 static TypeOfShape shapeType(const std::string& theType);
55 /// Returns true if the attibute's object type satisfies the argument value
56 /// \param[in] theAttribute a checked attribute
57 /// \param[in] theShapeType a type of shape
58 /// \param[out] theError error message.
59 bool isValidAttribute(const AttributePtr& theAttribute,
60 const TypeOfShape theShapeType,
61 std::string& theError) const;
63 /// Returns true if the attibute's object type satisfies the argument value
64 /// \param[in] theObject a checked object
65 /// \param[in] theShapeType a shape type
66 /// \param[out] theError error message.
67 bool isValidObject(const ObjectPtr& theObject,
68 const TypeOfShape theShapeType,
69 std::string& theError) const;
71 /// Returns true if the attibute's object type satisfies the argument value
72 /// \param[in] theShape a checked shape
73 /// \param[in] theShapeType a shape type
74 /// \param[out] theError error message.
75 bool isValidShape(const GeomShapePtr theShape,
76 const TypeOfShape theShapeType,
77 std::string& theError) const;