1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
21 #define SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
23 //--------------------------------------------------------------------------------------
24 #include <ModelHighAPI_Interface.h>
26 #include <ModelAPI_Folder.h>
29 //--------------------------------------------------------------------------------------
30 class ModelAPI_AttributeReference;
31 class ModelAPI_Document;
32 class ModelHighAPI_Reference;
33 //--------------------------------------------------------------------------------------
34 /**\class ModelHighAPI_Folder
36 * \brief Class for filling ModelAPI_Folder
38 class ModelHighAPI_Folder : public ModelHighAPI_Interface
41 /// Constructor for a folder
43 explicit ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder>& theFolder);
45 MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Folder();
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;}
51 /// First feature reference
52 std::shared_ptr<ModelAPI_AttributeReference> firstFeature() const
53 { return myFirstFeature; }
55 /// Last feature reference
56 std::shared_ptr<ModelAPI_AttributeReference> lastFeature() const
57 { return myLastFeature; }
59 /// Shortcut for data()->setName()
61 void setName(const std::string& theName);
63 /// Shortcut for data()->name()
65 std::string name() const;
67 /// To update the folder state
68 /// \param isForce start execution of feature instead of sending events
69 //MODELHIGHAPI_EXPORT void execute();
72 /// Dump wrapped feature
73 MODELHIGHAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
79 std::shared_ptr<ModelAPI_Folder> myFolder;
81 std::shared_ptr<ModelAPI_AttributeReference> myFirstFeature;
82 std::shared_ptr<ModelAPI_AttributeReference> myLastFeature;
85 //--------------------------------------------------------------------------------------
86 /**\ingroup CPPHighAPI
87 * \brief Create empty Folder feature
90 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc);
92 /**\ingroup CPPHighAPI
93 * \brief Create Folder feature
96 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
97 const ModelHighAPI_Reference& theFirstFeature,
98 const ModelHighAPI_Reference& theLastFeature);
99 /**\ingroup CPPHighAPI
100 * \brief Removes Folder feature
103 void removeFolder(std::shared_ptr<ModelHighAPI_Folder>& theFolder);
104 //--------------------------------------------------------------------------------------
105 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */