Spell-checking

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

diff --git a/src/ModelAPI/ModelAPI_AttributeSelectionList.h b/src/ModelAPI/ModelAPI_AttributeSelectionList.h
index aef9046aef1966e13a198fcfc859f248c08d0df2..c94062ba3e29ac664e929ac51a97355a25d40b52 100644 (file)
--- a/src/ModelAPI/ModelAPI_AttributeSelectionList.h
+++ b/src/ModelAPI/ModelAPI_AttributeSelectionList.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_AttributeSelectionList.h
 // Created:     22 Oct 2014
 // Author:      Mikhail PONIKAROV
@@ -18,47 +20,56 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
 {
  public:
   /// Adds the new reference to the end of the list
-  virtual void append(
-    const ResultPtr& theContext, const boost::shared_ptr<GeomAPI_Shape>& theSubShape) = 0;
+  /// \param theContext object where the sub-shape was selected
+  /// \param theSubShape selected sub-shape (if null, the whole context is selected)
+  /// \param theTemporarily if it is true, do not store and name the added in the data framework
+  ///           (used to remove immediately, without the following updates)
+  virtual void append(const ResultPtr& theContext,
+                      const GeomShapePtr& theSubShape,
+                      const bool theTemporarily = false) = 0;
+
+  /// 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
+  virtual void append(std::string theNamingName) = 0;
+
+  /// Removes the last element in the list
+  virtual void removeLast() = 0;
 
-  /// Returns the number ofselection attributes in the list
+  /// Returns the number of selection attributes in the list
   virtual int size() = 0;
 
-  virtual int selectionType() = 0;
+  /// The type of all elements selection
+  /// \returns the index of the enumeration of the type of shape
+  virtual const std::string selectionType() const = 0;
 
-  virtual void setSelectionType(int) = 0;
+  /// Sets the type of all elements selection
+  /// \param theType the index of the enumeration of the type of shape
+  virtual void setSelectionType(const std::string& theType) = 0;
 
   /// Returns the attribute selection by the index (zero based)
-  virtual boost::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
+  virtual std::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
 
   /// Returns all attributes
   virtual void clear() = 0;
 
   /// Returns the type of this class of attributes
-  static std::string type()
+  static std::string typeId()
   {
     return "SelectionList";
   }
 
   /// Returns the type of this class of attributes, not static method
-  virtual std::string attributeType()
-  {
-    return type();
-  }
+  MODELAPI_EXPORT virtual std::string attributeType();
 
   /// To virtually destroy the fields of successors
-  virtual ~ModelAPI_AttributeSelectionList()
-  {
-  }
+  MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList();
 
  protected:
   /// Objects are created for features automatically
-  MODELAPI_EXPORT ModelAPI_AttributeSelectionList()
-  {
-  }
+  MODELAPI_EXPORT ModelAPI_AttributeSelectionList();
 };
 
 //! Pointer on double attribute
-typedef boost::shared_ptr<ModelAPI_AttributeSelectionList> AttributeSelectionListPtr;
+typedef std::shared_ptr<ModelAPI_AttributeSelectionList> AttributeSelectionListPtr;
 
 #endif