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 ModelAPI_Folder_H_
22 #define ModelAPI_Folder_H_
25 #include <ModelAPI_Object.h>
27 /**\class ModelAPI_Folder
29 * \brief Folder feature (groups the features).
31 class ModelAPI_Folder : public ModelAPI_Object
34 MODELAPI_EXPORT ModelAPI_Folder();
35 /// To virtually destroy the fields of successors
36 MODELAPI_EXPORT virtual ~ModelAPI_Folder();
39 static const std::string& ID()
41 static const std::string MY_FOLDER_ID("Folder");
45 /// Returns the unique kind of a feature
46 virtual const std::string& getKind()
48 static const std::string& MY_KIND = ModelAPI_Folder::ID();
52 /// Returns the group identifier of all features
53 inline static std::string group()
55 static std::string MY_GROUP = "Folders";
59 /// Returns the group identifier of this result
60 virtual std::string groupName()
65 /// Attribute referring first feature in the folder
66 static const std::string& FIRST_FEATURE_ID()
68 static const std::string MY_FIRST_FEATURE_ID("first_feature");
69 return MY_FIRST_FEATURE_ID;
72 /// Attribute referring last feature in the folder
73 static const std::string& LAST_FEATURE_ID()
75 static const std::string MY_LAST_FEATURE_ID("last_feature");
76 return MY_LAST_FEATURE_ID;
79 /// Request for initialization of data model of the object: adding all attributes
80 MODELAPI_EXPORT virtual void initAttributes();
82 /// Computes or recomputes the results
83 MODELAPI_EXPORT virtual void execute();
85 /// Returns the feature is disabled or not.
86 virtual bool isDisabled()
90 // Helper methods, aliases for data()->method()
91 // -----------------------------------------------------------------------------------------------
92 /// Returns the name stored in the attribute
93 inline std::string name()
95 return data()->name();
99 /// This method is called just after creation of the object: it must initialize
100 /// all fields, normally initialized in the constructor
101 MODELAPI_EXPORT virtual void init();
104 //! Pointer on a folder object
105 typedef std::shared_ptr<ModelAPI_Folder> FolderPtr;