0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_ConnexityBlock.cdl
1 -- Created on: 2001-04-13
2 -- Created by: Peter KURNEV
3 -- Copyright (c) 2001-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
22 class ConnexityBlock from BOP 
23
24         ---Purpose: 
25         ---  Auxiliary class to store data about set  
26         ---  of connex shapes 
27         --- 
28         
29 uses
30     ListOfShape               from TopTools,
31     IndexedMapOfOrientedShape from TopTools
32
33 is 
34     Create
35         returns ConnexityBlock from BOP; 
36         ---Purpose:  
37         --- Empty constructor; 
38         ---
39     SetShapes    (me:out; 
40         anEdges: ListOfShape from TopTools); 
41         ---Purpose:  
42         --- Modifier
43         ---
44     SetShapes    (me:out; 
45         nEdges: IndexedMapOfOrientedShape from TopTools); 
46         ---Purpose:  
47         --- Modifier
48         ---
49     SetRegularity(me:out;  
50                    aFlag:Boolean from Standard);                    
51         ---Purpose:  
52         --- Modifier
53         ---
54     Shapes  (me) 
55         returns ListOfShape from TopTools; 
56         ---C++:  return const &  
57         ---Purpose:  
58         --- Selector
59         ---
60     IsRegular(me) 
61         returns Boolean from Standard;  
62         ---Purpose:  
63         --- Selector 
64         --- Returns TRUE if all elements in the block are 
65         --- biconnexity         
66         ---
67     
68 fields
69     
70     myRegularity  :  Boolean from Standard;  
71     myShapes      :  ListOfShape from TopTools; 
72
73 end ConnexityBlock;