src/ModelAPI/ModelAPI_AttributeSelectionList.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 #ifndef ModelAPI_AttributeSelectionList_H_
  21 #define ModelAPI_AttributeSelectionList_H_
  22
  23 #include "ModelAPI_AttributeSelection.h"
  24 #include <ModelAPI_Result.h>
  25
  26 class GeomAPI_Shape;
  27
  28 /**\class ModelAPI_AttributeSelectionList
  29  * \ingroup DataModel
  30  * \brief Attribute that contains list of references to the sub-shapes with
  31  * possibility to manage them.
  32  */
  33
  34 class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
  35 {
  36  public:
  37   /// Adds the new reference to the end of the list
  38   /// \param theContext object where the sub-shape was selected
  39   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
  40   /// \param theTemporarily if it is true, do not store and name the added in the data framework
  41   ///           (used to remove immediately, without the following updates)
  42   virtual void append(const ResultPtr& theContext,
  43                       const std::shared_ptr<GeomAPI_Shape>& theSubShape,
  44                       const bool theTemporarily = false) = 0;
  45
  46   /// Adds the new reference to the end of the list by the naming name of the selected shape
  47   /// The type of shape is taken from the current selection type if the given is empty
  48   virtual void append(const std::string theNamingName, const std::string& theType = "") = 0;
  49
  50   /// Reset temporary stored values
  51   virtual void removeTemporaryValues() = 0;
  52
  53   /// Removes the last element in the list
  54   virtual void removeLast() = 0;
  55
  56   /// Removes the elements from the list.
  57   /// \param theIndices a list of indices of elements to be removed
  58   virtual void remove(const std::set<int>& theIndices) = 0;
  59
  60   /// Returns the number of selection attributes in the list
  61   virtual int size() = 0;
  62
  63   /// Returns true if the object with the shape are in list
  64   /// \param theContext object where the sub-shape was selected
  65   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
  66   /// \param theTemporarily if it is true, it checks also the temporary added item
  67   /// \returns true if the pair is found in the attirbute
  68   virtual bool isInList(
  69     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
  70     const bool theTemporarily = false) = 0;
  71
  72   /// The type of all elements selection
  73   /// \returns the index of the enumeration of the type of shape
  74   virtual const std::string selectionType() const = 0;
  75
  76   /// Sets the type of all elements selection
  77   /// \param theType the index of the enumeration of the type of shape
  78   virtual void setSelectionType(const std::string& theType) = 0;
  79
  80   /// Returns the attribute selection by the index (zero based)
  81   virtual std::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
  82
  83   /// Returns all attributes
  84   virtual void clear() = 0;
  85
  86   /// Starts or stops cashing of the values in the attribute (the cash may become invalid
  87   /// on modification of the attribute or sub-elements, so the cash must be enabled only
  88   /// during non-modification operations with this attribute)
  89   virtual void cashValues(const bool theEnabled) = 0;
  90
  91   /// Returns the type of this class of attributes
  92   static std::string typeId()
  93   {
  94     return "SelectionList";
  95   }
  96
  97   /// Returns the type of this class of attributes, not static method
  98   MODELAPI_EXPORT virtual std::string attributeType();
  99
 100   /// To virtually destroy the fields of successors
 101   MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList();
 102
 103  protected:
 104   /// Objects are created for features automatically
 105   MODELAPI_EXPORT ModelAPI_AttributeSelectionList();
 106 };
 107
 108 //! Pointer on double attribute
 109 typedef std::shared_ptr<ModelAPI_AttributeSelectionList> AttributeSelectionListPtr;
 110
 111 #endif