updated copyright message

[modules/shaper.git] / src / ModelAPI / ModelAPI_AttributeSelectionList.h

diff --git a/src/ModelAPI/ModelAPI_AttributeSelectionList.h b/src/ModelAPI/ModelAPI_AttributeSelectionList.h
index 7bdd59a6bef1723ed77e78b7bbbc7deb7268826a..80ee75f4614ef7af02956357e76885b6aaa0ade9 100644 (file)
--- a/src/ModelAPI/ModelAPI_AttributeSelectionList.h
+++ b/src/ModelAPI/ModelAPI_AttributeSelectionList.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  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<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef ModelAPI_AttributeSelectionList_H_
@@ -23,6 +22,7 @@
 
 #include "ModelAPI_AttributeSelection.h"
 #include <ModelAPI_Result.h>
+#include <ModelAPI_Filter.h>
 
 class GeomAPI_Pnt;
 class GeomAPI_Shape;
@@ -35,7 +35,14 @@ class GeomAPI_Shape;
 
 class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
 {
- public:
+  /// Flag that indicates that the whole result selection is allowed while the selection type
+  /// may be sub-objects, so, it is the same as all sub-shapes are selected (#3005). It is "false"
+  /// by default.
+  bool myIsWholeResultAllowed;
+  /// Flag that indicates that update in history must check the copy-features
+  /// and make a copy of selection for them.
+  bool myMakeCopy;
+public:
   /// Adds the new reference to the end of the list
   /// \param theContext object where the sub-shape was selected
   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
@@ -47,16 +54,19 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
 
   /// Adds the new reference to the end of the list by the naming name of the selected shape
   /// The type of shape is taken from the current selection type if the given is empty
-  virtual void append(const std::string& theNamingName, const std::string& theType = "") = 0;
+  virtual void append(const std::wstring& theNamingName, const std::string& theType = "") = 0;
 
   /// Adds the new reference to the end of the list by inner point on the selected shape
   virtual void append(const std::shared_ptr<GeomAPI_Pnt>& thePoint,
                       const std::string& theType) = 0;
 
   /// Adds the new reference to the end of the list by weak naming index
-  virtual void append(const std::string& theType, const std::string& theContextName,
+  virtual void append(const std::string& theType, const std::wstring& theContextName,
                       const int theIndex) = 0;
 
+  /// Copy the selection list to the destination attribute
+  virtual void copyTo(std::shared_ptr<ModelAPI_AttributeSelectionList> theTarget) const = 0;
+
   /// Reset temporary stored values
   virtual void removeTemporaryValues() = 0;
 
@@ -115,9 +125,37 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
   /// To virtually destroy the fields of successors
   MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList();
 
- protected:
-  /// Objects are created for features automatically
-  MODELAPI_EXPORT ModelAPI_AttributeSelectionList();
+  /// Returns a selection filters feature if it is defined for this selection list
+  MODELAPI_EXPORT virtual FiltersFeaturePtr filters() const = 0;
+
+  /// Sets a selection filters feature if it is defined for this selection list
+  MODELAPI_EXPORT virtual void setFilters(FiltersFeaturePtr theFeature) = 0;
+
+  /// Returns true if the whole result selection corresponds to selection of all sub-shapes.
+  MODELAPI_EXPORT virtual const bool isWholeResultAllowed() const {
+    return myIsWholeResultAllowed;
+  }
+
+  /// Sets whether the whole result selection corresponds to selection of all sub-shapes.
+  MODELAPI_EXPORT virtual void setWholeResultAllowed(const bool theFlag)  {
+    myIsWholeResultAllowed = theFlag;
+  }
+
+  /// Returns true if a copy features must be used in update in history.
+  MODELAPI_EXPORT virtual const bool isMakeCopy() const {
+    return myMakeCopy;
+  }
+
+  /// Sets true if a copy features must be used in update in history.
+  MODELAPI_EXPORT virtual void setMakeCopy(const bool theFlag)  {
+    myMakeCopy = theFlag;
+  }
+
+protected:
+  /// Default constructor
+  MODELAPI_EXPORT ModelAPI_AttributeSelectionList() : ModelAPI_Attribute()
+  {myIsWholeResultAllowed = false; myMakeCopy = false;}
+
 };
 
 //! Pointer on double attribute