0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BOPAlgo / BOPAlgo_CheckerSI.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 --
19 class CheckerSI from BOPAlgo 
20     inherits PaveFiller from BOPAlgo  
21     
22     ---Purpose: Checks shape on self-interference.
23  
24 uses   
25     DataMapOfShapeShape from BOPCol  
26     
27 is
28     Create 
29      returns CheckerSI from BOPAlgo;  
30     ---C++: alias "Standard_EXPORT virtual ~BOPAlgo_CheckerSI();"  
31     
32
33     Perform(me:out) 
34      is redefined;   
35   
36
37     Init  (me:out) 
38      is redefined protected;
39
40     SetLevelOfCheck(me:out; 
41       theLevel: Integer from Standard); 
42     ---Purpose:  Sets the level of checking shape on self-interference.
43     --           It defines which interferferences will be checked: 
44     --           0 - only V/V; 
45     --           1 - V/V and V/E; 
46     --           2 - V/V, V/E and E/E; 
47     --           3 - V/V, V/E, E/E and V/F;
48     --           4 - V/V, V/E, E/E, V/F and E/F; 
49     --           5 - all interferences, default value. 
50  
51     SetNonDestructive(me:out; 
52       theFlag: Boolean from Standard);  
53     ---Purpose: Sets the flag <theFlag> that defines 
54     --  the mode of the treatment: 
55     --  the copy of the argument when theFlag is true             
56     --  the argument itself  when theFlag is false 
57      
58     NonDestructive(me) 
59         returns Boolean from Standard; 
60     ---Purpose: Returns the flag that defines the 
61     --  mode of the treatment: 
62     --  true when the copy of the argument is used            
63     --  false when the argument itself  is used
64  
65     PostTreat  (me:out)  
66      is protected;       
67     ---Purpose: Provides post-treatment actions   
68  
69     PrepareCopy(me:out) 
70       is virtual protected;  
71      
72     PostTreatCopy (me:out)  
73      is protected;       
74     ---Purpose: Provides post-treatment actions for the copy  
75
76  
77 fields
78     myLevelOfCheck: Integer from Standard is protected;
79     myNonDestructive: Boolean from Standard is protected; 
80     myNewOldMap   : DataMapOfShapeShape from BOPCol is protected;   
81     
82 end CheckerSI;