32f8c742919d41b76d32568a900bf89f15d2e70e
[occt.git] / src / BOPDS / BOPDS_Tools.cdl
1 -- Created by: Peter KURNEV
2 -- Copyright (c) 1999-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
7 -- under the terms of the GNU Lesser General Public 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 Tools from BOPDS 
16
17         ---Purpose: 
18         -- The class BOPDS_Tools contains  
19         -- a set auxiliary static functions  
20         -- of the package BOPDS 
21
22 uses
23     ShapeEnum from TopAbs 
24   
25 --raises
26
27 is 
28     TypeToInteger(myclass; 
29             theT1: ShapeEnum from TopAbs; 
30             theT2: ShapeEnum from TopAbs) 
31         returns Integer from Standard; 
32     ---C++: inline  
33         ---Purpose:  
34         --- Converts the conmbination of two types  
35         --  of shape <theT1>,<theT2>  
36         --- to the one integer value, that is returned       
37   
38     TypeToInteger(myclass; 
39             theT: ShapeEnum from TopAbs) 
40         returns Integer from Standard; 
41     ---C++: inline  
42         ---Purpose:  
43         --- Converts the type of shape <theT>,  
44         --- to integer value, that is returned           
45         
46     HasBRep(myclass; 
47             theT: ShapeEnum from TopAbs) 
48         returns Boolean from Standard;  
49     ---C++: inline  
50         ---Purpose:   
51         --- Returns true if the type  <theT> correspond 
52         --- to a shape having boundary representation 
53   
54     IsInterfering(myclass; 
55             theT: ShapeEnum from TopAbs) 
56         returns Boolean from Standard;   
57     ---C++: inline 
58         ---Purpose: 
59         --- Returns true if the type <theT> can be participant of  
60         --- an interference       
61
62 end Tools;