0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BOPAlgo / BOPAlgo_Section.cdl
1 -- Created by: Peter KURNEV
2 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
3 --
4 -- This file is part of Open CASCADE Technology software library.
5 --
6 -- This library is free software; you can redistribute it and/or modify it under
7 -- the terms of the GNU Lesser General Public License version 2.1 as published
8 -- by the Free Software Foundation, with special exception defined in the file
9 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 -- distribution for complete text of the license and disclaimer of any warranty.
11 --
12 -- Alternatively, this file may be used under the terms of Open CASCADE
13 -- commercial license or contractual agreement. 
14
15  
16 class Section from BOPAlgo  
17     inherits Builder from BOPAlgo
18  
19     ---Purpose: 
20     -- The algorithm to build a Secton between the arguments. 
21     -- The Section consists of vertices and edges. 
22     -- The Section contains:
23     -- 1. new vertices that are subjects of V/V, E/E, E/F, F/F interferences
24     -- 2. vertices that are subjects of V/E, V/F interferences
25     -- 3. new edges that are subjects of F/F interferences
26     -- 4. edges that are Common Blocks
27
28     -- The vertex is included in Section only when it is not shared 
29     -- between the edges above
30
31 uses 
32     ShapeEnum from TopAbs,
33     Shape from TopoDS,   
34     ListOfShape from TopTools, 
35     BaseAllocator from BOPCol,  
36     PaveFiller from BOPAlgo 
37
38 --raises
39
40 is
41     Create  
42         returns Section from BOPAlgo;  
43     ---C++: alias "Standard_EXPORT virtual ~BOPAlgo_Section();"  
44     ---Purpose:  Empty constructor    
45  
46     Create (theAllocator: BaseAllocator from BOPCol)
47         returns Section from BOPAlgo; 
48     ---Purpose:  Empty constructor    
49     --
50     --  protected methods 
51     -- 
52     CheckData(me:out) 
53         is redefined protected; 
54     ---Purpose:  
55     
56     PerformInternal1(me:out; 
57         thePF:PaveFiller from BOPAlgo) 
58         is redefined protected;   
59     ---Purpose:  Performs calculations using prepared Filler 
60     --           object <thePF>                  
61      
62     BuildSection(me:out) 
63         is virtual; 
64     --
65     --  History 
66     -- 
67     Generated (me:out;  
68             theS : Shape from TopoDS) 
69         returns ListOfShape from TopTools
70         is redefined; 
71     ---C++: return const & 
72     ---Purpose: Returns the  list of shapes generated from the
73     --          shape theS. 
74     
75 end Section;