1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
22 #define SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
24 //--------------------------------------------------------------------------------------
25 #include <ModelHighAPI_Interface.h>
27 #include <ModelAPI_Folder.h>
30 //--------------------------------------------------------------------------------------
31 class ModelAPI_AttributeReference;
32 class ModelAPI_Document;
33 class ModelHighAPI_Reference;
34 //--------------------------------------------------------------------------------------
35 /**\class ModelHighAPI_Folder
37 * \brief Class for filling ModelAPI_Folder
39 class ModelHighAPI_Folder : public ModelHighAPI_Interface
42 /// Constructor for a folder
44 explicit ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder>& theFolder);
46 MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Folder();
48 static std::string ID() { return ModelAPI_Folder::ID(); }
49 virtual std::string getID() { return ID(); }
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 /// Dump wrapped feature
60 MODELHIGHAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
66 std::shared_ptr<ModelAPI_Folder> myFolder;
68 std::shared_ptr<ModelAPI_AttributeReference> myFirstFeature;
69 std::shared_ptr<ModelAPI_AttributeReference> myLastFeature;
72 //--------------------------------------------------------------------------------------
73 /**\ingroup CPPHighAPI
74 * \brief Create empty Folder feature
77 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc);
79 /**\ingroup CPPHighAPI
80 * \brief Create Folder feature
83 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
84 const ModelHighAPI_Reference& theFirstFeature,
85 const ModelHighAPI_Reference& theLastFeature);
86 //--------------------------------------------------------------------------------------
87 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */