]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_BooleanCommon.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_BooleanCommon.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 FeaturesPlugin_BooleanCommon_H_
21 #define FeaturesPlugin_BooleanCommon_H_
22
23 #include "FeaturesPlugin_Boolean.h"
24
25 #include <ModelAPI_ResultBody.h>
26
27 /// \class FeaturesPlugin_BooleanCommon
28 /// \ingroup Plugins
29 /// \brief Feature for applying of Boolean Common operation.
30 class FeaturesPlugin_BooleanCommon : public FeaturesPlugin_Boolean
31 {
32 public:
33
34   /// Feature kind.
35   inline static const std::string& ID()
36   {
37     static const std::string MY_ID("Common");
38     return MY_ID;
39   }
40
41   /// \return the kind of a feature.
42   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
43   {
44     static std::string MY_KIND = FeaturesPlugin_BooleanCommon::ID();
45     return MY_KIND;
46   }
47
48   /// Attribute name for creation method.
49   inline static const std::string& CREATION_METHOD()
50   {
51     static const std::string MY_CREATION_METHOD_ID("creation_method");
52     return MY_CREATION_METHOD_ID;
53   }
54
55   /// Attribute name for creation method.
56   inline static const std::string& CREATION_METHOD_SIMPLE()
57   {
58     static const std::string MY_CREATION_METHOD_ID("simple");
59     return MY_CREATION_METHOD_ID;
60   }
61
62   /// Attribute name for creation method.
63   inline static const std::string& CREATION_METHOD_ADVANCED()
64   {
65     static const std::string MY_CREATION_METHOD_ID("advanced");
66     return MY_CREATION_METHOD_ID;
67   }
68
69   /// Request for initialization of data model of the feature: adding all attributes.
70   FEATURESPLUGIN_EXPORT virtual void initAttributes();
71
72   /// Performs the algorithm and stores results it in the data structure.
73   FEATURESPLUGIN_EXPORT virtual void execute();
74
75 public:
76
77   /// Use plugin manager for features creation.
78   FeaturesPlugin_BooleanCommon();
79 };
80
81 #endif