src/Model/Model_Data.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_Data.hxx
   4 // Created:     21 Mar 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef Model_Data_H_
   8 #define Model_Data_H_
   9
  10 #include <Model.h>
  11 #include <ModelAPI_Attribute.h>
  12 #include <ModelAPI_AttributeBoolean.h>
  13 #include <ModelAPI_AttributeDocRef.h>
  14 #include <ModelAPI_AttributeDouble.h>
  15 #include <ModelAPI_AttributeInteger.h>
  16 #include <ModelAPI_AttributeRefAttr.h>
  17 #include <ModelAPI_AttributeReference.h>
  18 #include <ModelAPI_AttributeRefList.h>
  19 #include <ModelAPI_AttributeString.h>
  20 #include <ModelAPI_AttributeIntArray.h>
  21 #include <ModelAPI_Data.h>
  22 #include <ModelAPI_Feature.h>
  23 #include <ModelAPI_Object.h>
  24
  25 #include <TDF_Label.hxx>
  26 #include <TDataStd_BooleanArray.hxx>
  27
  28 #include <memory>
  29
  30 #include <map>
  31 #include <list>
  32 #include <string>
  33 #include <set>
  34
  35 class ModelAPI_Attribute;
  36
  37 /**\class Model_Data
  38  * \ingroup DataModel
  39  * \brief General object of the application that allows
  40  * to get/set attributes from the document and compute result of an operation.
  41  */
  42
  43 class Model_Data : public ModelAPI_Data
  44 {
  45   TDF_Label myLab;  ///< label of the feature in the document
  46   /// All attributes of the object identified by the attribute ID
  47   std::map<std::string, std::shared_ptr<ModelAPI_Attribute> > myAttrs;
  48   /// Array of flags of this data
  49   Handle(TDataStd_BooleanArray) myFlags;
  50
  51   /// needed here to emit signal that object changed on change of the attribute
  52   ObjectPtr myObject;
  53
  54   /// List of attributes referenced to owner (updated only during the transaction change)
  55   std::set<AttributePtr> myRefsToMe;
  56   /// flag that may block the "attribute updated" sending
  57   bool mySendAttributeUpdated;
  58   /// if some attribute was changed, but mySendAttributeUpdated was false, this flag stores this
  59   bool myWasChangedButBlocked;
  60
  61   /// Returns label of this feature
  62   TDF_Label label()
  63   {
  64     return myLab;
  65   }
  66
  67   friend class Model_Document;
  68   friend class Model_Objects;
  69   friend class Model_Update;
  70   friend class Model_AttributeReference;
  71   friend class Model_AttributeRefAttr;
  72   friend class Model_AttributeRefList;
  73   friend class Model_AttributeRefAttrList;
  74   friend class Model_AttributeSelection;
  75   friend class Model_AttributeSelectionList;
  76
  77  public:
  78   /// The simplest constructor. "setLabel" must be called just after to initialize correctly.
  79   Model_Data();
  80   /// Returns the name of the feature visible by the user in the object browser
  81   MODEL_EXPORT virtual std::string name();
  82   /// Defines the name of the feature visible by the user in the object browser
  83   MODEL_EXPORT virtual void setName(const std::string& theName);
  84   /// Returns the attribute that references to another document
  85   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID);
  86   /// Returns the attribute that contains real value with double precision
  87   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID);
  88   /// Returns the attribute that contains integer value
  89   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeInteger>
  90     integer(const std::string& theID);
  91   /// Returns the attribute that contains reference to a feature
  92   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeReference>
  93     reference(const std::string& theID);
  94   /// Returns the attribute that contains selection to a shape
  95   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelection>
  96     selection(const std::string& theID);
  97   /// Returns the attribute that contains selection to a shape
  98   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelectionList>
  99     selectionList(const std::string& theID);
 100   /// Returns the attribute that contains reference to an attribute of a feature
 101   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttr>
 102     refattr(const std::string& theID);
 103   /// Returns the attribute that contains list of references to features
 104   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefList>
 105     reflist(const std::string& theID);
 106   /// Returns the attribute that contains boolean value
 107   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeBoolean>
 108     boolean(const std::string& theID);
 109   /// Returns the attribute that contains real value with double precision
 110   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeString>
 111     string(const std::string& theID);
 112   /// Returns the attribute that contains integer values array
 113   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeIntArray>
 114     intArray(const std::string& theID);
 115
 116   /// Returns the generic attribute by identifier
 117   /// \param theID identifier of the attribute
 118   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID);
 119   /// Returns all attributes of the feature of the given type
 120   /// or all attributes if "theType" is empty
 121   MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Attribute> >
 122     attributes(const std::string& theType);
 123   /// Returns all attributes ids of the feature of the given type
 124   /// or all attributes if "theType" is empty
 125   MODEL_EXPORT virtual std::list<std::string> attributesIDs(const std::string& theType);
 126
 127   /// Identifier by the id (not fast, iteration by map)
 128   /// \param theAttr attribute already created in this data
 129   MODEL_EXPORT virtual const std::string& id(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
 130   /// Returns true if data belongs to same features
 131   MODEL_EXPORT virtual bool isEqual(const std::shared_ptr<ModelAPI_Data>& theData);
 132   /// Returns true if it is correctly connected t othe data model
 133   MODEL_EXPORT virtual bool isValid();
 134
 135   /// Returns the label where the shape must be stored (used in ResultBody)
 136   TDF_Label& shapeLab()
 137   {
 138     return myLab;
 139   }
 140
 141   /// Initializes object by the attributes: must be called just after the object is created
 142   /// for each attribute of the object
 143   /// \param theID identifier of the attribute that can be referenced by this ID later
 144   /// \param theAttrType type of the created attribute (received from the type method)
 145   /// \returns the just created attribute
 146   MODEL_EXPORT virtual AttributePtr
 147     addAttribute(const std::string& theID, const std::string theAttrType);
 148
 149   /// Useful method for "set" methods of the attributes: sends an UPDATE event and
 150   /// makes attribute initialized
 151   MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
 152   /// Blocks sending "attribute updated" if theBlock is true
 153   MODEL_EXPORT virtual void blockSendAttributeUpdated(const bool theBlock);
 154
 155   /// Puts feature to the document data sub-structure
 156   MODEL_EXPORT void setLabel(TDF_Label theLab);
 157
 158   /// Sets the object of this data
 159   MODEL_EXPORT virtual void setObject(ObjectPtr theObject)
 160   {
 161     myObject = theObject;
 162   }
 163
 164   /// Erases all the data from the data model
 165   MODEL_EXPORT virtual void erase();
 166
 167   /// Stores the state of the object to execute it later accordingly
 168   MODEL_EXPORT virtual void execState(const ModelAPI_ExecState theState);
 169
 170   /// Returns the state of the latest execution of the feature
 171   MODEL_EXPORT virtual ModelAPI_ExecState execState();
 172
 173   /// Registers error during the execution, causes the ExecutionFailed state
 174   MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true);
 175
 176   /// Erases the error string if it is not empty
 177   void eraseErrorString();
 178
 179   /// Registers error during the execution, causes the ExecutionFailed state
 180   MODEL_EXPORT virtual std::string error() const;
 181
 182   /// Returns the identifier of feature-owner, unique in this document
 183   MODEL_EXPORT virtual int featureId() const;
 184
 185   /// returns all objects referenced to this
 186   MODEL_EXPORT virtual const std::set<AttributePtr>& refsToMe() {return myRefsToMe;}
 187
 188   /// returns all references by attributes of this data
 189   /// \param theRefs returned list of pairs: id of referenced attribute and list of referenced objects
 190   MODEL_EXPORT virtual void referencesToObjects(
 191     std::list<std::pair<std::string, std::list<ObjectPtr> > >& theRefs);
 192
 193   /// Copies all atributes content into theTarget data
 194   MODEL_EXPORT virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget);
 195
 196   /// Returns the invalid data pointer (to avoid working with NULL shared ptrs in swig)
 197   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Data> invalidPtr();
 198
 199   /// Returns the invalid data pointer: static method
 200   static std::shared_ptr<ModelAPI_Data> invalidData();
 201
 202   /// Identifier of the transaction when object (feature or result) was updated last time.
 203   MODEL_EXPORT virtual int updateID();
 204
 205   /// Identifier of the transaction when object (feature or result) was updated last time.
 206   /// This method is called by the updater.
 207   MODEL_EXPORT virtual void setUpdateID(const int theID);
 208
 209   /// Returns true if the given object is owner of this data (needed for correct erase of object
 210   /// with duplicated data)
 211   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> owner();
 212
 213 protected:
 214   /// Returns true if "is in history" custom behaviors is defined for the feature
 215   MODEL_EXPORT virtual bool isInHistory();
 216
 217   /// Defines the custom "is in history" behavior
 218   MODEL_EXPORT virtual void setIsInHistory(const bool theFlag);
 219
 220   /// Returns true if the object is deleted, but some data is still keept in memory
 221   MODEL_EXPORT virtual bool isDeleted();
 222
 223   /// Sets true if the object is deleted, but some data is still keept in memory
 224   MODEL_EXPORT virtual void setIsDeleted(const bool theFlag);
 225
 226 private:
 227   /// Removes all information about back references
 228   void eraseBackReferences();
 229   /// Removes a back reference (with identifier which attribute references to this object)
 230   /// \param theFeature feature referenced to this
 231   /// \param theAttrID identifier of the attribute that is references from theFeature to this
 232   void removeBackReference(FeaturePtr theFeature, std::string theAttrID);
 233   /// Removes a back reference (by the attribute)
 234   /// \param theAttr the referenced attribute
 235   void removeBackReference(AttributePtr theAttr);
 236   /// Adds a back reference (with identifier which attribute references to this object
 237   /// \param theFeature feature referenced to this
 238   /// \param theAttrID identifier of the attribute that is references from theFeature to this
 239   /// \param theApplyConcealment applies consealment flag changes
 240   void addBackReference(FeaturePtr theFeature, std::string theAttrID,
 241     const bool theApplyConcealment = true);
 242
 243   /// Makes the concealment flag up to date for this object-owner.
 244   MODEL_EXPORT virtual void updateConcealmentFlag();
 245
 246   /// Returns true if object must be displayed in the viewer: flag is stored in the
 247   /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
 248   /// the original state i nthe current transaction.
 249   MODEL_EXPORT virtual bool isDisplayed();
 250
 251   /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
 252   /// signal.
 253   MODEL_EXPORT virtual void setDisplayed(const bool theDisplay);
 254 };
 255
 256 /// Generic method to register back reference, used in referencing attributes.
 257 /// Without concealment change, it will be done later, on synchronization.
 258 #define ADD_BACK_REF(TARGET) \
 259   if (TARGET.get() != NULL) { \
 260     FeaturePtr anAttributeOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
 261     if (anAttributeOwnerFeature.get()) { \
 262       std::shared_ptr<Model_Data> aTargetData = std::dynamic_pointer_cast<Model_Data>( \
 263         (TARGET)->data()); \
 264       aTargetData->addBackReference(anAttributeOwnerFeature, id(), false); \
 265     } \
 266   }
 267
 268 /// Generic method to unregister back reference, used in referencing attributes.
 269 /// Without concealment change, it will be done later, on synchronization.
 270 #define REMOVE_BACK_REF(TARGET) \
 271   if (TARGET.get() != NULL) { \
 272     FeaturePtr anAttOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
 273     if (anAttOwnerFeature.get()) { \
 274       std::shared_ptr<Model_Data> aTargetData = std::dynamic_pointer_cast<Model_Data>( \
 275         (TARGET)->data()); \
 276       aTargetData->removeBackReference(anAttOwnerFeature, id()); \
 277     } \
 278   }
 279
 280 #endif