Salome HOME
Fix documentation problems (reported as doxygen warnings)
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_GlueAnalyser.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_GlueAnalyser.cdl
23 -- Created:     Wed Dec 15 11:03:03 2004
24 -- Author:      Peter KURNEV
25 --              <pkv@irinox>
26 --
27 class GlueAnalyser from GEOMAlgo 
28     inherits Gluer from GEOMAlgo  
29         ---Purpose: 
30
31 uses 
32     ShapeEnum from TopAbs, 
33     ListOfShape from TopTools,
34     ListOfCoupleOfShapes from GEOMAlgo
35
36 --raises
37
38 is
39     Create   
40         returns GlueAnalyser from GEOMAlgo; 
41     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_GlueAnalyser();"
42
43     Perform(me:out) 
44         is redefined; 
45          
46     HasSolidsToGlue(me)   
47         returns Boolean from Standard;  
48      
49     SolidsToGlue(me) 
50         returns ListOfCoupleOfShapes from GEOMAlgo; 
51     ---C++:return const &  
52      
53     HasSolidsAlone(me)   
54         returns Boolean from Standard; 
55      
56     SolidsAlone(me) 
57         returns ListOfShape from TopTools; 
58     ---C++:return const &   
59      
60     DetectVertices(me:out) 
61         is protected;  
62      
63     DetectEdges(me:out) 
64         is protected; 
65      
66     DetectFaces(me:out) 
67         is protected;
68      
69     DetectShapes(me:out; 
70             aType:ShapeEnum from TopAbs) 
71         is protected;        
72
73     DetectSolids (me:out) 
74         is protected; 
75         
76     
77      
78 fields  
79     mySolidsToGlue   : ListOfCoupleOfShapes from GEOMAlgo is protected; 
80     mySolidsAlone    : ListOfShape from TopTools is protected; 
81     
82 end GlueAnalyser;