src/StdMeshers/StdMeshers_Propagation.hxx

   1 //  Copyright (C) 2007-2008  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 //  SMESH SMESH : implementaion of SMESH idl descriptions
  23 //  File   : StdMeshers_Propagation.hxx
  24 //  Module : SMESH
  25
  26 #ifndef _SMESH_PROPAGATION_HXX_
  27 #define _SMESH_PROPAGATION_HXX_
  28
  29 #include "SMESH_StdMeshers.hxx"
  30
  31 #include "SMESH_Hypothesis.hxx"
  32 #include "SMESH_subMeshEventListener.hxx"
  33 #include "Utils_SALOME_Exception.hxx"
  34
  35 #include <TopoDS_Edge.hxx>
  36
  37
  38 // =======================================================================
  39 /*!
  40  * \brief Propagation hypothesis
  41  */
  42 // =======================================================================
  43
  44 class STDMESHERS_EXPORT StdMeshers_Propagation:public SMESH_Hypothesis
  45 {
  46  public:
  47   StdMeshers_Propagation(int hypId, int studyId, SMESH_Gen * gen);
  48   virtual ~ StdMeshers_Propagation();
  49
  50   virtual std::ostream & SaveTo(std::ostream & save);
  51   virtual std::istream & LoadFrom(std::istream & load);
  52   friend std::ostream & operator <<(std::ostream & save, StdMeshers_Propagation & hyp);
  53   friend std::istream & operator >>(std::istream & load, StdMeshers_Propagation & hyp);
  54
  55   static std::string GetName ();
  56
  57   /*!
  58    * \brief Set EventListener managing propagation of hypotheses
  59     * \param subMesh - edge submesh to set event listener on
  60    *
  61    * 1D algo is expected to call this method from it's SetEventListener()
  62    */
  63   static void SetPropagationMgr(SMESH_subMesh* subMesh);
  64
  65   /*!
  66    * \brief Return an edge from which hypotheses are propagated
  67     * \param theMesh - mesh
  68     * \param theEdge - edge to which hypotheses are propagated
  69     * \retval TopoDS_Edge - source edge, also passing orientation
  70    */
  71   static TopoDS_Edge GetPropagationSource(SMESH_Mesh& theMesh, const TopoDS_Shape& theEdge);
  72
  73   /*!
  74    * \brief Initialize my parameter values by the mesh built on the geometry
  75     * \param theMesh - the built mesh
  76     * \param theShape - the geometry of interest
  77     * \retval bool - true if parameter values have been successfully defined
  78     *
  79     * Just return false as this hypothesis does not have parameters values
  80    */
  81   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  82
  83   /*!
  84    * \brief Initialize my parameter values by default parameters.
  85    *  \retval bool - true if parameter values have been successfully defined
  86    */
  87   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
  88
  89 };
  90 #endif