src/SamplePanelPlugin/SamplePanelPlugin_Feature.h

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