src/SketchSolver/PlaneGCSSolver/PlaneGCSSolver_PointWrapper.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_PointWrapper_H_
  21 #define PlaneGCSSolver_PointWrapper_H_
  22
  23 #include <PlaneGCSSolver_Defs.h>
  24 #include <PlaneGCSSolver_EntityWrapper.h>
  25
  26 /**
  27  *  Wrapper providing operations with PlaneGCS points.
  28  */
  29 class PlaneGCSSolver_PointWrapper : public PlaneGCSSolver_EntityWrapper
  30 {
  31 public:
  32   PlaneGCSSolver_PointWrapper(const GCSPointPtr thePoint);
  33
  34   /// \brief Return PlaneGCS point
  35   const GCSPointPtr& point() const
  36   { return myPoint; }
  37   /// \brief Return PlaneGCS point to change
  38   GCSPointPtr& changeEntity()
  39   { return myPoint; }
  40
  41   /// \brief Return type of current entity
  42   virtual SketchSolver_EntityType type() const
  43   { return ENTITY_POINT; }
  44
  45 protected:
  46   /// \brief Update entity by the values of theAttribute
  47   /// \return \c true if any value of attribute is not equal to the stored in the entity
  48   virtual bool update(std::shared_ptr<ModelAPI_Attribute> theAttribute);
  49
  50 private:
  51   GCSPointPtr myPoint;
  52 };
  53
  54 typedef std::shared_ptr<PlaneGCSSolver_PointWrapper> PointWrapperPtr;
  55
  56 #endif