src/GeomValidators/GeomValidators_ShapeType.h

   1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomValidators_ShapeType_H
  21 #define GeomValidators_ShapeType_H
  22
  23 #include "GeomValidators.h"
  24 #include "ModelAPI_AttributeValidator.h"
  25
  26 #include <GeomAPI_Shape.h>
  27
  28 #include <string>
  29
  30 /**
  31 * \ingroup Validators
  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).
  35 */
  36 class GeomValidators_ShapeType : public ModelAPI_AttributeValidator
  37 {
  38  public:
  39   /// Type of shape
  40   enum TypeOfShape
  41   {
  42     Empty,
  43     Vertex,
  44     Edge,
  45     Line,
  46     Circle,
  47     Wire,
  48     Face,
  49     Plane,
  50     Shell,
  51     Solid,
  52     CompSolid,
  53     Compound,
  54     AnyShape
  55   };
  56
  57  public:
  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;
  66 protected:
  67   /// Convert string to TypeOfShape value
  68   /// \param theType a string value
  69   static TypeOfShape shapeType(const std::string& theType);
  70
  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.
  75   bool isValidAttribute(const AttributePtr& theAttribute,
  76                         const TypeOfShape theShapeType,
  77                         Events_InfoMessage& theError) const;
  78
  79   /// Returns true if the attibute's object type satisfies the argument value
  80   /// \param[in] theObject a checked object
  81   /// \param[in] theShapeType a shape type
  82   /// \param[out] theError error message.
  83   bool isValidObject(const ObjectPtr& theObject,
  84                      const TypeOfShape theShapeType,
  85                      const bool theIsGeometricalSelection,
  86                      Events_InfoMessage& theError) const;
  87
  88   /// Returns true if the attibute's object type satisfies the argument value
  89   /// \param[in] theShape a checked shape
  90   /// \param[in] theShapeType a shape type
  91   /// \param[out] theError error message.
  92   bool isValidShape(const GeomShapePtr theShape,
  93                     const TypeOfShape theShapeType,
  94                     const bool theIsGeometricalSelection,
  95                     Events_InfoMessage& theError) const;
  96
  97 };
  98
  99 #endif