]> SALOME platform Git repositories - modules/smesh.git/blob - src/StdMeshers_I/StdMeshers_ProjectionSource2D_i.hxx
Salome HOME
Fix problem with documentation
[modules/smesh.git] / src / StdMeshers_I / StdMeshers_ProjectionSource2D_i.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_I : idl implementation based on 'SMESH' unit's calsses
23 //  File   : StdMeshers_ProjectionSource2D_i.hxx
24 //  Author : Edward AGAPOV
25 //  Module : SMESH
26 //  $Header$
27 //
28 #ifndef _SMESH_ProjectionSource2D_I_HXX_
29 #define _SMESH_ProjectionSource2D_I_HXX_
30
31 #include <SALOMEconfig.h>
32 #include CORBA_SERVER_HEADER(SMESH_BasicHypothesis)
33 #include CORBA_SERVER_HEADER(SMESH_Mesh)
34
35 #include "SMESH_Hypothesis_i.hxx"
36 #include "StdMeshers_ProjectionSource2D.hxx"
37
38 class SMESH_Gen;
39
40 // =========================================================
41 /*!
42  * This hypothesis specifies a meshed face to take a mesh pattern from
43  * and optionally association of vertices between the source face and a
44  * target one (where a hipothesis is assigned to)
45  */
46 // =========================================================
47
48 class StdMeshers_ProjectionSource2D_i:
49   public virtual POA_StdMeshers::StdMeshers_ProjectionSource2D,
50   public virtual SMESH_Hypothesis_i
51 {
52 public:
53   // Constructor
54   StdMeshers_ProjectionSource2D_i( PortableServer::POA_ptr thePOA,
55                                    int                     theStudyId,
56                                    ::SMESH_Gen*            theGenImpl );
57   // Destructor
58   virtual ~StdMeshers_ProjectionSource2D_i();
59
60   /*!
61    * Sets a source <face> to take a mesh pattern from
62    */
63   void SetSourceFace(GEOM::GEOM_Object_ptr face)
64     throw ( SALOME::SALOME_Exception );
65
66   /*!
67    * Returns the source face
68    */
69   GEOM::GEOM_Object_ptr GetSourceFace();
70
71   /*!
72    * Sets source <mesh> to take a mesh pattern from
73    */
74   void SetSourceMesh(SMESH::SMESH_Mesh_ptr mesh)
75     throw ( SALOME::SALOME_Exception );
76
77   /*!
78    * Return source mesh
79    */
80   SMESH::SMESH_Mesh_ptr GetSourceMesh();
81
82   /*!
83    * Sets vertex association between the source face and the target one.
84    * This parameter is optional.
85    * Two vertices must belong to one edge of a face
86    */
87   void SetVertexAssociation(GEOM::GEOM_Object_ptr sourceVertex1,
88                             GEOM::GEOM_Object_ptr sourceVertex2,
89                             GEOM::GEOM_Object_ptr targetVertex1,
90                             GEOM::GEOM_Object_ptr targetVertex2)
91     throw ( SALOME::SALOME_Exception );
92
93   /*!
94    * Returns the <i>-th source vertex associated with the <i>-th target vertex.
95    * Result may be nil if association not set.
96    */
97   GEOM::GEOM_Object_ptr GetSourceVertex(CORBA::Long i);
98
99   /*!
100    * Returns the <i>-th target vertex associated with the <i>-th source vertex.
101    * Result may be nil if association not set.
102    */
103   GEOM::GEOM_Object_ptr GetTargetVertex(CORBA::Long i);
104
105   // Get implementation
106   ::StdMeshers_ProjectionSource2D* GetImpl();
107
108   // Verify whether hypothesis supports given entity type 
109   CORBA::Boolean IsDimSupported( SMESH::Dimension type );
110
111
112   // Redefined Persistence
113   virtual char* SaveTo();
114   virtual void  LoadFrom( const char* theStream );
115
116 private:
117   SMESH::SMESH_Mesh_var myCorbaMesh;
118 };
119
120 #endif
121