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