0023024: Update headers of OCCT files
[occt.git] / src / BOPTColStd / BOPTColStd.cdl
1 -- Created on: 2000-11-22
2 -- Created by: Peter KURNEV
3 -- Copyright (c) 2000-2012 OPEN CASCADE SAS
4 --
5 -- The content of this file is subject to the Open CASCADE Technology Public
6 -- License Version 6.5 (the "License"). You may not use the content of this file
7 -- except in compliance with the License. Please obtain a copy of the License
8 -- at http://www.opencascade.org and read it completely before using this file.
9 --
10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 --
13 -- The Original Code and all software distributed under the License is
14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
15 -- Initial Developer hereby disclaims all such warranties, including without
16 -- limitation, any warranties of merchantability, fitness for a particular
17 -- purpose or non-infringement. Please see the License for the specific terms
18 -- and conditions governing the rights and limitations under the License.
19
20
21 package BOPTColStd 
22      
23     ---Purpose: 
24      ---         Contains auxiliary classes used  by   
25     ---          boolean  operations algorithm.  
26     
27 uses  
28     gp,   
29     TopoDS,  
30     TopTools,
31     TCollection, 
32     TColStd  
33 ---
34 is    
35
36     generic class CArray1;
37     ---Purpose:  
38     --  The class represents unidimensionnal arrays
39     --  of fixed size known at run time.  
40     --  Run-time boundary check is performed
41     --  The range of the index is user defined from 0 to Length-1 
42     --
43     class  Dump; 
44     --  The class provides dump service used for debugging   
45     --  purposes 
46     --  
47     class Failure;       
48     --  The class provides exception objects 
49     --  
50     class ShapeWithRank;                 
51     --  The auxiliary class provides structure to store a shape 
52     --  and its rank 
53     ---     
54     class ShapeWithRankHasher; 
55     --  The auxiliary class provides hash code for mapping 
56     --  ShapeWithRank objects 
57     ---   
58     ---
59     ---                 I  n  s  t  a  n  t  i  a  t  i  o  n  s  
60     ---       
61     class  CArray1OfInteger  instantiates  
62         CArray1 from BOPTColStd(Integer from Standard);  
63          
64     class CArray1OfShape instantiates  
65         CArray1 from BOPTColStd(Shape from TopoDS);  
66          
67     class CArray1OfPnt2d instantiates  
68         CArray1 from BOPTColStd(Pnt2d from gp);   
69      
70     class  IndexedDataMapOfIntegerInteger  instantiates 
71         IndexedDataMap from TCollection  (Integer, 
72                                           Integer,  
73                                           MapIntegerHasher from TColStd);  
74     class  ListOfListOfShape instantiates 
75         List from TCollection (ListOfShape from TopTools);
76
77     class  IndexedDataMapOfIntegerIndexedMapOfInteger  instantiates 
78         IndexedDataMap from TCollection  (Integer, 
79                                           IndexedMapOfInteger from TColStd,    
80                                           MapIntegerHasher from TColStd); 
81
82     class  IndexedDataMapOfSWRInteger instantiates 
83         IndexedDataMap from TCollection  (ShapeWithRank, 
84                                           Integer from Standard,    
85                                           ShapeWithRankHasher from BOPTColStd);
86     
87     
88      
89
90 end  BOPTColStd;