Salome HOME
Fix documentation problems (reported as doxygen warnings)
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_BuilderFace.cdl
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 -- File:        GEOMAlgo_BuilderFace.cdl
23 -- Created:     
24 -- Author:      Peter KURNEV 
25 --
26 class BuilderFace from GEOMAlgo 
27         inherits BuilderArea from GEOMAlgo 
28          
29         ---Purpose: The algorithm to build faces from set of edges  
30
31 uses   
32     Face from TopoDS
33
34 --raises
35
36 is 
37     Create  
38         ---Purpose:  Empty  constructor
39         returns BuilderFace from GEOMAlgo; 
40     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_BuilderFace();" 
41      
42     SetFace(me:out; 
43             theFace:Face from TopoDS);     
44         ---Purpose: Sets the face generatix  
45          
46     Face(me) 
47         ---Purpose: Returns the face generatix   
48         returns Face from TopoDS; 
49     ---C++:  return const &
50                  
51     Perform(me:out)  
52         ---Purpose:  Performs the algorithm 
53         is redefined;  
54          
55     PerformShapesToAvoid(me:out) 
56         ---Purpose:  Collect the edges that 
57         --           a) are internal             
58         --           b) are the same and have different orientation              
59         is redefined protected; 
60          
61     PerformLoops(me:out) 
62         ---Purpose: Build draft wires 
63         --          a)myLoops - draft wires that consist of  
64         --                       boundary edges 
65         --          b)myLoopsInternal - draft wires that contains 
66         --                               inner edges 
67         is redefined protected;  
68          
69     PerformAreas(me:out)   
70         ---Purpose: Build draft faces that contains boundary edges 
71         is redefined protected;  
72
73     PerformInternalShapes(me:out)   
74         ---Purpose: Build finalized faces with internals   
75         is redefined protected;  
76      
77
78 fields  
79     myFace : Face from TopoDS is protected;     
80      
81 end BuilderFace; 
82