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 theAttribute the checked attribute
45 //! \param theArguments arguments of the attribute
46 GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
47 const std::list<std::string>& theArguments,
48 std::string& theError) const;
50 /// Convert string to TypeOfShape value
51 /// \param theType a string value
52 static TypeOfShape shapeType(const std::string& theType);
54 /// Returns true if the attibute's object type satisfies the argument value
55 /// \param theAttribute a checked attribute
56 /// \param theArgument a parameter
57 bool isValidAttribute(const AttributePtr& theAttribute,
58 const TypeOfShape theShapeType,
59 std::string& theError) const;
61 /// Returns true if the attibute's object type satisfies the argument value
62 /// \param theAttribute a checked object
63 /// \param theShapeType a shape type
64 bool isValidObject(const ObjectPtr& theObject,
65 const TypeOfShape theShapeType,
66 std::string& theError) const;
68 /// Returns true if the attibute's object type satisfies the argument value
69 /// \param theShape a checked shape
70 /// \param theShapeType a shape type
71 bool isValidShape(const GeomShapePtr theShape,
72 const TypeOfShape theShapeType,
73 std::string& theError) const;