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