0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepAlgoAPI / BRepAlgoAPI_Algo.cdl
CommitLineData
b1d15f53 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
15deferred class Algo from BRepAlgoAPI
16 inherits MakeShape from BRepBuilderAPI
17 ---Purpose: provides the root interface for algorithms
18
19uses
20 BaseAllocator from BOPCol,
21 ProgressIndicator from Message,
22 Shape from TopoDS
23
24--raises
25
26is
27 Initialize
28 returns Algo from BRepAlgoAPI;
29 ---C++: alias "Standard_EXPORT virtual ~BRepAlgoAPI_Algo();"
49b0c452 30 ---Purpose: Empty constructor
31
b1d15f53 32 Initialize (theAllocator: BaseAllocator from BOPCol)
33 returns Algo from BRepAlgoAPI;
49b0c452 34 ---Purpose: Empty constructor
35
b1d15f53 36 ErrorStatus (me)
37 returns Integer from Standard;
49b0c452 38 ---Purpose: Returns error status of the algorithm
39 -- ==0 - no errors occured
40 -- !=0 - is in the event of various error conditions
41
b1d15f53 42 WarningStatus (me)
43 returns Integer from Standard;
49b0c452 44 ---Purpose: Returns warning status of the algorithm
45 -- ==0 - no warning occured
46 -- !=0 - is in the event of various warning conditions
47
b1d15f53 48 Allocator(me)
49 returns BaseAllocator from BOPCol;
50 ---C++: return const &
51
52 SetRunParallel(me:out;
53 theFlag:Boolean from Standard);
54 ---Purpose: Set the flag of parallel processing
55 -- if <theFlag> is true the parallel processing is switched on
56 -- if <theFlag> is false the parallel processing is switched off
57 --
58 RunParallel(me)
59 returns Boolean from Standard;
60 ---Purpose: Returns the flag of parallel processing
61
62 SetProgressIndicator(me:out;
63 theObj: ProgressIndicator from Message);
64 ---Purpose: Set the Progress Indicator object.
65
66 UserBreak(me)
67 is protected;
68 ---Purpose: Breaks the execution if the break signal
69 -- is indicated by myProgressIndicator.
70
71 Shape(me)
72 returns Shape from TopoDS
73 is redefined;
49b0c452 74 ---C++: return const &
75
76 Clear(me:out)
77 is virtual protected;
78
b1d15f53 79fields
80 myAllocator : BaseAllocator from BOPCol is protected;
81 myErrorStatus : Integer from Standard is protected;
82 myWarningStatus : Integer from Standard is protected;
83 myRunParallel : Boolean from Standard is protected;
84 myProgressIndicator : ProgressIndicator from Message is protected;
85
86end Algo;