src/ModelAPI/ModelAPI_AttributeSelection.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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef ModelAPI_AttributeSelection_H_
  22 #define ModelAPI_AttributeSelection_H_
  23
  24 #include "ModelAPI_Attribute.h"
  25 #include <ModelAPI_Result.h>
  26
  27 /**\class ModelAPI_AttributeSelection
  28  * \ingroup DataModel
  29  * \brief Attribute that contains reference to the sub-shape of some result, the selected shape.
  30  */
  31
  32 class ModelAPI_AttributeSelection : public ModelAPI_Attribute
  33 {
  34  public:
  35   /// Defines the result and its selected sub-shape
  36   /// \param theContext object where the sub-shape was selected
  37   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
  38   /// \param theTemporarily if it is true, do not store and name the added in the data framework
  39   ///           (used to remove immideately, without the following updates)
  40   virtual void setValue(
  41     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
  42     const bool theTemporarily = false) = 0;
  43
  44   /// Reset temporary stored values
  45   virtual void removeTemporaryValues() = 0;
  46
  47   /// Returns the selected subshape
  48   virtual std::shared_ptr<GeomAPI_Shape> value() = 0;
  49
  50   /// Returns the context of the selection (the whole shape owner)
  51   virtual ResultPtr context() = 0;
  52
  53   /// Updates the underlied selection due to the changes in the referenced objects
  54   /// \returns false if update is failed
  55   virtual bool update() = 0;
  56
  57   /// Returns the type of this class of attributes
  58   static std::string typeId()
  59   {
  60     return "Selection";
  61   }
  62
  63   /// Returns the type of this class of attributes, not static method
  64   MODELAPI_EXPORT virtual std::string attributeType();
  65
  66   /// Returns a textual string of the selection
  67   /// \param theDefaultValue a value, which is used if the naming name can not be obtained
  68   virtual std::string namingName(const std::string& theDefaultValue = "") = 0;
  69
  70   /// Returns an id of the selection
  71   virtual int Id() = 0;
  72
  73   /// Defines an id of the selection
  74   virtual void setId(int theID) = 0;
  75
  76   /// Selects sub-shape by the textual Name
  77   virtual void selectSubShape(const std::string& theType, const std::string& theSubShapeName) = 0;
  78
  79   /// Returns true if recompute of selection become impossible
  80   virtual bool isInvalid() = 0;
  81
  82   /// To virtually destroy the fields of successors
  83   MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelection();
  84
  85  protected:
  86   /// Objects are created for features automatically
  87   MODELAPI_EXPORT ModelAPI_AttributeSelection();
  88 };
  89
  90 //! Pointer on double attribute
  91 typedef std::shared_ptr<ModelAPI_AttributeSelection> AttributeSelectionPtr;
  92
  93 #endif