Salome HOME
Update of the unit-test for checking the issue #2892
[modules/shaper.git] / src / ModelAPI / ModelAPI_Data.h
index e1848123e782d42e57cbd8095417128b887fd79a..8ce3e9133a6cbb030bdbaac592096e8cdfe201ee 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2019  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
 //
 // 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<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef ModelAPI_Data_H_
@@ -74,9 +73,10 @@ class MODELAPI_EXPORT ModelAPI_Data
 
   /// Returns the name of the feature visible by the user in the object browser
   virtual std::string name() = 0;
-
   /// Defines the name of the feature visible by the user in the object browser
   virtual void setName(const std::string& theName) = 0;
+  /// Return \c true if the object has been renamed by the user
+  virtual bool hasUserDefinedName() const = 0;
 
   /// Returns the attribute that references to another document
   virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID) = 0;
@@ -180,7 +180,7 @@ class MODELAPI_EXPORT ModelAPI_Data
   /// Copies all attributes content into theTarget data
   virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget) = 0;
 
-  /// 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)
   virtual std::shared_ptr<ModelAPI_Data> invalidPtr() = 0;
 
   /// Identifier of the transaction when object (feature or result) was updated last time.
@@ -190,13 +190,13 @@ class MODELAPI_EXPORT ModelAPI_Data
   /// This method is called by the updater.
   virtual void setUpdateID(const int theID) = 0;
 
-  /// Returns the owner of htis data
+  /// Returns the owner of this data
   virtual std::shared_ptr<ModelAPI_Object> owner() = 0;
 
-  /// 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
   virtual bool isDeleted() = 0;
 
-  /// 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
   virtual void setIsDeleted(const bool theFlag) = 0;
 
   /// Returns \c true if theAttribute1 is going earlier than theAttribute2 in the data
@@ -215,7 +215,7 @@ class MODELAPI_EXPORT ModelAPI_Data
 
   /// 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 ithe current transaction.
   virtual bool isDisplayed() = 0;
 
   /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"