src/SamplePanelPlugin/SamplePanelPlugin_Feature.h

   1 // Copyright (C) 2014-2022  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 SAMPLEPANELPLUGIN_FEATURE_H_
  21 #define SAMPLEPANELPLUGIN_FEATURE_H_
  22
  23 #include "SamplePanelPlugin.h"
  24
  25 #include <ModelAPI_Feature.h>
  26
  27 /**\class SamplePanelPlugin_Feature
  28  * \ingroup Plugins
  29  * \brief Sample feature to be filled by the panel.
  30  */
  31 class SamplePanelPlugin_Feature : public ModelAPI_Feature
  32 {
  33  public:
  34   /// SketchShape feature kind
  35   inline static const std::string& ID()
  36   {
  37     static const std::string MY_SAMPLE_PANEL_FEATURE_ID("QtPanelFeature");
  38     return MY_SAMPLE_PANEL_FEATURE_ID;
  39   }
  40
  41   /// Total number of objects, initial and translated objects
  42   inline static const std::string& VALUE_ID()
  43   {
  44     static const std::string MY_VALUE_ID("Value");
  45     return MY_VALUE_ID;
  46   }
  47
  48   /// Request for initialization of data model of the object: adding all attributes
  49   virtual void initAttributes();
  50
  51   /// Returns the unique kind of a feature
  52   virtual const std::string& getKind() {
  53     static std::string MY_KIND = SamplePanelPlugin_Feature::ID();
  54     return MY_KIND;
  55   };
  56
  57   /// Computes or recomputes the results
  58   virtual void execute() {}
  59
  60   /// Use plugin manager for features creation
  61   SamplePanelPlugin_Feature();
  62 };
  63
  64 typedef std::shared_ptr<SamplePanelPlugin_Feature> SamplePanelFeaturePtr;
  65
  66 #endif