src/SketchSolver/PlaneGCSSolver/PlaneGCSSolver_ConstraintWrapper.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 PlaneGCSSolver_ConstraintWrapper_H_
  22 #define PlaneGCSSolver_ConstraintWrapper_H_
  23
  24 #include <PlaneGCSSolver_Defs.h>
  25 #include <PlaneGCSSolver_ScalarWrapper.h>
  26
  27 /**
  28  *  Wrapper providing operations with PlaneGCS constraints.
  29  */
  30 class PlaneGCSSolver_ConstraintWrapper
  31 {
  32 public:
  33   PlaneGCSSolver_ConstraintWrapper(const GCSConstraintPtr&            theConstraint,
  34                                    const SketchSolver_ConstraintType& theType);
  35   PlaneGCSSolver_ConstraintWrapper(const std::list<GCSConstraintPtr>& theConstraints,
  36                                    const SketchSolver_ConstraintType& theType);
  37
  38   /// \brief Return list of constraints
  39   const std::list<GCSConstraintPtr>& constraints() const
  40   { return myGCSConstraints; }
  41   /// \brief Change list of constraints
  42   void setConstraints(const std::list<GCSConstraintPtr>& theConstraints)
  43   { myGCSConstraints = theConstraints; }
  44
  45   /// \brief Return ID of current constraint
  46   const ConstraintID& id() const
  47   { return myID; }
  48   /// \brief Change constraint ID
  49   virtual void setId(const ConstraintID& theID);
  50
  51   /// \brief Return type of current entity
  52   virtual SketchSolver_ConstraintType type() const
  53   { return myType; }
  54
  55   /// \brief Assign numeric parameter of constraint
  56   virtual void setValue(const double& theValue);
  57   /// \brief Return numeric parameter of constraint
  58   virtual double value() const;
  59
  60   /// \brief Change parameter representing the value of constraint
  61   void setValueParameter(const ScalarWrapperPtr& theValue);
  62   /// \brief Return parametric representation of constraint value
  63   const ScalarWrapperPtr& valueParameter() const
  64   { return myValueParam; }
  65
  66 private:
  67   ConstraintID                myID;
  68   SketchSolver_ConstraintType myType;
  69   ScalarWrapperPtr            myValueParam;
  70   std::list<GCSConstraintPtr> myGCSConstraints;
  71 };
  72
  73 typedef std::shared_ptr<PlaneGCSSolver_ConstraintWrapper> ConstraintWrapperPtr;
  74
  75 #endif