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 PartSetPlugin_Part_H_
22 #define PartSetPlugin_Part_H_
24 #include "PartSetPlugin.h"
25 #include <ModelAPI_CompositeFeature.h>
27 /**\class PartSetPlugin_Part
29 * \brief Feature for creation of the new part in PartSet.
30 * All sub-features are sub-elements of composite feature.
32 class PartSetPlugin_Part : public ModelAPI_CompositeFeature
36 inline static const std::string& ID()
38 static const std::string MY_PART_KIND("Part");
41 /// Returns the kind of a feature
42 PARTSETPLUGIN_EXPORT virtual const std::string& getKind()
44 static std::string MY_KIND = PartSetPlugin_Part::ID();
48 /// Returns to which group in the document must be added feature
49 PARTSETPLUGIN_EXPORT virtual const std::string& getGroup()
51 static std::string MY_GROUP = "Parts";
55 /// Creates a new part document if needed
56 PARTSETPLUGIN_EXPORT virtual void execute();
58 /// Request for initialization of data model of the feature: adding all attributes
59 PARTSETPLUGIN_EXPORT virtual void initAttributes();
61 /// Part must be added only to PartSet
62 PARTSETPLUGIN_EXPORT virtual const std::string& documentToAdd();
64 // composite feature methods
66 /// Adds feature to its document
67 virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
69 /// Returns the number of sub-features of the document
70 virtual int numberOfSubs(bool forTree = false) const;
72 /// Returns the sub-feature by zero-base index
73 virtual std::shared_ptr<ModelAPI_Feature> subFeature(const int theIndex, bool forTree = false);
75 /// Returns the sub-feature unique identifier in this composite feature by zero-base index
76 virtual int subFeatureId(const int theIndex) const;
78 /// Returns true if feature or reuslt belong to this composite feature as subs
79 virtual bool isSub(ObjectPtr theObject) const;
81 /// This method to inform that sub-feature is removed and must be removed from the internal data
82 /// structures of the owner (the remove from the document will be done outside just after)
83 virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
85 /// Use plugin manager for features creation
88 /// Just removes all features of the part without touching the document data (to be able undo)
89 PARTSETPLUGIN_EXPORT virtual void erase();