0024428: Implementation of LGPL license
[occt.git] / src / BOPAlgo / BOPAlgo_BuilderShape.cdl
1 -- Created by: Peter KURNEV
2 -- Copyright (c) 2010-2014 OPEN CASCADE SAS
3 -- Copyright (c) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
4 -- Copyright (c) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT,
5 --                         EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 --
7 -- This file is part of Open CASCADE Technology software library.
8 --
9 -- This library is free software; you can redistribute it and / or modify it
10 -- under the terms of the GNU Lesser General Public version 2.1 as published
11 -- by the Free Software Foundation, with special exception defined in the file
12 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
13 -- distribution for complete text of the license and disclaimer of any warranty.
14 --
15 -- Alternatively, this file may be used under the terms of Open CASCADE
16 -- commercial license or contractual agreement.
17
18 deferred class BuilderShape from BOPAlgo 
19         inherits Algo from BOPAlgo  
20
21         ---Purpose: Root class for algorithms that has shape as result     
22
23 uses
24     Shape from TopoDS, 
25     ListOfShape from TopTools, 
26     BaseAllocator from BOPCol, 
27     MapOfShape  from BOPCol, 
28     IndexedDataMapOfShapeListOfShape from BOPCol 
29     
30 --raises
31
32 is 
33     Initialize 
34         returns BuilderShape from BOPAlgo; 
35     ---C++: alias "Standard_EXPORT virtual ~BOPAlgo_BuilderShape();" 
36      
37     Initialize (theAllocator: BaseAllocator from BOPCol) 
38         returns BuilderShape from BOPAlgo;  
39         
40     Shape(me)  
41         ---Purpose:  Returns the result of algorithm
42         returns Shape from TopoDS; 
43     ---C++: return const &       
44     
45     ------------------------------------------------------------------
46     --- The following methods are not implemented at this level.
47     --  An empty list is returned.
48     --- They are optional and can be redefined. 
49     ------------------------------------------------------------------
50     Generated (me:out;  
51             theS : Shape from TopoDS)
52         ---Purpose: Returns the list of shapes generated from the
53         --          shape theS. 
54         returns ListOfShape from TopTools
55         is virtual;
56         ---C++: return const & 
57
58     Modified (me:out;  
59             theS : Shape from TopoDS)
60         ---Purpose: Returns the list of shapes modified from the  
61         --          shape theS. 
62         returns ListOfShape from TopTools
63         is virtual;
64         ---C++: return const & 
65
66     IsDeleted (me:out;  
67             theS : Shape from TopoDS) 
68         ---Purpose: Returns true if the shape theS has been deleted.
69         returns Boolean from Standard  
70         is virtual; 
71          
72     HasDeleted (me)  
73         ---Purpose: Returns true if the at least one shape(or subshape) 
74         --          of arguments has been deleted.
75         returns Boolean from Standard;  
76          
77     HasGenerated (me)  
78         ---Purpose: Returns true if the at least one shape(or subshape) 
79         --          of arguments has generated shapes.
80         returns Boolean from Standard;    
81
82     HasModified (me)  
83         ---Purpose: Returns true if the at least one shape(or subshape) 
84         --          of arguments has modified shapes.
85         returns Boolean from Standard;  
86
87     PrepareHistory (me:out) 
88         ---Purpose:  Prepare information for history support  
89         is virtual protected;  
90          
91     ImagesResult(me) 
92          returns IndexedDataMapOfShapeListOfShape from BOPCol; 
93     ---C++: return const &   
94     
95 fields
96     myShape        : Shape from TopoDS is protected; 
97     -- 
98     myHistShapes   : ListOfShape from TopTools is protected; 
99     myMapShape     : MapOfShape  from BOPCol is protected; 
100     myHasDeleted   : Boolean     from Standard is protected; 
101     myHasGenerated : Boolean     from Standard is protected; 
102     myHasModified  : Boolean     from Standard is protected; 
103     myImagesResult : IndexedDataMapOfShapeListOfShape from BOPCol is protected; 
104     myFlagHistory  : Boolean     from Standard is protected;  
105     
106 end BuilderShape;  
107
108