src/StdMeshers/StdMeshers_Propagation.hxx

   1 // Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  SMESH SMESH : implementaion of SMESH idl descriptions
  24 //  File   : StdMeshers_Propagation.hxx
  25 //  Module : SMESH
  26 //
  27 #ifndef _SMESH_PROPAGATION_HXX_
  28 #define _SMESH_PROPAGATION_HXX_
  29
  30 #include "SMESH_StdMeshers.hxx"
  31
  32 #include "SMESH_Hypothesis.hxx"
  33 #include "SMESH_subMeshEventListener.hxx"
  34 #include "Utils_SALOME_Exception.hxx"
  35
  36 #include <TopoDS_Edge.hxx>
  37
  38
  39 // =======================================================================
  40 /*!
  41  * \brief Propagation hypothesis
  42  */
  43 // =======================================================================
  44
  45 class STDMESHERS_EXPORT StdMeshers_Propagation:public SMESH_Hypothesis
  46 {
  47  public:
  48   StdMeshers_Propagation(int hypId, int studyId, SMESH_Gen * gen);
  49   virtual ~ StdMeshers_Propagation();
  50
  51   virtual std::ostream & SaveTo(std::ostream & save);
  52   virtual std::istream & LoadFrom(std::istream & load);
  53   friend std::ostream & operator <<(std::ostream & save, StdMeshers_Propagation & hyp);
  54   friend std::istream & operator >>(std::istream & load, StdMeshers_Propagation & hyp);
  55
  56   static std::string GetName ();
  57
  58   /*!
  59    * \brief Set EventListener managing propagation of hypotheses
  60     * \param subMesh - edge submesh to set event listener on
  61    *
  62    * 1D algo is expected to call this method from it's SetEventListener()
  63    */
  64   static void SetPropagationMgr(SMESH_subMesh* subMesh);
  65
  66   /*!
  67    * \brief Return an edge from which hypotheses are propagated
  68     * \param theMesh - mesh
  69     * \param theEdge - edge to which hypotheses are propagated
  70     * \retval TopoDS_Edge - source edge, also passing orientation
  71    */
  72   static TopoDS_Edge GetPropagationSource(SMESH_Mesh& theMesh, const TopoDS_Shape& theEdge);
  73
  74   /*!
  75    * \brief Initialize my parameter values by the mesh built on the geometry
  76     * \param theMesh - the built mesh
  77     * \param theShape - the geometry of interest
  78     * \retval bool - true if parameter values have been successfully defined
  79     *
  80     * Just return false as this hypothesis does not have parameters values
  81    */
  82   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  83
  84   /*!
  85    * \brief Initialize my parameter values by default parameters.
  86    *  \retval bool - true if parameter values have been successfully defined
  87    */
  88   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
  89
  90 };
  91 #endif