Salome HOME
Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0
[modules/shaper.git] / src / ModelAPI / ModelAPI_Object.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        ModelAPI_Object.hxx
4 // Created:     19 May 2014
5 // Author:      Mikhail PONIKAROV
6
7 #ifndef ModelAPI_Object_H_
8 #define ModelAPI_Object_H_
9
10 #include "ModelAPI.h"
11 #include "ModelAPI_Data.h"
12
13 #include <memory>
14
15 class ModelAPI_Data;
16 class ModelAPI_Document;
17
18 /**\class ModelAPI_Object
19  * \ingroup DataModel
20  * \brief Represents any object in the data model and in the object browser.
21  *
22  * It may be feature or result of the feature. User just may set name for it
23  * or change this name later. Generic class for Feature, Body, Parameter and other
24  * objects related to the features and their results. Contains attributes of this 
25  * object in the "Data".
26  */
27 class ModelAPI_Object
28 {
29   std::shared_ptr<ModelAPI_Data> myData;  ///< manager of the data model of a feature
30   std::shared_ptr<ModelAPI_Document> myDoc;  ///< document this object belongs to
31  public:
32   /// By default object is displayed in the object browser.
33   MODELAPI_EXPORT virtual bool isInHistory();
34
35   /// Returns the data manager of this object: attributes
36   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
37
38   /// Returns true if object refers to the same data model instance
39   MODELAPI_EXPORT virtual bool isSame(const std::shared_ptr<ModelAPI_Object>& theObject);
40
41   /// Returns document this feature belongs to
42   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
43
44   /// Returns the group identifier of this object
45   virtual std::string groupName() = 0;
46
47   /// Request for initialization of data model of the object: adding all attributes
48   virtual void initAttributes() = 0;
49
50   /// Called on change of any argument-attribute of this object
51   /// \param theID identifier of changed attribute
52   // MODELAPI_EXPORT
53   MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
54
55   /// To use virtuality for destructors
56   MODELAPI_EXPORT virtual ~ModelAPI_Object();
57
58  protected:
59   /// Sets the data manager of an object (document does)
60   MODELAPI_EXPORT virtual void setData(std::shared_ptr<ModelAPI_Data> theData);
61
62   /// Sets the data manager of an object (document does)
63   MODELAPI_EXPORT virtual void setDoc(std::shared_ptr<ModelAPI_Document> theDoc);
64
65   /// removes all fields from this feature
66   MODELAPI_EXPORT virtual void erase();
67
68   friend class Model_Document;
69
70 };
71
72 typedef std::shared_ptr<ModelAPI_Object> ObjectPtr;
73
74 #endif