src/FeaturesPlugin/FeaturesPlugin_LimitTolerance.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   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 FEATURESPLUGIN_LIMITTOLERANCE_H_
  21 #define FEATURESPLUGIN_LIMITTOLERANCE_H_
  22
  23 #include <FeaturesPlugin.h>
  24
  25 #include <ModelAPI_Feature.h>
  26 #include <GeomAPI_Shape.h>
  27
  28
  29 /** \class FeaturesPlugin_LimitTolerance
  30  *  \ingroup Plugins
  31  *  \brief Feature to limit the tolerance on selected shapes.
  32  */
  33 class FeaturesPlugin_LimitTolerance : public ModelAPI_Feature
  34 {
  35  public:
  36   /// LimitTolerance kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_LIMIT_TOLERANCE_ID("LimitTolerance");
  40     return MY_LIMIT_TOLERANCE_ID;
  41   }
  42
  43   /// \return the kind of a feature.
  44   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  45   {
  46     static std::string MY_KIND = FeaturesPlugin_LimitTolerance::ID();
  47     return MY_KIND;
  48   }
  49
  50   /// Attribute name of referenced object.
  51   inline static const std::string& OBJECT_ID()
  52   {
  53     static const std::string MY_OBJECT_ID("object");
  54     return MY_OBJECT_ID;
  55   }
  56
  57   /// Attribute name for tolerance.
  58   inline static const std::string& TOLERANCE_ID()
  59   {
  60     static const std::string MY_TOLERANCE_ID("tolerance");
  61     return MY_TOLERANCE_ID;
  62   }
  63
  64   /// Request for initialization of data model of the feature: adding all attributes.
  65   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  66
  67   /// Performs the algorithm and stores results in the data structure.
  68   FEATURESPLUGIN_EXPORT virtual void execute();
  69
  70 public:
  71   /// Use plugin manager for features creation.
  72   FeaturesPlugin_LimitTolerance();
  73 };
  74
  75 #endif // FEATURESPLUGIN_LIMITTOLERANCE_H_