src/SketchSolver/SolveSpaceSolver/SolveSpaceSolver_ParameterWrapper.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 SolveSpaceSolver_ParameterWrapper_H_
  22 #define SolveSpaceSolver_ParameterWrapper_H_
  23
  24 #include <SketchSolver_IParameterWrapper.h>
  25 #include <SolveSpaceSolver_Solver.h>
  26
  27 /**
  28  *  Wrapper providing operations with parameters in SolveSpace.
  29  */
  30 class SolveSpaceSolver_ParameterWrapper : public SketchSolver_IParameterWrapper
  31 {
  32 public:
  33   SolveSpaceSolver_ParameterWrapper(const Slvs_Param& theParam);
  34
  35   /// \brief Return SolveSpace parameter
  36   const Slvs_Param& parameter() const
  37   { return myParameter; }
  38   /// \brief Return SolveSpace parameter to change
  39   Slvs_Param& changeParameter()
  40   { return myParameter; }
  41
  42   /// \brief Return ID of current parameter
  43   virtual ParameterID id() const;
  44
  45   /// \brief Change group for the parameter
  46   virtual void setGroup(const GroupID& theGroup)
  47   { myParameter.group = (Slvs_hGroup)theGroup; }
  48
  49   /// \brief Return identifier of the group the parameter belongs to
  50   virtual GroupID group() const
  51   { return (GroupID)myParameter.group; }
  52
  53   /// \brief Change value of parameter
  54   virtual void setValue(double theValue);
  55   /// \brief Return value of parameter
  56   virtual double value() const;
  57
  58   /// \brief Compare current parameter with other
  59   virtual bool isEqual(const ParameterWrapperPtr& theOther);
  60
  61   /// \brief Update value of parameter by the given one
  62   /// \return \c true if the value of parameter is changed
  63   virtual bool update(const std::shared_ptr<SketchSolver_IParameterWrapper>& theOther);
  64
  65 private:
  66   Slvs_Param myParameter;
  67 };
  68
  69 #endif