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 ModelAPI_Object_H_
21 #define ModelAPI_Object_H_
24 #include "ModelAPI_Data.h"
25 #include "ModelAPI_Entity.h"
30 class ModelAPI_Document;
32 // sometimes it is useful for debug to see name of each object (bad for memory and performance)
35 /**\class ModelAPI_Object
37 * \brief Represents any object in the data model and in the object browser.
39 * It may be feature or result of the feature. User just may set name for it
40 * or change this name later. Generic class for Feature, Body, Parameter and other
41 * objects related to the features and their results. Contains attributes of this
42 * object in the "Data".
44 class ModelAPI_Object: public ModelAPI_Entity
46 std::shared_ptr<ModelAPI_Data> myData; ///< manager of the data model of a feature
47 std::shared_ptr<ModelAPI_Document> myDoc; ///< document this object belongs to
50 std::string myName; // name of this object
52 /// By default object is displayed in the object browser.
53 MODELAPI_EXPORT virtual bool isInHistory();
55 /// Makes object presented or not in the history of the created objects
56 /// \param theObject is shared pointer to "this"
57 /// \param theFlag is boolean value: to add or remove from the history
58 MODELAPI_EXPORT virtual void setInHistory(
59 const std::shared_ptr<ModelAPI_Object> theObject, const bool theFlag);
61 /// Returns the data manager of this object: attributes
62 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
64 /// Returns true if object refers to the same data model instance
65 MODELAPI_EXPORT virtual bool isSame(const std::shared_ptr<ModelAPI_Object>& theObject);
67 /// Returns document this feature belongs to
68 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
70 /// Returns the group identifier of this object
71 virtual std::string groupName() = 0;
73 /// Request for initialization of data model of the object: adding all attributes
74 virtual void initAttributes() = 0;
76 /// Returns the feature is disabled or not.
77 virtual bool isDisabled() = 0;
79 /// Returns the parameters of color definition in the resources config manager
80 virtual void colorConfigInfo(std::string& theSection, std::string& theName,
81 std::string& theDefault) {}
83 /// Called on change of any argument-attribute of this object
84 /// \param theID identifier of changed attribute
85 MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
87 /// Initializes the default states of the object
88 MODELAPI_EXPORT ModelAPI_Object();
90 /// To use virtuality for destructors
91 MODELAPI_EXPORT virtual ~ModelAPI_Object();
93 /// Returns true if object must be displayed in the viewer: flag is stored in the
94 /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
95 /// the original state in the current transaction.
96 MODELAPI_EXPORT virtual bool isDisplayed();
98 /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
100 MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay);
103 /// This method is called just after creation of the object: it must initialize
104 /// all fields, normally initialized in the constructor
105 MODELAPI_EXPORT virtual void init() = 0;
107 /// Sets the data manager of an object (document does)
108 MODELAPI_EXPORT virtual void setData(std::shared_ptr<ModelAPI_Data> theData);
110 /// Sets the data manager of an object (document does)
111 MODELAPI_EXPORT virtual void setDoc(std::shared_ptr<ModelAPI_Document> theDoc);
113 /// removes all fields from this feature
114 MODELAPI_EXPORT virtual void erase();
116 friend class Model_Objects;
117 friend class ModelAPI_Feature;
118 friend class Model_Document;
122 typedef std::shared_ptr<ModelAPI_Object> ObjectPtr;