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