updated copyright message

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

diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h
index e30978a69b3afe8cb8bacffdb30fbea6af3e6384..c5705de11e5bb9493fdc10c638e378c07cbc472b 100644 (file)
--- a/src/ModelAPI/ModelAPI_Feature.h
+++ b/src/ModelAPI/ModelAPI_Feature.h
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        ModelAPI_Feature.hxx
-// Created:     21 Mar 2014
-// Author:      Mikhail PONIKAROV
+// 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
+// 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 ModelAPI_Feature_H_
 #define ModelAPI_Feature_H_
@@ -60,7 +73,7 @@ class ModelAPI_Feature : public ModelAPI_Object
   /// Computes the attribute value on the base of other attributes if the value can be computed
   /// \param theAttributeId an attribute index to be computed
   /// \return a boolean value about it is computed
-  virtual bool compute(const std::string& theAttributeId) { return false; };
+  virtual bool compute(const std::string& /*theAttributeId*/) { return false; };
 
   /// Registers error during the execution, causes the ExecutionFailed state
   MODELAPI_EXPORT virtual void setError(const std::string& theError,
@@ -83,8 +96,6 @@ class ModelAPI_Feature : public ModelAPI_Object
   /// sets the result by index (zero based), results before this must be set before
   MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
                                  const int theIndex);
-  /// removes the result from the feature
-  MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
   /// removes all results starting from the given index (zero-based)
   /// \param theSinceIndex - index of the deleted result and all after also will be deleted
   /// \param theForever - removes results for long period (not just because of feature disabling)
@@ -153,7 +164,7 @@ class ModelAPI_Feature : public ModelAPI_Object
  // Helper methods, aliases for data()->method()
  // -----------------------------------------------------------------------------------------------
   /// Returns the name stored in the attribute
-  inline std::string name()
+  inline std::wstring name()
   {
     return data()->name();
   }
@@ -187,6 +198,11 @@ class ModelAPI_Feature : public ModelAPI_Object
   {
     return data()->refattr(theID);
   }
+  /// Returns the refattrlist attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeRefAttrList> refattrlist(const std::string& theID)
+  {
+    return data()->refattrlist(theID);
+  }
   /// Returns the reference attribute by the identifier
   inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
   {
@@ -239,5 +255,19 @@ class ModelAPI_Feature : public ModelAPI_Object
 //! Pointer on feature object
 typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;
 
-#endif
+//! An interface for performing special copy actions. To give feature which is moved (a group)
+//! over this feature.
+class ModelAPI_FeatureCopyInterface {
+public:
+  virtual ~ModelAPI_FeatureCopyInterface() {}
+
+  /// An algorithm to update the moved feature by the separate Copy feature
+  /// \param theContext the original context object
+  /// \param theValue the original shape
+  /// \param theCopies resulting copy-context will be appended here
+  virtual void getCopies(ObjectPtr theContext, std::shared_ptr<GeomAPI_Shape> theValue,
+                         std::list<ObjectPtr>& theCopyContext,
+                         std::list<std::shared_ptr<GeomAPI_Shape> >& theCopyVals) = 0;
+};
 
+#endif