]> SALOME platform Git repositories - modules/shaper.git/blob - src/BuildAPI/BuildAPI_Edge.h
Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / BuildAPI / BuildAPI_Edge.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 BuildAPI_Edge_H_
22 #define BuildAPI_Edge_H_
23
24 #include "BuildAPI.h"
25
26 #include <BuildPlugin_Edge.h>
27
28 #include <ModelHighAPI_Interface.h>
29 #include <ModelHighAPI_Macro.h>
30
31 class ModelHighAPI_Selection;
32
33 /// \class BuildAPI_Edge
34 /// \ingroup CPPHighAPI
35 /// \brief Interface for Edge feature.
36 class BuildAPI_Edge: public ModelHighAPI_Interface
37 {
38 public:
39   /// Constructor without values.
40   BUILDAPI_EXPORT
41   explicit BuildAPI_Edge(const std::shared_ptr<ModelAPI_Feature>& theFeature);
42
43   /// Constructor with values.
44   BUILDAPI_EXPORT
45   explicit BuildAPI_Edge(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46                          const std::list<ModelHighAPI_Selection>& theBaseObjects);
47
48   /// Destructor.
49   BUILDAPI_EXPORT
50   virtual ~BuildAPI_Edge();
51
52   INTERFACE_1(BuildPlugin_Edge::ID(),
53               baseObjects, BuildPlugin_Edge::BASE_OBJECTS_ID(),
54               ModelAPI_AttributeSelectionList, /** Base objects */)
55
56   /// Modify base attribute of the feature.
57   BUILDAPI_EXPORT
58   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
59
60   /// Dump wrapped feature
61   BUILDAPI_EXPORT
62   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
63 };
64
65 /// Pointer on Edge object.
66 typedef std::shared_ptr<BuildAPI_Edge> EdgePtr;
67
68 /// \ingroup CPPHighAPI
69 /// \brief Create Edge feature.
70 BUILDAPI_EXPORT
71 EdgePtr addEdge(const std::shared_ptr<ModelAPI_Document>& thePart,
72                 const std::list<ModelHighAPI_Selection>& theBaseObjects);
73
74 #endif // BuildAPI_Edge_H_