src/FeaturesPlugin/FeaturesPlugin_GeometryCalculation.h

   1 // Copyright (C) 2018-2023  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_GeometryCalculation_H_
  21 #define FeaturesPlugin_GeometryCalculation_H_
  22
  23 #include "FeaturesPlugin.h"
  24 #include <ModelAPI_Feature.h>
  25
  26 #include <GeomAPI_IPresentable.h>
  27 #include <GeomAPI_IScreenParams.h>
  28
  29 /// \class FeaturesPlugin_GeometryCalculation
  30 /// \ingroup Plugins
  31 /// \brief Feature for geometry calculation.
  32
  33 class FeaturesPlugin_GeometryCalculation : public ModelAPI_Feature
  34 {
  35 public:
  36   inline static const std::string& ID()
  37   {
  38     static const std::string MY_ID("GeometryCalculation");
  39     return MY_ID;
  40   }
  41
  42   /// \return the kind of a feature.
  43   virtual const std::string& getKind()
  44   {
  45     return ID();
  46   }
  47
  48   /// Attribute name for object selected.
  49   inline static const std::string& OBJECT_SELECTED_ID()
  50   {
  51     static const std::string MY_OBJECT_SELECTED_ID("main_object");
  52     return MY_OBJECT_SELECTED_ID;
  53   }
  54
  55   /// Attribute name for length
  56   inline static const std::string& LENGTH_ID()
  57   {
  58     static const std::string MY_LENGTH_ID("length");
  59     return MY_LENGTH_ID;
  60   }
  61
  62   /// Attribute name for area
  63   inline static const std::string& AREA_ID()
  64   {
  65     static const std::string MY_AREA_ID("area");
  66     return MY_AREA_ID;
  67   }
  68
  69   /// Attribute name for volume.
  70   inline static const std::string& VOLUME_ID()
  71   {
  72     static const std::string MY_VOLUME_ID("volume");
  73     return MY_VOLUME_ID;
  74   }
  75
  76   /// Attribute name for values of result.
  77   inline static const std::string& RESULT_VALUES_ID()
  78   {
  79     static const std::string MY_RESULT_VALUES_ID("result_values");
  80     return MY_RESULT_VALUES_ID;
  81   }
  82
  83   /// Performs the algorithm and stores results it in the data structure.
  84   FEATURESPLUGIN_EXPORT virtual void execute();
  85
  86   /// Request for initialization of data model of the feature: adding all attributes
  87   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  88
  89   /// Called on change of any argument-attribute of this object
  90   /// \param theID identifier of changed attribute
  91   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  92
  93   /// Reimplemented from ModelAPI_Feature::isMacro(). Returns true.
  94   FEATURESPLUGIN_EXPORT virtual bool isMacro() const { return true; }
  95
  96   /// Use plugin manager for features creation
  97   FeaturesPlugin_GeometryCalculation();
  98
  99 };
 100
 101 #endif