0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_ShellSplitter.cdl
1 -- Created on: 2001-04-09
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 ShellSplitter from BOP 
23
24         ---Purpose:  
25         ---  the algorithm to split (multiconnexed)   
26         ---  shells on a solid onto biconnexed shells 
27         ---  when each edge is shared by only two or one  
28         --   faces       
29
30 uses 
31
32     Shell  from TopoDS,
33     ListOfShape from  TopTools, 
34     
35     ListOfListOfShape from BOPTColStd, 
36     
37     EdgeInfo                         from BOP,
38     IndexedDataMapOfEdgeListFaceInfo from BOP
39
40  --raises
41
42 is 
43     Create   
44         returns ShellSplitter from BOP; 
45         ---Purpose:  
46         --- Empty constructor; 
47         ---
48     DoWithListOfEdges(me:out; 
49                 aLE:ListOfShape from  TopTools); 
50         ---Purpose:  
51         --- Perform the algorithm using the  list of shapes <aLE> as data  
52         ---
53     SetShell    (me:out; 
54                 aShell:Shell from TopoDS);           
55         ---Purpose:  
56         --- Modifier
57         ---
58     Shell    (me) 
59         returns Shell from TopoDS; 
60         ---C++:  return const &  
61         ---Purpose:  
62         --- Selector
63         ---
64     DoWithShell (me:out); 
65         ---Purpose:  
66         --- Perform the algorithm using the shell as data  
67         ---
68     Do          (me:out) 
69         is private;  
70         ---Purpose:  
71         --- Perform the algorithm 
72         ---
73     IsNothingToDo (me) 
74         returns  Boolean from Standard;
75         ---Purpose: 
76         --- Returns TRUE if the source shell is valid and      
77         --- there  is  nothing to correct 
78         ---
79     IsDone (me) 
80         returns  Boolean from Standard; 
81         ---Purpose:  
82         --- Returns TRUE if the algorithm was performed  
83         --- successfuly 
84         ---
85     Shapes (me) 
86         returns  ListOfListOfShape from BOPTColStd;
87         ---C++:  return const &                  
88         ---Purpose:  
89         --- Selector
90         ---
91     
92         
93 fields  
94     myShell      :  Shell from TopoDS;
95     myIsDone     :  Boolean from Standard;
96     myNothingToDo:  Boolean from Standard;
97     myShapes     :  ListOfListOfShape from BOPTColStd; 
98     mySmartMap   :  IndexedDataMapOfEdgeListFaceInfo from BOP;  
99     myFaces      :  ListOfShape from  TopTools; 
100     
101 end ShellSplitter;
102
103
104
105
106
107
108
109
110
111