src/ParametersPlugin/ParametersPlugin_ParametersMgr.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 PARAMETERSPLUGIN_PARAMETERSMGR_H_
  21 #define PARAMETERSPLUGIN_PARAMETERSMGR_H_
  22
  23 #include "ParametersPlugin.h"
  24 #include <ModelAPI_Feature.h>
  25
  26 /**
  27  * \class ParametersPlugin_ParametersMgr
  28  * \ingroup Plugins
  29  * \brief A macro feature which manages list of parameters in the current document.
  30  */
  31
  32 class ParametersPlugin_ParametersMgr : public ModelAPI_Feature
  33 {
  34 public:
  35   /// Feature kind
  36   inline static const std::string& ID()
  37   {
  38     static const std::string MY_PARAMSMGR_ID("ParametersMgr");
  39     return MY_PARAMSMGR_ID;
  40   }
  41
  42   /// Use plugin manager for features creation
  43   ParametersPlugin_ParametersMgr();
  44
  45   /// Destructor
  46   virtual ~ParametersPlugin_ParametersMgr();
  47
  48   /// Request for initialization of data model of the feature: adding all attributes
  49   PARAMETERSPLUGIN_EXPORT virtual void initAttributes();
  50
  51   /// Returns the unique kind of a feature
  52   PARAMETERSPLUGIN_EXPORT virtual const std::string& getKind()
  53   {
  54     static std::string MY_KIND = ParametersPlugin_ParametersMgr::ID();
  55     return MY_KIND;
  56   };
  57
  58   /// Computes or recomputes the results
  59   PARAMETERSPLUGIN_EXPORT virtual void execute();
  60
  61   /// Reimplemented from ModelAPI_Feature::isMacro(). Returns true.
  62   PARAMETERSPLUGIN_EXPORT virtual bool isMacro() const { return true; }
  63
  64   /// Reimplemented from ModelAPI_Feature::isPreviewNeeded(). Returns false.
  65   PARAMETERSPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
  66
  67   /// Returns true if result is persistent (stored in document) and on undo-redo, save-open
  68   /// it is not needed to recompute it.
  69   PARAMETERSPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
  70
  71   /// Returns true if this feature must not be created: this is just an action
  72   /// that is not stored in the features history and data model (like "delete part").
  73   virtual bool isInHistory()  { return false; }
  74 };
  75
  76
  77 #endif