src/StdMeshers/StdMeshers_Propagation.hxx

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