0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepAlgoAPI / BRepAlgoAPI_BuilderAlgo.cdl
1 -- Created by: Peter KURNEV
2 -- Copyright (c) 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 class BuilderAlgo from BRepAlgoAPI
16         inherits Algo from BRepAlgoAPI 
17     ---Purpose:  
18     --  The clsss contains API level of General Fuse algorithm
19
20 uses
21     Shape from TopoDS, 
22     ListOfShape from TopTools,
23     --
24     PPaveFiller from BOPAlgo, 
25     PaveFiller from BOPAlgo,
26     PBuilder from BOPAlgo
27     
28 --raises
29
30 is
31     Create  
32         returns BuilderAlgo from BRepAlgoAPI; 
33     ---Purpose:  Empty constructor 
34     ---C++: alias "Standard_EXPORT virtual ~BRepAlgoAPI_BuilderAlgo();"
35
36  
37     Create(thePF  :PaveFiller from BOPAlgo)  
38         returns BuilderAlgo from BRepAlgoAPI; 
39     ---Purpose:  Empty constructor  
40      
41     SetFuzzyValue(me:out; 
42         theFuzz : Real from Standard);
43     ---Purpose: Sets the additional tolerance
44
45     FuzzyValue(me)
46         returns Real from Standard;
47     ---Purpose: Returns the additional tolerance   
48     
49     SetArguments(me:out; 
50         theLS: ListOfShape from TopTools);  
51     ---Purpose: Sets the arguments    
52             
53     Arguments(me) 
54         returns ListOfShape from TopTools; 
55     ---C++: return const & 
56     ---Purpose: Gets the arguments   
57     
58     Build  (me:out) 
59         is redefined virtual; 
60     ---Purpose:  Performs the algorithm 
61     -- 
62     --  H  I  S  T  O  R  Y           
63     --
64     Modified (me: in out;  
65             aS : Shape from TopoDS) 
66         returns ListOfShape from TopTools
67         is redefined virtual;
68     ---Purpose: Returns the list  of shapes modified from the shape <S>. 
69     ---C++: return const & 
70
71     IsDeleted (me: in out;  
72             aS : Shape from TopoDS)
73         returns Boolean
74         is redefined virtual;
75     ---Purpose: Returns true if the shape S has been deleted. The
76     -- result shape of the operation does not contain the shape S.
77         
78     Generated (me: in out;  
79             S : Shape from TopoDS)
80         returns ListOfShape from TopTools
81         is redefined virtual;
82     ---Purpose: Returns the list  of shapes generated from the shape <S>.
83     ---         For use in BRepNaming.
84     ---C++:  return const &
85     
86     HasModified (me) 
87         returns Boolean from Standard
88         is virtual;
89     ---Purpose: Returns true if there is at least one modified shape.
90     ---         For use in BRepNaming.
91
92     HasGenerated (me)
93         returns Boolean from Standard
94         is virtual;
95     ---Purpose: Returns true if there is at least one generated shape.
96     ---         For use in BRepNaming.
97
98     HasDeleted (me)
99         returns Boolean from Standard
100         is virtual;
101     ---Purpose: Returns true if there is at least one deleted shape.
102     ---         For use in BRepNaming. 
103     --
104     --  protected methods
105     --
106     Clear(me:out) 
107         is redefined protected; 
108
109 fields
110     myEntryType  : Integer from Standard is protected;    
111     myDSFiller   : PPaveFiller from BOPAlgo  is protected;
112     myBuilder    : PBuilder    from BOPAlgo  is protected;
113     myFuzzyValue : Real        from Standard is protected; 
114     myArguments  : ListOfShape from TopTools is protected;   
115 end BuilderAlgo;