]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelHighAPI/ModelHighAPI_Folder.h
Salome HOME
Merge remote-tracking branch 'origin/Custom_Fitter' into CEA_2019
[modules/shaper.git] / src / ModelHighAPI / ModelHighAPI_Folder.h
1 // Copyright (C) 2014-2019  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 SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
21 #define SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
22
23 //--------------------------------------------------------------------------------------
24 #include <ModelHighAPI_Interface.h>
25
26 #include <ModelAPI_Folder.h>
27
28 #include <memory>
29 //--------------------------------------------------------------------------------------
30 class ModelAPI_AttributeReference;
31 class ModelAPI_Document;
32 class ModelHighAPI_Reference;
33 //--------------------------------------------------------------------------------------
34 /**\class ModelHighAPI_Folder
35  * \ingroup CPPHighAPI
36  * \brief Class for filling ModelAPI_Folder
37  */
38 class ModelHighAPI_Folder : public ModelHighAPI_Interface
39 {
40 public:
41   /// Constructor for a folder
42   MODELHIGHAPI_EXPORT
43   explicit ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder>& theFolder);
44   /// Destructor
45   MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Folder();
46
47   static std::string ID() { return ModelAPI_Folder::ID(); }
48   virtual std::string getID() { return ID(); }
49
50   /// First feature reference
51   std::shared_ptr<ModelAPI_AttributeReference> firstFeature() const
52   { return myFirstFeature; }
53
54   /// Last feature reference
55   std::shared_ptr<ModelAPI_AttributeReference> lastFeature() const
56   { return myLastFeature; }
57
58   /// Shortcut for data()->setName()
59   MODELHIGHAPI_EXPORT
60   void setName(const std::string& theName);
61
62   /// Shortcut for data()->name()
63   MODELHIGHAPI_EXPORT
64   std::string name() const;
65
66   /// Dump wrapped feature
67   MODELHIGHAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
68
69 protected:
70   bool initialize();
71
72 private:
73   std::shared_ptr<ModelAPI_Folder> myFolder;
74
75   std::shared_ptr<ModelAPI_AttributeReference> myFirstFeature;
76   std::shared_ptr<ModelAPI_AttributeReference> myLastFeature;
77 };
78
79 //--------------------------------------------------------------------------------------
80 /**\ingroup CPPHighAPI
81  * \brief Create empty Folder feature
82  */
83 MODELHIGHAPI_EXPORT
84 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc);
85
86 /**\ingroup CPPHighAPI
87  * \brief Create Folder feature
88  */
89 MODELHIGHAPI_EXPORT
90 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
91                                                const ModelHighAPI_Reference& theFirstFeature,
92                                                const ModelHighAPI_Reference& theLastFeature);
93 //--------------------------------------------------------------------------------------
94 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */