src/SketchSolver/PlaneGCSSolver/PlaneGCSSolver_EntityBuilder.h

   1 // Copyright (C) 2014-2019  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_EntityBuilder_H_
  21 #define PlaneGCSSolver_EntityBuilder_H_
  22
  23 #include <PlaneGCSSolver_Defs.h>
  24 #include <PlaneGCSSolver_Storage.h>
  25
  26 /** \class   PlaneGCSSolver_EntityBuilder
  27  *  \ingroup Plugins
  28  *  \brief   API to convert data model entity to the entity applicable for PlaneGCS solver
  29  */
  30 class PlaneGCSSolver_EntityBuilder
  31 {
  32 public:
  33   /// \brief Create entity in the given storage.
  34   ///        If the storage is empty, the entity should not be changed
  35   ///         while constraint solving. So, it is created out of the storage.
  36   PlaneGCSSolver_EntityBuilder(PlaneGCSSolver_Storage* theStorage = 0)
  37     : myStorage(theStorage)
  38   {}
  39
  40   virtual ~PlaneGCSSolver_EntityBuilder() {}
  41
  42   /// \brief Converts an attribute to the solver's entity.
  43   ///        Double attributes and 2D points are supported only.
  44   /// \param theAttribute [in]  attribute to create
  45   /// \return Created wrapper of the attribute applicable for specific solver
  46   virtual EntityWrapperPtr createAttribute(AttributePtr theAttribute) = 0;
  47
  48   /// \brief Converts SketchPlugin's feature to the solver's entity.
  49   ///        Result if based on the list of already converted attributes.
  50   /// \param theFeature [in]  feature to create
  51   virtual EntityWrapperPtr createFeature(FeaturePtr) = 0;
  52
  53 protected:
  54   PlaneGCSSolver_Storage* myStorage;
  55 };
  56
  57 #endif