Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / BuildPlugin / BuildPlugin_Shell.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 BuildPlugin_Shell_H_
22 #define BuildPlugin_Shell_H_
23
24 #include "BuildPlugin.h"
25
26 #include <ModelAPI_Feature.h>
27
28 /// \class BuildPlugin_Shell
29 /// \ingroup Plugins
30 /// \brief Feature for creation of shell from faces and shells.
31 class BuildPlugin_Shell: public ModelAPI_Feature
32 {
33 public:
34   /// Use plugin manager for features creation
35   BuildPlugin_Shell();
36
37   /// Feature kind.
38   inline static const std::string& ID()
39   {
40     static const std::string MY_ID("Shell");
41     return MY_ID;
42   }
43
44   /// Attribute name of base objects.
45   inline static const std::string& BASE_OBJECTS_ID()
46   {
47     static const std::string MY_BASE_OBJECTS_ID("base_objects");
48     return MY_BASE_OBJECTS_ID;
49   }
50
51   /// \return the kind of a feature.
52   BUILDPLUGIN_EXPORT virtual const std::string& getKind()
53   {
54     static std::string MY_KIND = BuildPlugin_Shell::ID();
55     return MY_KIND;
56   }
57
58   /// Request for initialization of data model of the feature: adding all attributes.
59   BUILDPLUGIN_EXPORT virtual void initAttributes();
60
61   /// Creates a new part document if needed.
62   BUILDPLUGIN_EXPORT virtual void execute();
63 };
64
65 #endif