src/SketchSolver/PlaneGCSSolver/PlaneGCSSolver_EntityWrapper.h

   1 // Copyright (C) 2014-2023  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
  18 //
  19
  20 #ifndef PlaneGCSSolver_EntityWrapper_H_
  21 #define PlaneGCSSolver_EntityWrapper_H_
  22
  23 #include <PlaneGCSSolver_Defs.h>
  24
  25 #include <map>
  26 #include <memory>
  27
  28 class ModelAPI_Attribute;
  29
  30 class PlaneGCSSolver_EntityWrapper;
  31 typedef std::shared_ptr<PlaneGCSSolver_EntityWrapper> EntityWrapperPtr;
  32
  33 /**
  34  *  Wrapper providing operations with entities regardless the solver.
  35  */
  36 class PlaneGCSSolver_EntityWrapper
  37 {
  38 public:
  39   PlaneGCSSolver_EntityWrapper() : myExternal(false) {}
  40   virtual ~PlaneGCSSolver_EntityWrapper() {}
  41
  42   /// \brief Return type of current entity
  43   virtual SketchSolver_EntityType type() const = 0;
  44
  45   /// \brief Change flag indicating the entity cannot be changed in the solver
  46   void setExternal(bool theExternal) { myExternal = theExternal; }
  47   /// \brief Return the External flag
  48   bool isExternal() const { return myExternal; }
  49
  50   /// \brief Store names of attributes and their values if necessary
  51   void setAdditionalAttributes(const std::map<std::string, EntityWrapperPtr>& theAttribues)
  52   { myAdditionalAttributes = theAttribues; }
  53   /// \brief Return the list of additional attributes
  54   const std::map<std::string, EntityWrapperPtr>& additionalAttributes() const
  55   { return myAdditionalAttributes; }
  56
  57 protected:
  58   /// \brief Update entity by the values of theAttribute
  59   /// \return \c true if any value of attribute is not equal to the stored in the entity
  60   virtual bool update(std::shared_ptr<ModelAPI_Attribute> theAttribute)
  61   { return false; }
  62
  63   friend class PlaneGCSSolver_AttributeBuilder;
  64
  65 private:
  66   bool myExternal;
  67   std::map<std::string, EntityWrapperPtr> myAdditionalAttributes;
  68 };
  69
  70 #endif