X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FModel%2FModel_Data.h;h=8d12bc4d32a53f8ec81dec7a9b5d98aaec7262f2;hb=c8fd356b4c1e7fb116023cfc9bc4ac87915607b0;hp=f23e684ca782ebc904478691fb9b383ab4eb1b95;hpb=a91a2bfe4817a8bc8a1dc0b14463dab38595e60c;p=modules%2Fshaper.git diff --git a/src/Model/Model_Data.h b/src/Model/Model_Data.h index f23e684ca..8d12bc4d3 100644 --- a/src/Model/Model_Data.h +++ b/src/Model/Model_Data.h @@ -1,6 +1,22 @@ -// File: Model_Data.hxx -// Created: 21 Mar 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or +// email : webmaster.salome@opencascade.com +// #ifndef Model_Data_H_ #define Model_Data_H_ @@ -14,14 +30,19 @@ #include #include #include +#include #include +#include +#include #include #include +#include #include #include +#include -#include +#include #include #include @@ -38,17 +59,24 @@ class ModelAPI_Attribute; class Model_Data : public ModelAPI_Data { + typedef std::map, int> > AttributeMap; + TDF_Label myLab; ///< label of the feature in the document /// All attributes of the object identified by the attribute ID - std::map > myAttrs; + /// (the attribute is stored together with its index in the feature) + AttributeMap myAttrs; + /// Array of flags of this data + Handle(TDataStd_BooleanArray) myFlags; /// needed here to emit signal that object changed on change of the attribute ObjectPtr myObject; /// List of attributes referenced to owner (updated only during the transaction change) std::set myRefsToMe; - - Model_Data(); + /// flag that may block the "attribute updated" sending + bool mySendAttributeUpdated; + /// if some attribute was changed, but mySendAttributeUpdated was false, this stores this + std::list myWasChangedButBlocked; /// Returns label of this feature TDF_Label label() @@ -57,51 +85,78 @@ class Model_Data : public ModelAPI_Data } friend class Model_Document; + friend class Model_Objects; friend class Model_Update; friend class Model_AttributeReference; friend class Model_AttributeRefAttr; friend class Model_AttributeRefList; + friend class Model_AttributeRefAttrList; friend class Model_AttributeSelection; + friend class Model_AttributeSelectionList; + friend class Model_ValidatorsFactory; + friend class Model_SelectionNaming; + friend class Model_ResultConstruction; public: + /// The simplest constructor. "setLabel" must be called just after to initialize correctly. + Model_Data(); /// Returns the name of the feature visible by the user in the object browser MODEL_EXPORT virtual std::string name(); /// Defines the name of the feature visible by the user in the object browser MODEL_EXPORT virtual void setName(const std::string& theName); + /// Return \c true if the object has been renamed by the user + MODEL_EXPORT virtual bool hasUserDefinedName() const; /// Returns the attribute that references to another document - MODEL_EXPORT virtual boost::shared_ptr document(const std::string& theID); + MODEL_EXPORT virtual std::shared_ptr document(const std::string& theID); /// Returns the attribute that contains real value with double precision - MODEL_EXPORT virtual boost::shared_ptr real(const std::string& theID); + MODEL_EXPORT virtual std::shared_ptr real(const std::string& theID); + /// Returns the attribute that contains double values array + MODEL_EXPORT virtual + std::shared_ptr realArray(const std::string& theID); /// Returns the attribute that contains integer value - MODEL_EXPORT virtual boost::shared_ptr + MODEL_EXPORT virtual std::shared_ptr integer(const std::string& theID); /// Returns the attribute that contains reference to a feature - MODEL_EXPORT virtual boost::shared_ptr + MODEL_EXPORT virtual std::shared_ptr reference(const std::string& theID); /// Returns the attribute that contains selection to a shape - MODEL_EXPORT virtual boost::shared_ptr + MODEL_EXPORT virtual std::shared_ptr selection(const std::string& theID); /// Returns the attribute that contains selection to a shape - MODEL_EXPORT virtual boost::shared_ptr + MODEL_EXPORT virtual std::shared_ptr selectionList(const std::string& theID); /// Returns the attribute that contains reference to an attribute of a feature - MODEL_EXPORT virtual boost::shared_ptr + MODEL_EXPORT virtual std::shared_ptr refattr(const std::string& theID); /// Returns the attribute that contains list of references to features - MODEL_EXPORT virtual boost::shared_ptr + MODEL_EXPORT virtual std::shared_ptr reflist(const std::string& theID); + /// Returns the attribute that contains list of references to features + /// or reference to an attribute of a feature + MODEL_EXPORT virtual std::shared_ptr + refattrlist(const std::string& theID); /// Returns the attribute that contains boolean value - MODEL_EXPORT virtual boost::shared_ptr + MODEL_EXPORT virtual std::shared_ptr boolean(const std::string& theID); /// Returns the attribute that contains real value with double precision - MODEL_EXPORT virtual boost::shared_ptr + MODEL_EXPORT virtual std::shared_ptr string(const std::string& theID); + /// Returns the attribute that contains integer values array + MODEL_EXPORT virtual std::shared_ptr + intArray(const std::string& theID); + /// Returns the attribute that contains string values array + MODEL_EXPORT virtual std::shared_ptr + stringArray(const std::string& theID); + /// Returns the attribute that contains string values array + MODEL_EXPORT virtual std::shared_ptr + tables(const std::string& theID); + /// Returns the generic attribute by identifier /// \param theID identifier of the attribute - MODEL_EXPORT virtual boost::shared_ptr attribute(const std::string& theID); + MODEL_EXPORT virtual std::shared_ptr attribute(const std::string& theID); /// Returns all attributes of the feature of the given type /// or all attributes if "theType" is empty - MODEL_EXPORT virtual std::list > + MODEL_EXPORT virtual std::list > attributes(const std::string& theType); /// Returns all attributes ids of the feature of the given type /// or all attributes if "theType" is empty @@ -109,9 +164,9 @@ class Model_Data : public ModelAPI_Data /// Identifier by the id (not fast, iteration by map) /// \param theAttr attribute already created in this data - MODEL_EXPORT virtual const std::string& id(const boost::shared_ptr& theAttr); + MODEL_EXPORT virtual const std::string& id(const std::shared_ptr& theAttr); /// Returns true if data belongs to same features - MODEL_EXPORT virtual bool isEqual(const boost::shared_ptr& theData); + MODEL_EXPORT virtual bool isEqual(const std::shared_ptr& theData); /// Returns true if it is correctly connected t othe data model MODEL_EXPORT virtual bool isValid(); @@ -125,11 +180,21 @@ class Model_Data : public ModelAPI_Data /// for each attribute of the object /// \param theID identifier of the attribute that can be referenced by this ID later /// \param theAttrType type of the created attribute (received from the type method) - MODEL_EXPORT virtual void addAttribute(const std::string& theID, const std::string theAttrType); + /// \returns the just created attribute + MODEL_EXPORT virtual AttributePtr + addAttribute(const std::string& theID, const std::string theAttrType); /// Useful method for "set" methods of the attributes: sends an UPDATE event and /// makes attribute initialized MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr); + /// Blocks sending "attribute updated" if theBlock is true + /// \param theBlock allows switching on/off the blocking state + /// \param theSendMessage if false, it does not send the update message + /// even if something is changed + /// (normally is it used in attributeChanged because this message will be sent anyway) + /// \returns the previous state of block + MODEL_EXPORT virtual bool blockSendAttributeUpdated( + const bool theBlock, const bool theSendMessage = true); /// Puts feature to the document data sub-structure MODEL_EXPORT void setLabel(TDF_Label theLab); @@ -140,29 +205,137 @@ class Model_Data : public ModelAPI_Data myObject = theObject; } + /// Erases all the data from the data model MODEL_EXPORT virtual void erase(); - /// Makes feature must be updated later (on rebuild). Normally the Updater must call it - /// in case of not-automatic update to true - MODEL_EXPORT virtual void mustBeUpdated(const bool theFlag); + /// Stores the state of the object to execute it later accordingly + MODEL_EXPORT virtual void execState(const ModelAPI_ExecState theState); + + /// Returns the state of the latest execution of the feature + MODEL_EXPORT virtual ModelAPI_ExecState execState(); - /// Returns true if feature must be updated (re-executed) on rebuild - MODEL_EXPORT virtual bool mustBeUpdated(); + /// Registers error during the execution, causes the ExecutionFailed state + MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true); + + /// Erases the error string if it is not empty + void eraseErrorString(); + + /// Registers error during the execution, causes the ExecutionFailed state + MODEL_EXPORT virtual std::string error() const; /// Returns the identifier of feature-owner, unique in this document MODEL_EXPORT virtual int featureId() const; - // returns all objects referenced to this + /// returns all objects referenced to this MODEL_EXPORT virtual const std::set& refsToMe() {return myRefsToMe;} + /// returns all references by attributes of this data + /// \param theRefs returned list of pairs: + /// id of referenced attribute and list of referenced objects + MODEL_EXPORT virtual void referencesToObjects( + std::list > >& theRefs); + + /// Copies all atributes content into theTarget data + MODEL_EXPORT virtual void copyTo(std::shared_ptr theTarget); + + /// Returns the invalid data pointer (to avoid working with NULL shared ptrs in swig) + MODEL_EXPORT virtual std::shared_ptr invalidPtr(); + + /// Returns the invalid data pointer: static method + static std::shared_ptr invalidData(); + + /// Identifier of the transaction when object (feature or result) was updated last time. + MODEL_EXPORT virtual int updateID(); + + /// Identifier of the transaction when object (feature or result) was updated last time. + /// This method is called by the updater. + MODEL_EXPORT virtual void setUpdateID(const int theID); + + /// Returns true if the given object is owner of this data (needed for correct erase of object + /// with duplicated data) + MODEL_EXPORT virtual std::shared_ptr owner(); + +protected: + /// Returns true if "is in history" custom behaviors is defined for the feature + MODEL_EXPORT virtual bool isInHistory(); + + /// Defines the custom "is in history" behavior + MODEL_EXPORT virtual void setIsInHistory(const bool theFlag); + + /// Returns true if the object is deleted, but some data is still keept in memory + MODEL_EXPORT virtual bool isDeleted(); + + /// Sets true if the object is deleted, but some data is still keept in memory + MODEL_EXPORT virtual void setIsDeleted(const bool theFlag); + private: - // removes all information about back references + /// Removes all information about back references void eraseBackReferences(); - // adds a back reference (with identifier which attribute references to this object - void addBackReference(FeaturePtr theFeature, std::string theAttrID); - // returns all references by attributes of this data - // \param the returned list of pairs: id of referenced attribute and list of referenced objects - void referencesToObjects(std::list > >& theRefs); + /// Removes a back reference (with identifier which attribute references to this object) + /// \param theFeature feature referenced to this + /// \param theAttrID identifier of the attribute that is references from theFeature to this + void removeBackReference(ObjectPtr theObject, std::string theAttrID); + /// Removes a back reference (by the attribute) + /// \param theAttr the referenced attribute + void removeBackReference(AttributePtr theAttr); + /// Adds a back reference (with identifier which attribute references to this object + /// \param theFeature feature referenced to this + /// \param theAttrID identifier of the attribute that is references from theFeature to this + /// \param theApplyConcealment applies consealment flag changes + void addBackReference(FeaturePtr theFeature, std::string theAttrID, + const bool theApplyConcealment = true); + /// Adds a back reference to an object + /// \param theObject object referenced to this + /// \param theAttrID identifier of the attribute that is references from theFolder to this + void addBackReference(ObjectPtr theObject, std::string theAttrID); + + /// Makes the concealment flag up to date for this object-owner. + MODEL_EXPORT virtual void updateConcealmentFlag(); + + /// Returns true if object must be displayed in the viewer: flag is stored in the + /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps + /// the original state i nthe current transaction. + MODEL_EXPORT virtual bool isDisplayed(); + + /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay" + /// signal. + MODEL_EXPORT virtual void setDisplayed(const bool theDisplay); + + /// Returns \c true if theAttribute1 is going earlier than theAttribute2 in the data + MODEL_EXPORT virtual bool isPrecedingAttribute(const std::string& theAttribute1, + const std::string& theAttribute2) const; }; +/// Generic method to register back reference, used in referencing attributes. +/// Without concealment change, it will be done later, on synchronization. +#define ADD_BACK_REF(TARGET) \ + if (TARGET.get() != NULL) { \ + std::shared_ptr aTargetData = \ + std::dynamic_pointer_cast((TARGET)->data()); \ + FeaturePtr anAttributeOwnerFeature = std::dynamic_pointer_cast(owner()); \ + if (anAttributeOwnerFeature.get()) \ + aTargetData->addBackReference(anAttributeOwnerFeature, id(), false); \ + else { \ + FolderPtr anAttributeOwnerFolder = std::dynamic_pointer_cast(owner()); \ + if (anAttributeOwnerFolder.get()) \ + aTargetData->addBackReference(ObjectPtr(anAttributeOwnerFolder), id()); \ + } \ + } + +/// Generic method to unregister back reference, used in referencing attributes. +/// Without concealment change, it will be done later, on synchronization. +#define REMOVE_BACK_REF(TARGET) \ + if (TARGET.get() != NULL) { \ + std::shared_ptr aTargetData = \ + std::dynamic_pointer_cast((TARGET)->data()); \ + FeaturePtr anAttOwnerFeature = std::dynamic_pointer_cast(owner()); \ + if (anAttOwnerFeature.get()) \ + aTargetData->removeBackReference(anAttOwnerFeature, id()); \ + else { \ + FolderPtr anAttributeOwnerFolder = std::dynamic_pointer_cast(owner()); \ + if (anAttributeOwnerFolder.get()) \ + aTargetData->removeBackReference(ObjectPtr(anAttributeOwnerFolder), id()); \ + } \ + } + #endif