X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FModel%2FModel_Data.h;h=82703d70c0a54357bbf37cdcb4d114df1e5f83fc;hb=77ce6d35ac8d2f0fdaecb4f23e0870bf74e36103;hp=2ed26625f42b0da7b4a12cd01cbaeea42d30e7f5;hpb=d4b0a5cb916f4eccf4a0bce02e43a54c7a67cb93;p=modules%2Fshaper.git diff --git a/src/Model/Model_Data.h b/src/Model/Model_Data.h index 2ed26625f..82703d70c 100644 --- a/src/Model/Model_Data.h +++ b/src/Model/Model_Data.h @@ -1,4 +1,4 @@ -// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// Copyright (C) 2014-2024 CEA, EDF // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public @@ -12,10 +12,9 @@ // // 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 +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // -// See http://www.salome-platform.org/ or -// email : webmaster.salome@opencascade.com +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // #ifndef Model_Data_H_ @@ -34,6 +33,7 @@ #include #include #include +#include #include #include #include @@ -97,16 +97,21 @@ class Model_Data : public ModelAPI_Data friend class Model_SelectionNaming; friend class Model_ResultConstruction; friend class Model_ResultBody; + friend class Model_Tools; 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(); + MODEL_EXPORT virtual std::wstring name(); /// Defines the name of the feature visible by the user in the object browser - MODEL_EXPORT virtual void setName(const std::string& theName); + MODEL_EXPORT virtual void setName(const std::wstring& theName); /// Return \c true if the object has been renamed by the user MODEL_EXPORT virtual bool hasUserDefinedName() const; + /// Returns version of the feature (empty string if not applicable) + MODEL_EXPORT virtual std::string version(); + /// Initialize the version of the feature + MODEL_EXPORT virtual void setVersion(const std::string& theVersion); /// Returns the attribute that references to another document MODEL_EXPORT virtual std::shared_ptr document(const std::string& theID); /// Returns the attribute that contains real value with double precision @@ -151,6 +156,9 @@ class Model_Data : public ModelAPI_Data /// Returns the attribute that contains string values array MODEL_EXPORT virtual std::shared_ptr tables(const std::string& theID); + /// Returns the attribute that contains image + MODEL_EXPORT virtual std::shared_ptr + image(const std::string& theID); /// Returns the generic attribute by identifier /// \param theID identifier of the attribute @@ -168,7 +176,7 @@ class Model_Data : public ModelAPI_Data 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 std::shared_ptr& theData); - /// Returns true if it is correctly connected t othe data model + /// Returns true if it is correctly connected to the data model MODEL_EXPORT virtual bool isValid(); /// Returns the label where the shape must be stored (used in ResultBody) @@ -181,9 +189,29 @@ 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) + /// \param theIndex index of the attribute in the internal data structure, for not-floating + /// attributes it is -1 to let it automatically be added /// \returns the just created attribute MODEL_EXPORT virtual AttributePtr - addAttribute(const std::string& theID, const std::string theAttrType); + addAttribute(const std::string& theID, const std::string theAttrType, const int theIndex = -1); + + /// Adds a floating attribute (that may be added/removed during the data life) + /// \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) + /// \param theGroup identifier of the group this attribute belongs to, may be an empty string + MODEL_EXPORT virtual AttributePtr + addFloatingAttribute(const std::string& theID, const std::string theAttrType, + const std::string& theGroup); + + /// Returns all groups of this data (ordered). + MODEL_EXPORT virtual void allGroups(std::list& theGroups); + + /// Returns an ordered list of attributes that belong to the given group + MODEL_EXPORT virtual void attributesOfGroup(const std::string& theGroup, + std::list >& theAttrs); + + /// Remove all attributes of the given group + MODEL_EXPORT virtual void removeAttributes(const std::string& theGroup); /// Useful method for "set" methods of the attributes: sends an UPDATE event and /// makes attribute initialized @@ -236,10 +264,10 @@ class Model_Data : public ModelAPI_Data MODEL_EXPORT virtual void referencesToObjects( std::list > >& theRefs); - /// Copies all atributes content into theTarget data + /// Copies all attributes 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) + /// Returns the invalid data pointer (to avoid working with NULL shared pointers in swig) MODEL_EXPORT virtual std::shared_ptr invalidPtr(); /// Returns the invalid data pointer: static method @@ -263,15 +291,16 @@ protected: /// 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 + /// Returns true if the object is deleted, but some data is still kept in memory MODEL_EXPORT virtual bool isDeleted(); - /// Sets true if the object is deleted, but some data is still keept in memory + /// Sets true if the object is deleted, but some data is still kept in memory MODEL_EXPORT virtual void setIsDeleted(const bool theFlag); + /// Erases all attributes from myAttrs, but keeping them in the data structure + void clearAttributes(); + private: - /// Removes all information about back references - void eraseBackReferences(); /// 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 @@ -282,7 +311,7 @@ private: /// 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 + /// \param theApplyConcealment applies concealment flag changes void addBackReference(FeaturePtr theFeature, std::string theAttrID, const bool theApplyConcealment = true); /// Adds a back reference to an object @@ -295,7 +324,7 @@ private: /// 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. + /// the original state in the current transaction. MODEL_EXPORT virtual bool isDisplayed(); /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay" @@ -305,6 +334,7 @@ private: /// 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.