0025477: Boolean Operations with additional tolerance - Fuzzy Boolean operations
[occt.git] / src / BRepAlgoAPI / BRepAlgoAPI_Algo.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 deferred class Algo from BRepAlgoAPI
16         inherits MakeShape from BRepBuilderAPI
17  ---Purpose: provides the root interface for algorithms
18
19 uses
20     BaseAllocator from BOPCol,
21     ProgressIndicator from Message,
22     Shape from TopoDS
23
24 --raises
25
26 is
27     Initialize 
28         returns Algo from BRepAlgoAPI;
29     ---C++: alias "Standard_EXPORT virtual ~BRepAlgoAPI_Algo();"
30
31     Initialize (theAllocator: BaseAllocator from BOPCol) 
32         returns Algo from BRepAlgoAPI;
33
34     ErrorStatus (me)
35         returns Integer from Standard; 
36
37     WarningStatus (me)
38         returns Integer from Standard;
39
40     Allocator(me)
41         returns BaseAllocator from BOPCol;
42     ---C++: return const &
43
44     SetRunParallel(me:out;
45             theFlag:Boolean from Standard);
46     ---Purpose: Set the flag of parallel processing
47     -- if <theFlag> is true  the parallel processing is switched on
48     -- if <theFlag> is false the parallel processing is switched off
49     --
50     RunParallel(me)
51         returns Boolean from Standard;
52     ---Purpose: Returns the flag of parallel processing
53
54     SetProgressIndicator(me:out;
55             theObj: ProgressIndicator from Message);
56     ---Purpose: Set the Progress Indicator object.
57
58     UserBreak(me)
59         is protected;
60     ---Purpose: Breaks the execution if the break signal
61     -- is indicated by myProgressIndicator.
62
63     Shape(me)
64         returns Shape from TopoDS
65         is redefined;
66     ---C++: return const &
67
68 fields 
69     myAllocator     : BaseAllocator from BOPCol is protected;
70     myErrorStatus   : Integer from Standard is protected;
71     myWarningStatus : Integer from Standard is protected;
72     myRunParallel   : Boolean from Standard is protected;
73     myProgressIndicator : ProgressIndicator from Message is protected;
74
75 end Algo;