0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_Refiner.cdl
1 -- Created on: 2001-12-24
2 -- Created by: Peter KURNEV
3 -- Copyright (c) 2001-2012 OPEN CASCADE SAS
4 --
5 -- The content of this file is subject to the Open CASCADE Technology Public
6 -- License Version 6.5 (the "License"). You may not use the content of this file
7 -- except in compliance with the License. Please obtain a copy of the License
8 -- at http://www.opencascade.org and read it completely before using this file.
9 --
10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 --
13 -- The Original Code and all software distributed under the License is
14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
15 -- Initial Developer hereby disclaims all such warranties, including without
16 -- limitation, any warranties of merchantability, fitness for a particular
17 -- purpose or non-infringement. Please see the License for the specific terms
18 -- and conditions governing the rights and limitations under the License.
19
20
21
22 class Refiner from BOP 
23
24         ---Purpose:  
25         --  The  algorithm to provide the refinition  
26         --  for a resulting shape of Boolean Operation  
27         --  algorithm.   
28         --  (not  completed  yet)            
29
30
31 uses
32     Shape from TopoDS,
33     ListOfShape from TopTools 
34     
35 --raises
36
37 is 
38     Create   
39         returns Refiner from BOP; 
40         ---Purpose:  
41         --- Empty constructor;  
42         ---
43     Create(aS: Shape from TopoDS)    
44         returns Refiner from BOP; 
45         ---Purpose:  
46         --- Constructor;  
47         ---
48     SetShape(me:out; 
49            aS: Shape from TopoDS); 
50         ---Purpose: 
51         --- Modifier
52         ---
53     SetInternals (me:out; 
54            aLS:ListOfShape from TopTools); 
55         ---Purpose: 
56         --- Modifier
57         ---
58     Do(me:out); 
59         ---Purpose: 
60         --- Performs the algorithm  
61         ---
62     IsDone(me) 
63         returns Boolean from Standard; 
64         ---Purpose: 
65         --- Selector
66         ---
67     ErrorStatus(me) 
68         returns Integer from Standard; 
69         ---Purpose: 
70         --- Selector
71         ---
72     Shape(me) 
73         returns Shape from TopoDS; 
74         ---C++: return const & 
75         ---Purpose: 
76         --- Selector
77         ---
78     NbRemovedVertices(me) 
79          returns Integer from Standard; 
80         ---Purpose: 
81         --- Selector
82         ---
83     NbRemovedEdges(me) 
84          returns Integer from Standard;  
85         ---Purpose: 
86         --- Selector
87         ---
88     DoInternals(me:out) is  private; 
89         ---Purpose: 
90         --- Internal usage
91         ---
92
93
94 fields
95  
96     myShape       : Shape   from TopoDS; 
97     myIsDone      : Boolean from Standard; 
98     myErrorStatus : Integer from Standard;           
99     myNbRemovedVertices  : Integer from Standard;       
100     myNbRemovedEdges     : Integer from Standard;        
101     myInternals   : ListOfShape from TopTools; 
102     
103 end Refiner;