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   virtual bool isInHistory()
  34   {
  35     return true;
  36   }
  37
  38   /// Returns the data manager of this object: attributes
  39   virtual std::shared_ptr<ModelAPI_Data> data() const
  40   {
  41     return myData;
  42   }
  43
  44   /// Returns true if object refers to the same data model instance
  45   virtual bool isSame(const std::shared_ptr<ModelAPI_Object>& theObject)
  46   {
  47     return theObject.get() == this;
  48   }
  49
  50   /// Returns document this feature belongs to
  51   virtual std::shared_ptr<ModelAPI_Document> document() const
  52   {
  53     return myDoc;
  54   }
  55
  56   /// Returns the group identifier of this object
  57   virtual std::string groupName() = 0;
  58
  59   /// Called on change of any argument-attribute of this object
  60   /// \param theID identifier of changed attribute
  61   MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID)
  62   {}
  63
  64   /// To use virtuality for destructors
  65   virtual ~ModelAPI_Object() {}
  66
  67  protected:
  68   /// Sets the data manager of an object (document does)
  69   virtual void setData(std::shared_ptr<ModelAPI_Data> theData)
  70   {
  71     myData = theData;
  72   }
  73
  74   /// Sets the data manager of an object (document does)
  75   virtual void setDoc(std::shared_ptr<ModelAPI_Document> theDoc)
  76   {
  77     myDoc = theDoc;
  78   }
  79
  80   /// removes all fields from this feature
  81   MODELAPI_EXPORT virtual void erase() {
  82     if (myData) myData->erase();
  83     setData(DataPtr());
  84   }
  85
  86   friend class Model_Document;
  87
  88 };
  89
  90 typedef std::shared_ptr<ModelAPI_Object> ObjectPtr;
  91
  92 #endif