Salome HOME
remove old files
[modules/smesh.git] / doc / salome / gui / SMESH / smeshpy_doc / classsmeshDC_1_1Mesh__Prism3D.html
1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
2 <html>
3 <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5    <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
6    <title>Main Page</title>
7 <link href="doxygen.css" rel="stylesheet" type="text/css">
8 <link href="tabs.css" rel="stylesheet" type="text/css">
9 </head>
10 <body>
11 &nbsp;
12 </body>
13 </html>
14 <!-- Generated by Doxygen 1.4.7 -->
15 <div class="nav">
16 <a class="el" href="namespacesmeshDC.html">smeshDC</a>.<a class="el" href="classsmeshDC_1_1Mesh__Prism3D.html">Mesh_Prism3D</a></div>
17 <h1>smeshDC.Mesh_Prism3D Class Reference</h1><!-- doxytag: class="smeshDC::Mesh_Prism3D" --><!-- doxytag: inherits="smeshDC::Mesh_Algorithm" -->Class to define a 3D extrusion algorithm.  
18 <a href="#_details">More...</a>
19 <p>
20 Inheritance diagram for smeshDC.Mesh_Prism3D:<p><center><img src="classsmeshDC_1_1Mesh__Prism3D__inherit__graph.jpg" border="0" usemap="#smeshDC_8Mesh__Prism3D__inherit__map" alt="Inheritance graph"></center>
21 <map name="smeshDC_8Mesh__Prism3D__inherit__map">
22 <area href="classsmeshDC_1_1Mesh__Algorithm.html" shape="rect" coords="8,9,200,33" alt="">
23 </map>
24 <table border="0" cellpadding="0" cellspacing="0">
25 <tr><td></td></tr>
26 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
27 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Prism3D.html#4ce95d1e28e83b154b907b13478c1d9e">__init__</a></td></tr>
28
29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private constructor.  <a href="#4ce95d1e28e83b154b907b13478c1d9e"></a><br></td></tr>
30 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#d236fbbd88c3548e3e1cbaad693587fd">__init__</a></td></tr>
31
32 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#6e10699dca080739fe879c39242d383f">GetSubMesh</a></td></tr>
33
34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If the algorithm is global, return 0; <br>
35  else return the submesh associated to this algorithm.  <a href="#6e10699dca080739fe879c39242d383f"></a><br></td></tr>
36 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#823bceab89ad9844fbdcf7a2b59b82d4">GetAlgorithm</a></td></tr>
37
38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the wrapped mesher.  <a href="#823bceab89ad9844fbdcf7a2b59b82d4"></a><br></td></tr>
39 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#cc7b73f68fec47890cf16932a71e71ff">GetCompatibleHypothesis</a></td></tr>
40
41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get list of hypothesis that can be used with this algorithm.  <a href="#cc7b73f68fec47890cf16932a71e71ff"></a><br></td></tr>
42 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#07001c3590c379d357754b3a8b4e62f2">GetName</a></td></tr>
43
44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get name of algo.  <a href="#07001c3590c379d357754b3a8b4e62f2"></a><br></td></tr>
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#fc9788a5b000f2f7afb7f7e81888bc1d">SetName</a></td></tr>
46
47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set name to algo.  <a href="#fc9788a5b000f2f7afb7f7e81888bc1d"></a><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#84a52154a90fef60f7939fc73084dea2">GetId</a></td></tr>
49
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get id of algo.  <a href="#84a52154a90fef60f7939fc73084dea2"></a><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#6ed4da82cee92b3be4b42debecb10bfd">Create</a></td></tr>
52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private method.  <a href="#6ed4da82cee92b3be4b42debecb10bfd"></a><br></td></tr>
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">def&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#088088a4a4c2f4057984a8d5f5af05d0">Hypothesis</a></td></tr>
55
56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private method.  <a href="#088088a4a4c2f4057984a8d5f5af05d0"></a><br></td></tr>
57 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#a26131bcccd55e4d89612e43aeba151a">smesh</a></td></tr>
59
60 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#389abfff22e0cd47e6fd98f5f5000cfa">mesh</a></td></tr>
61
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#20ae4013ee7d13170461eca766fdda32">geom</a></td></tr>
63
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#3292dd6a8b832264d19f199469602054">subm</a></td></tr>
65
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#f42e17af989dda7a186b5d7e68f2ec71">algo</a></td></tr>
67
68 </table>
69 <hr><a name="_details"></a><h2>Detailed Description</h2>
70 More details. 
71 <p>
72 <hr><h2>Member Function Documentation</h2>
73 <a class="anchor" name="4ce95d1e28e83b154b907b13478c1d9e"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::__init__" ref="4ce95d1e28e83b154b907b13478c1d9e" args="" -->
74 <div class="memitem">
75 <div class="memproto">
76       <table class="memname">
77         <tr>
78           <td class="memname">def smeshDC.Mesh_Prism3D.__init__           </td>
79           <td>(</td>
80           <td class="paramtype">&nbsp;</td>
81           <td class="paramname"> <em>self</em>, </td>
82         </tr>
83         <tr>
84           <td class="paramkey"></td>
85           <td></td>
86           <td class="paramtype">&nbsp;</td>
87           <td class="paramname"> <em>mesh</em>, </td>
88         </tr>
89         <tr>
90           <td class="paramkey"></td>
91           <td></td>
92           <td class="paramtype">&nbsp;</td>
93           <td class="paramname"> <em>geom</em> = <code>0</code></td><td>&nbsp;</td>
94         </tr>
95         <tr>
96           <td></td>
97           <td>)</td>
98           <td></td><td></td><td width="100%"></td>
99         </tr>
100       </table>
101 </div>
102 <div class="memdoc">
103
104 <p>
105
106 </div>
107 </div><p>
108 <a class="anchor" name="d236fbbd88c3548e3e1cbaad693587fd"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::__init__" ref="d236fbbd88c3548e3e1cbaad693587fd" args="" -->
109 <div class="memitem">
110 <div class="memproto">
111       <table class="memname">
112         <tr>
113           <td class="memname">def smeshDC.Mesh_Algorithm.__init__           </td>
114           <td>(</td>
115           <td class="paramtype">&nbsp;</td>
116           <td class="paramname"> <em>self</em>, </td>
117         </tr>
118         <tr>
119           <td class="paramkey"></td>
120           <td></td>
121           <td class="paramtype">&nbsp;</td>
122           <td class="paramname"> <em>smesh</em></td><td>&nbsp;</td>
123         </tr>
124         <tr>
125           <td></td>
126           <td>)</td>
127           <td></td><td></td><td width="100%"><code> [inherited]</code></td>
128         </tr>
129       </table>
130 </div>
131 <div class="memdoc">
132
133 <p>
134
135 </div>
136 </div><p>
137 <a class="anchor" name="6e10699dca080739fe879c39242d383f"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::GetSubMesh" ref="6e10699dca080739fe879c39242d383f" args="" -->
138 <div class="memitem">
139 <div class="memproto">
140       <table class="memname">
141         <tr>
142           <td class="memname">def smeshDC.Mesh_Algorithm.GetSubMesh           </td>
143           <td>(</td>
144           <td class="paramtype">&nbsp;</td>
145           <td class="paramname"> <em>self</em>          </td>
146           <td>&nbsp;)&nbsp;</td>
147           <td width="100%"><code> [inherited]</code></td>
148         </tr>
149       </table>
150 </div>
151 <div class="memdoc">
152
153 <p>
154
155 </div>
156 </div><p>
157 <a class="anchor" name="823bceab89ad9844fbdcf7a2b59b82d4"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::GetAlgorithm" ref="823bceab89ad9844fbdcf7a2b59b82d4" args="" -->
158 <div class="memitem">
159 <div class="memproto">
160       <table class="memname">
161         <tr>
162           <td class="memname">def smeshDC.Mesh_Algorithm.GetAlgorithm           </td>
163           <td>(</td>
164           <td class="paramtype">&nbsp;</td>
165           <td class="paramname"> <em>self</em>          </td>
166           <td>&nbsp;)&nbsp;</td>
167           <td width="100%"><code> [inherited]</code></td>
168         </tr>
169       </table>
170 </div>
171 <div class="memdoc">
172
173 <p>
174
175 </div>
176 </div><p>
177 <a class="anchor" name="cc7b73f68fec47890cf16932a71e71ff"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::GetCompatibleHypothesis" ref="cc7b73f68fec47890cf16932a71e71ff" args="" -->
178 <div class="memitem">
179 <div class="memproto">
180       <table class="memname">
181         <tr>
182           <td class="memname">def smeshDC.Mesh_Algorithm.GetCompatibleHypothesis           </td>
183           <td>(</td>
184           <td class="paramtype">&nbsp;</td>
185           <td class="paramname"> <em>self</em>          </td>
186           <td>&nbsp;)&nbsp;</td>
187           <td width="100%"><code> [inherited]</code></td>
188         </tr>
189       </table>
190 </div>
191 <div class="memdoc">
192
193 <p>
194
195 </div>
196 </div><p>
197 <a class="anchor" name="07001c3590c379d357754b3a8b4e62f2"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::GetName" ref="07001c3590c379d357754b3a8b4e62f2" args="" -->
198 <div class="memitem">
199 <div class="memproto">
200       <table class="memname">
201         <tr>
202           <td class="memname">def smeshDC.Mesh_Algorithm.GetName           </td>
203           <td>(</td>
204           <td class="paramtype">&nbsp;</td>
205           <td class="paramname"> <em>self</em>          </td>
206           <td>&nbsp;)&nbsp;</td>
207           <td width="100%"><code> [inherited]</code></td>
208         </tr>
209       </table>
210 </div>
211 <div class="memdoc">
212
213 <p>
214
215 </div>
216 </div><p>
217 <a class="anchor" name="fc9788a5b000f2f7afb7f7e81888bc1d"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::SetName" ref="fc9788a5b000f2f7afb7f7e81888bc1d" args="" -->
218 <div class="memitem">
219 <div class="memproto">
220       <table class="memname">
221         <tr>
222           <td class="memname">def smeshDC.Mesh_Algorithm.SetName           </td>
223           <td>(</td>
224           <td class="paramtype">&nbsp;</td>
225           <td class="paramname"> <em>self</em>, </td>
226         </tr>
227         <tr>
228           <td class="paramkey"></td>
229           <td></td>
230           <td class="paramtype">&nbsp;</td>
231           <td class="paramname"> <em>name</em></td><td>&nbsp;</td>
232         </tr>
233         <tr>
234           <td></td>
235           <td>)</td>
236           <td></td><td></td><td width="100%"><code> [inherited]</code></td>
237         </tr>
238       </table>
239 </div>
240 <div class="memdoc">
241
242 <p>
243
244 </div>
245 </div><p>
246 <a class="anchor" name="84a52154a90fef60f7939fc73084dea2"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::GetId" ref="84a52154a90fef60f7939fc73084dea2" args="" -->
247 <div class="memitem">
248 <div class="memproto">
249       <table class="memname">
250         <tr>
251           <td class="memname">def smeshDC.Mesh_Algorithm.GetId           </td>
252           <td>(</td>
253           <td class="paramtype">&nbsp;</td>
254           <td class="paramname"> <em>self</em>          </td>
255           <td>&nbsp;)&nbsp;</td>
256           <td width="100%"><code> [inherited]</code></td>
257         </tr>
258       </table>
259 </div>
260 <div class="memdoc">
261
262 <p>
263
264 </div>
265 </div><p>
266 <a class="anchor" name="6ed4da82cee92b3be4b42debecb10bfd"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::Create" ref="6ed4da82cee92b3be4b42debecb10bfd" args="" -->
267 <div class="memitem">
268 <div class="memproto">
269       <table class="memname">
270         <tr>
271           <td class="memname">def smeshDC.Mesh_Algorithm.Create           </td>
272           <td>(</td>
273           <td class="paramtype">&nbsp;</td>
274           <td class="paramname"> <em>self</em>, </td>
275         </tr>
276         <tr>
277           <td class="paramkey"></td>
278           <td></td>
279           <td class="paramtype">&nbsp;</td>
280           <td class="paramname"> <em>mesh</em>, </td>
281         </tr>
282         <tr>
283           <td class="paramkey"></td>
284           <td></td>
285           <td class="paramtype">&nbsp;</td>
286           <td class="paramname"> <em>geom</em>, </td>
287         </tr>
288         <tr>
289           <td class="paramkey"></td>
290           <td></td>
291           <td class="paramtype">&nbsp;</td>
292           <td class="paramname"> <em>hypo</em>, </td>
293         </tr>
294         <tr>
295           <td class="paramkey"></td>
296           <td></td>
297           <td class="paramtype">&nbsp;</td>
298           <td class="paramname"> <em>so</em> = <code>&quot;libStdMeshersEngine.so&quot;</code></td><td>&nbsp;</td>
299         </tr>
300         <tr>
301           <td></td>
302           <td>)</td>
303           <td></td><td></td><td width="100%"><code> [inherited]</code></td>
304         </tr>
305       </table>
306 </div>
307 <div class="memdoc">
308
309 <p>
310
311 </div>
312 </div><p>
313 <a class="anchor" name="088088a4a4c2f4057984a8d5f5af05d0"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::Hypothesis" ref="088088a4a4c2f4057984a8d5f5af05d0" args="" -->
314 <div class="memitem">
315 <div class="memproto">
316       <table class="memname">
317         <tr>
318           <td class="memname">def smeshDC.Mesh_Algorithm.Hypothesis           </td>
319           <td>(</td>
320           <td class="paramtype">&nbsp;</td>
321           <td class="paramname"> <em>self</em>, </td>
322         </tr>
323         <tr>
324           <td class="paramkey"></td>
325           <td></td>
326           <td class="paramtype">&nbsp;</td>
327           <td class="paramname"> <em>hyp</em>, </td>
328         </tr>
329         <tr>
330           <td class="paramkey"></td>
331           <td></td>
332           <td class="paramtype">&nbsp;</td>
333           <td class="paramname"> <em>args</em> = <code>[]</code>, </td>
334         </tr>
335         <tr>
336           <td class="paramkey"></td>
337           <td></td>
338           <td class="paramtype">&nbsp;</td>
339           <td class="paramname"> <em>so</em> = <code>&quot;libStdMeshersEngine.so&quot;</code></td><td>&nbsp;</td>
340         </tr>
341         <tr>
342           <td></td>
343           <td>)</td>
344           <td></td><td></td><td width="100%"><code> [inherited]</code></td>
345         </tr>
346       </table>
347 </div>
348 <div class="memdoc">
349
350 <p>
351
352 </div>
353 </div><p>
354 <hr><h2>Field Documentation</h2>
355 <a class="anchor" name="a26131bcccd55e4d89612e43aeba151a"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::smesh" ref="a26131bcccd55e4d89612e43aeba151a" args="" -->
356 <div class="memitem">
357 <div class="memproto">
358       <table class="memname">
359         <tr>
360           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#a26131bcccd55e4d89612e43aeba151a">smeshDC.Mesh_Algorithm.smesh</a><code> [inherited]</code>          </td>
361         </tr>
362       </table>
363 </div>
364 <div class="memdoc">
365
366 <p>
367
368 </div>
369 </div><p>
370 <a class="anchor" name="389abfff22e0cd47e6fd98f5f5000cfa"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::mesh" ref="389abfff22e0cd47e6fd98f5f5000cfa" args="" -->
371 <div class="memitem">
372 <div class="memproto">
373       <table class="memname">
374         <tr>
375           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#389abfff22e0cd47e6fd98f5f5000cfa">smeshDC.Mesh_Algorithm.mesh</a><code> [inherited]</code>          </td>
376         </tr>
377       </table>
378 </div>
379 <div class="memdoc">
380
381 <p>
382
383 </div>
384 </div><p>
385 <a class="anchor" name="20ae4013ee7d13170461eca766fdda32"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::geom" ref="20ae4013ee7d13170461eca766fdda32" args="" -->
386 <div class="memitem">
387 <div class="memproto">
388       <table class="memname">
389         <tr>
390           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#20ae4013ee7d13170461eca766fdda32">smeshDC.Mesh_Algorithm.geom</a><code> [inherited]</code>          </td>
391         </tr>
392       </table>
393 </div>
394 <div class="memdoc">
395
396 <p>
397
398 <p>
399 Reimplemented in <a class="el" href="classsmeshDC_1_1Mesh__Segment.html#44e8968ec16413fd4aac2b906c313c0e">smeshDC.Mesh_Segment</a>.
400 </div>
401 </div><p>
402 <a class="anchor" name="3292dd6a8b832264d19f199469602054"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::subm" ref="3292dd6a8b832264d19f199469602054" args="" -->
403 <div class="memitem">
404 <div class="memproto">
405       <table class="memname">
406         <tr>
407           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#3292dd6a8b832264d19f199469602054">smeshDC.Mesh_Algorithm.subm</a><code> [inherited]</code>          </td>
408         </tr>
409       </table>
410 </div>
411 <div class="memdoc">
412
413 <p>
414
415 </div>
416 </div><p>
417 <a class="anchor" name="f42e17af989dda7a186b5d7e68f2ec71"></a><!-- doxytag: member="smeshDC::Mesh_Prism3D::algo" ref="f42e17af989dda7a186b5d7e68f2ec71" args="" -->
418 <div class="memitem">
419 <div class="memproto">
420       <table class="memname">
421         <tr>
422           <td class="memname"><a class="el" href="classsmeshDC_1_1Mesh__Algorithm.html#f42e17af989dda7a186b5d7e68f2ec71">smeshDC.Mesh_Algorithm.algo</a><code> [inherited]</code>          </td>
423         </tr>
424       </table>
425 </div>
426 <div class="memdoc">
427
428 <p>
429
430 </div>
431 </div><p>
432 </DIV>
433 <DIV class="div-footer">
434 Generated on Thu Jun 21 13:26:51 2007 for SALOME - SMESH - v.4.0.0 by&nbsp;<A href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></A> 1.4.7</DIV>
435 </BODY>
436 </HTML>