src/GeomValidators/GeomValidators_ShapeType.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomValidators_ShapeType.h
   4 // Created:     19 Mar 2015
   5 // Author:      Natalia ERMOLAEVA
   6
   7 #ifndef GeomValidators_ShapeType_H
   8 #define GeomValidators_ShapeType_H
   9
  10 #include "GeomValidators.h"
  11 #include "ModelAPI_AttributeValidator.h"
  12
  13 #include <GeomAPI_Shape.h>
  14
  15 #include <string>
  16
  17 /**
  18 * \ingroup Validators
  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).
  22 */
  23 class GeomValidators_ShapeType : public ModelAPI_AttributeValidator
  24 {
  25  public:
  26   /// Type of shape
  27   enum TypeOfShape
  28   {
  29     Empty,
  30     Vertex,
  31     Edge,
  32     Line,
  33     Circle,
  34     Wire,
  35     Face,
  36     Plane,
  37     Shell,
  38     Solid,
  39     Compound,
  40     AnyShape
  41   };
  42
  43  public:
  44    GEOMVALIDATORS_EXPORT GeomValidators_ShapeType() {}
  45   //! Returns true if attribute has shape type listed in the parameter arguments
  46   //! \param[in] theAttribute the checked attribute
  47   //! \param[in] theArguments arguments of the attribute
  48   //! \param[out] theError error message.
  49   GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
  50                                              const std::list<std::string>& theArguments,
  51                                              std::string& theError) const;
  52 protected:
  53   /// Convert string to TypeOfShape value
  54   /// \param theType a string value
  55   static TypeOfShape shapeType(const std::string& theType);
  56
  57   /// Returns true if the attibute's object type satisfies the argument value
  58   /// \param[in] theAttribute a checked attribute
  59   /// \param[in] theShapeType a type of shape
  60   /// \param[out] theError error message.
  61   bool isValidAttribute(const AttributePtr& theAttribute,
  62                         const TypeOfShape theShapeType,
  63                         std::string& theError) const;
  64
  65   /// Returns true if the attibute's object type satisfies the argument value
  66   /// \param[in] theObject a checked object
  67   /// \param[in] theShapeType a shape type
  68   /// \param[out] theError error message.
  69   bool isValidObject(const ObjectPtr& theObject,
  70                      const TypeOfShape theShapeType,
  71                      std::string& theError) const;
  72
  73   /// Returns true if the attibute's object type satisfies the argument value
  74   /// \param[in] theShape a checked shape
  75   /// \param[in] theShapeType a shape type
  76   /// \param[out] theError error message.
  77   bool isValidShape(const GeomShapePtr theShape,
  78                     const TypeOfShape theShapeType,
  79                     std::string& theError) const;
  80
  81 };
  82
  83 #endif