Salome HOME
46ee5fad978cb6392e1b86cda38966b4e8c99f12
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_FinderShapeOn1.cdl
1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
3 // 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either 
7 // version 2.1 of the License.
8 // 
9 // This library is distributed in the hope that it will be useful 
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
12 // Lesser General Public License for more details.
13 //
14 // You should have received a copy of the GNU Lesser General Public  
15 // License along with this library; if not, write to the Free Software 
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17 //
18 // See http://www.salome-platform.org/
19 //
20 -- File:        GEOMAlgo_FinderShapeOn1.cdl
21 -- Created:     Fri Mar  4 10:26:54 2005
22 -- Author:      Peter KURNEV
23 --              <pkv@irinox>
24 ---Copyright:    Matra Datavision 2005
25
26
27 class FinderShapeOn1 from GEOMAlgo  
28     inherits ShapeAlgo from GEOMAlgo 
29
30         ---Purpose: 
31
32 uses
33     Surface from Geom, 
34     Surface from GeomAdaptor, 
35      
36     ShapeEnum from TopAbs, 
37     State from TopAbs,
38     Face from TopoDS, 
39     Edge from TopoDS, 
40     ListOfShape from TopTools,  
41      
42     State from GEOMAlgo, 
43     ListOfPnt from GEOMAlgo, 
44     IndexedDataMapOfShapeState from GEOMAlgo 
45     
46 --raises
47
48 is 
49     Create   
50         returns FinderShapeOn1 from GEOMAlgo; 
51     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_FinderShapeOn1();" 
52
53     SetSurface(me:out; 
54             aS:Surface from Geom); 
55          
56     SetShapeType(me:out; 
57             aST:ShapeEnum from TopAbs); 
58          
59     SetState(me:out; 
60             aSF:State from GEOMAlgo);      
61      
62     SetNbPntsMin(me:out; 
63             aNb:Integer from Standard);   
64
65     NbPntsMin(me) 
66         returns Integer from Standard; 
67          
68     SetNbPntsMax(me:out; 
69             aNb:Integer from Standard);   
70
71     NbPntsMax(me) 
72         returns Integer from Standard; 
73          
74     Surface(me) 
75         returns Surface from Geom; 
76     ---C++: return const & 
77      
78     ShapeType(me) 
79         returns ShapeEnum from TopAbs; 
80          
81     State(me)
82         returns State from GEOMAlgo;  
83      
84     Perform(me:out) 
85         is redefined; 
86          
87     Shapes(me)
88         returns ListOfShape from TopTools; 
89     ---C++: return const &  
90     -- 
91     --  protected  methods
92     -- 
93     CheckData(me:out) 
94         is redefined protected; 
95          
96     ProcessVertices(me:out) 
97         is protected; 
98      
99     ProcessEdges(me:out) 
100         is protected; 
101   
102     ProcessFaces(me:out) 
103         is protected; 
104          
105     ProcessSolids(me:out) 
106         is protected; 
107           
108     InnerPoints(me:out; 
109             aF :Face from TopoDS;            
110             aLP:out ListOfPnt from GEOMAlgo) 
111         is protected;  
112          
113     InnerPoints(me:out; 
114             aE :Edge from TopoDS;            
115             aLP:out ListOfPnt from GEOMAlgo) 
116         is protected; 
117          
118     InnerPoints(me:out; 
119             aE :Edge from TopoDS;            
120             aNbPnts: Integer from Standard;     
121             aLP:out ListOfPnt from GEOMAlgo) 
122         is protected;  
123       
124     MSS (me)  
125         returns IndexedDataMapOfShapeState from GEOMAlgo; 
126     ---C++:return const &       
127     
128     GetPointState(me:out; aP: Pnt from gp)
129         returns State from TopAbs is virtual protected;
130
131 fields
132     mySurface   : Surface from Geom is protected;  
133     myShapeType : ShapeEnum from TopAbs is protected;  
134     myState     : State from GEOMAlgo is protected;  
135     myNbPntsMin : Integer from Standard is protected;   
136     myNbPntsMax : Integer from Standard is protected;   
137     -- 
138     myGAS       : Surface from GeomAdaptor is protected;
139     myLS        : ListOfShape from TopTools is protected; 
140     --     
141     myMSS       : IndexedDataMapOfShapeState from GEOMAlgo is protected;
142  
143 end FinderShapeOn1;