src/GeomValidators/GeomValidators_NotSelfIntersected.h

   1 // Copyright (C) 2014-2021  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_NotSelfIntersected_H
  21 #define GeomValidators_NotSelfIntersected_H
  22
  23 #include <GeomValidators.h>
  24
  25 #include <ModelAPI_Feature.h>
  26 #include <ModelAPI_FeatureValidator.h>
  27
  28 /// \class GeomValidators_NotSelfIntersected
  29 /// \ingroup Validators
  30 /// \brief Validates that selected shapes are not self intersected.
  31 class GeomValidators_NotSelfIntersected: public ModelAPI_FeatureValidator
  32 {
  33 public:
  34   /// \return True if the attribute is valid. It checks whether the selection
  35   /// is not self intersected.
  36   /// \param[in] theAttribute an attribute to check.
  37   /// \param[in] theArguments a filter parameters.
  38   /// \param[out] theError error message.
  39   GEOMVALIDATORS_EXPORT virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  40                                              const std::list<std::string>& theArguments,
  41                                              Events_InfoMessage& theError) const;
  42
  43   /// \return true if the attribute in feature is not obligatory for the feature execution.
  44   GEOMVALIDATORS_EXPORT virtual bool isNotObligatory(std::string theFeature,
  45                                                      std::string theAttribute);
  46 };
  47
  48 #endif