0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BOPAlgo / BOPAlgo_Algo.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 under
10 -- the terms of the GNU Lesser General Public License 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 Algo from BOPAlgo 
19  ---Purpose: provides the root interface for algorithms
20
21 uses  
22     BaseAllocator from BOPCol,
23     ProgressIndicator from Message 
24     
25 --raises
26
27 is
28     Initialize 
29         returns Algo from BOPAlgo;  
30     ---C++: alias "Standard_EXPORT virtual ~BOPAlgo_Algo();"  
31      
32     Initialize (theAllocator: BaseAllocator from BOPCol) 
33         returns Algo from BOPAlgo;
34
35     GetParallelMode(myclass)
36       returns Boolean;
37
38     SetParallelMode(myclass;
39                     theNewMode: Boolean from Standard);
40
41     Perform(me:out) 
42         is deferred;      
43          
44     ErrorStatus (me) 
45         returns Integer from Standard; 
46   
47     WarningStatus (me) 
48         returns Integer from Standard;
49   
50     CheckData(me:out) 
51         is virtual protected;  
52      
53     CheckResult(me:out) 
54         is virtual protected; 
55
56     Allocator(me) 
57         returns BaseAllocator from BOPCol; 
58     ---C++: return const & 
59  
60     SetRunParallel(me:out; 
61             theFlag:Boolean from Standard); 
62     ---Purpose: Set the flag of parallel processing 
63     -- if <theFlag> is true  the parallel processing is switched on   
64     -- if <theFlag> is false the parallel processing is switched off   
65     --      
66     RunParallel(me) 
67         returns Boolean from Standard; 
68     ---Purpose: Returns the flag of parallel processing   
69      
70     SetProgressIndicator(me:out; 
71              theObj: ProgressIndicator from Message); 
72     ---Purpose: Set the Progress Indicator object. 
73                         
74     UserBreak(me) 
75        is protected;  
76     ---Purpose: Breaks the execution if the break signal   
77     -- is indicated by myProgressIndicator. 
78    
79  
80 fields 
81     myAllocator     : BaseAllocator from BOPCol is protected;
82     myErrorStatus   : Integer from Standard is protected;  
83     myWarningStatus : Integer from Standard is protected;  
84     myRunParallel : Boolean from Standard is protected;  
85     myProgressIndicator : ProgressIndicator from Message is protected;  
86     
87 end Algo;