SHAPER  9.12.0
ModelHighAPI_Folder.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 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 //--------------------------------------------------------------------------------------
31 class ModelAPI_Document;
33 //--------------------------------------------------------------------------------------
39 {
40 public:
42  MODELHIGHAPI_EXPORT
43  explicit ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder>& theFolder);
45  MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Folder();
46 
47  static std::string ID() { return ModelAPI_Folder::ID(); }
48  virtual std::string getID() { return ID(); }
49  const std::shared_ptr<ModelAPI_Folder>& folder() const {return myFolder;}
50 
52  std::shared_ptr<ModelAPI_AttributeReference> firstFeature() const
53  { return myFirstFeature; }
54 
56  std::shared_ptr<ModelAPI_AttributeReference> lastFeature() const
57  { return myLastFeature; }
58 
60  MODELHIGHAPI_EXPORT
61  void setName(const std::wstring& theName);
62 
64  MODELHIGHAPI_EXPORT
65  std::wstring name() const;
66 
69  //MODELHIGHAPI_EXPORT void execute();
70 
71 
73  MODELHIGHAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
74 
75 protected:
76  bool initialize();
77 
78 private:
79  std::shared_ptr<ModelAPI_Folder> myFolder;
80 
81  std::shared_ptr<ModelAPI_AttributeReference> myFirstFeature;
82  std::shared_ptr<ModelAPI_AttributeReference> myLastFeature;
83 };
84 
85 //--------------------------------------------------------------------------------------
89 MODELHIGHAPI_EXPORT
90 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc);
91 
95 MODELHIGHAPI_EXPORT
96 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
97  const ModelHighAPI_Reference& theFirstFeature,
98  const ModelHighAPI_Reference& theLastFeature);
102 MODELHIGHAPI_EXPORT
103 void removeFolder(std::shared_ptr<ModelHighAPI_Folder>& theFolder);
104 //--------------------------------------------------------------------------------------
105 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */
Attribute that contains reference to feature (located in the same document).
Definition: ModelAPI_AttributeReference.h:32
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
static const std::string & ID()
Folder feature ID.
Definition: ModelAPI_Folder.h:38
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Class for filling ModelAPI_Folder.
Definition: ModelHighAPI_Folder.h:39
void setName(const std::wstring &theName)
Shortcut for data()->setName()
Definition: ModelHighAPI_Folder.cpp:62
ModelHighAPI_Folder(const std::shared_ptr< ModelAPI_Folder > &theFolder)
Constructor for a folder.
Definition: ModelHighAPI_Folder.cpp:31
virtual void dump(ModelHighAPI_Dumper &theDumper) const
To update the folder state.
Definition: ModelHighAPI_Folder.cpp:73
std::shared_ptr< ModelAPI_AttributeReference > lastFeature() const
Last feature reference.
Definition: ModelHighAPI_Folder.h:56
std::shared_ptr< ModelAPI_AttributeReference > firstFeature() const
First feature reference.
Definition: ModelHighAPI_Folder.h:52
virtual ~ModelHighAPI_Folder()
Destructor.
Definition: ModelHighAPI_Folder.cpp:38
std::wstring name() const
Shortcut for data()->name()
Definition: ModelHighAPI_Folder.cpp:68
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeReference.
Definition: ModelHighAPI_Reference.h:41
void removeFolder(std::shared_ptr< ModelHighAPI_Folder > &theFolder)
Removes Folder feature.
Definition: ModelHighAPI_Folder.cpp:119
std::shared_ptr< ModelHighAPI_Folder > addFolder(const std::shared_ptr< ModelAPI_Document > &theDoc)
Create empty Folder feature.
Definition: ModelHighAPI_Folder.cpp:95