SHAPER  9.12.0
ParametersPlugin_ParametersMgr.h
1 // Copyright (C) 2014-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 PARAMETERSPLUGIN_PARAMETERSMGR_H_
21 #define PARAMETERSPLUGIN_PARAMETERSMGR_H_
22 
23 #include "ParametersPlugin.h"
24 #include <ModelAPI_Feature.h>
25 
33 {
34 public:
36  inline static const std::string& ID()
37  {
38  static const std::string MY_PARAMSMGR_ID("ParametersMgr");
39  return MY_PARAMSMGR_ID;
40  }
41 
44 
47 
49  PARAMETERSPLUGIN_EXPORT virtual void initAttributes();
50 
52  PARAMETERSPLUGIN_EXPORT virtual const std::string& getKind()
53  {
54  static std::string MY_KIND = ParametersPlugin_ParametersMgr::ID();
55  return MY_KIND;
56  };
57 
59  PARAMETERSPLUGIN_EXPORT virtual void execute();
60 
62  PARAMETERSPLUGIN_EXPORT virtual bool isMacro() const { return true; }
63 
65  PARAMETERSPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
66 
69  PARAMETERSPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
70 
73  virtual bool isInHistory() { return false; }
74 };
75 
76 
77 #endif
Feature function that represents the particular functionality of this operation.
Definition: ModelAPI_Feature.h:39
A macro feature which manages list of parameters in the current document.
Definition: ParametersPlugin_ParametersMgr.h:33
static const std::string & ID()
Feature kind.
Definition: ParametersPlugin_ParametersMgr.h:36
virtual ~ParametersPlugin_ParametersMgr()
Destructor.
Definition: ParametersPlugin_ParametersMgr.cpp:30
virtual bool isPersistentResult()
Returns true if result is persistent (stored in document) and on undo-redo, save-open it is not neede...
Definition: ParametersPlugin_ParametersMgr.h:69
virtual const std::string & getKind()
Returns the unique kind of a feature.
Definition: ParametersPlugin_ParametersMgr.h:52
ParametersPlugin_ParametersMgr()
Use plugin manager for features creation.
Definition: ParametersPlugin_ParametersMgr.cpp:25
virtual bool isInHistory()
Returns true if this feature must not be created: this is just an action that is not stored in the fe...
Definition: ParametersPlugin_ParametersMgr.h:73
virtual bool isMacro() const
Reimplemented from ModelAPI_Feature::isMacro(). Returns true.
Definition: ParametersPlugin_ParametersMgr.h:62
virtual bool isPreviewNeeded() const
Reimplemented from ModelAPI_Feature::isPreviewNeeded(). Returns false.
Definition: ParametersPlugin_ParametersMgr.h:65
virtual void execute()
Computes or recomputes the results.
Definition: ParametersPlugin_ParametersMgr.cpp:38
virtual void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: ParametersPlugin_ParametersMgr.cpp:34