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_Object_H_
22 #define ModelAPI_Object_H_
25 #include "ModelAPI_Data.h"
26 #include "ModelAPI_Entity.h"
31 class ModelAPI_Document;
33 // sometimes it is useful for debug to see name of each object (bad for memory and performance)
36 /**\class ModelAPI_Object
38 * \brief Represents any object in the data model and in the object browser.
40 * It may be feature or result of the feature. User just may set name for it
41 * or change this name later. Generic class for Feature, Body, Parameter and other
42 * objects related to the features and their results. Contains attributes of this
43 * object in the "Data".
45 class ModelAPI_Object: public ModelAPI_Entity
47 std::shared_ptr<ModelAPI_Data> myData; ///< manager of the data model of a feature
48 std::shared_ptr<ModelAPI_Document> myDoc; ///< document this object belongs to
51 std::string myName; // name of this object
53 /// By default object is displayed in the object browser.
54 MODELAPI_EXPORT virtual bool isInHistory();
56 /// Makes object presented or not in the history of the created objects
57 /// \param theObject is shared pointer to "this"
58 /// \param theFlag is boolean value: to add or remove from the history
59 MODELAPI_EXPORT virtual void setInHistory(
60 const std::shared_ptr<ModelAPI_Object> theObject, const bool theFlag);
62 /// Returns the data manager of this object: attributes
63 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
65 /// Returns true if object refers to the same data model instance
66 MODELAPI_EXPORT virtual bool isSame(const std::shared_ptr<ModelAPI_Object>& theObject);
68 /// Returns document this feature belongs to
69 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
71 /// Returns the group identifier of this object
72 virtual std::string groupName() = 0;
74 /// Request for initialization of data model of the object: adding all attributes
75 virtual void initAttributes() = 0;
77 /// Returns the feature is disabled or not.
78 virtual bool isDisabled() = 0;
80 /// Returns the parameters of color definition in the resources config manager
81 virtual void colorConfigInfo(std::string& theSection, std::string& theName,
82 std::string& theDefault) {}
84 /// Called on change of any argument-attribute of this object
85 /// \param theID identifier of changed attribute
86 MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
88 /// Initializes the default states of the object
89 MODELAPI_EXPORT ModelAPI_Object();
91 /// To use virtuality for destructors
92 MODELAPI_EXPORT virtual ~ModelAPI_Object();
94 /// Returns true if object must be displayed in the viewer: flag is stored in the
95 /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
96 /// the original state in the current transaction.
97 MODELAPI_EXPORT virtual bool isDisplayed();
99 /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
101 MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay);
104 /// This method is called just after creation of the object: it must initialize
105 /// all fields, normally initialized in the constructor
106 MODELAPI_EXPORT virtual void init() = 0;
108 /// Sets the data manager of an object (document does)
109 MODELAPI_EXPORT virtual void setData(std::shared_ptr<ModelAPI_Data> theData);
111 /// Sets the data manager of an object (document does)
112 MODELAPI_EXPORT virtual void setDoc(std::shared_ptr<ModelAPI_Document> theDoc);
114 /// removes all fields from this feature
115 MODELAPI_EXPORT virtual void erase();
117 friend class Model_Objects;
118 friend class ModelAPI_Feature;
119 friend class Model_Document;
123 typedef std::shared_ptr<ModelAPI_Object> ObjectPtr;