74e7e0bc861ff7d318216f63236e2e4300cf3294
[occt.git] / src / BOPTools / BOPTools_CommonBlock.cdl
1 -- File:        BOPTools_CommonBlock.cdl
2 -- Created:     Thu Feb 15 12:03:13 2001
3 -- Author:      Peter KURNEV
4 --              <pkv@irinox>
5 ---Copyright:    Matra Datavision 2001
6
7
8 class CommonBlock from BOPTools 
9
10         ---Purpose:  
11         --  The class hold a structure  for storing info about a couple  
12         --  of pave blocks that are considered as common
13
14 uses
15     PaveBlock from BOPTools
16
17
18 is 
19     Create  
20         returns CommonBlock from BOPTools; 
21         ---Purpose: 
22         --- Empty constructor 
23         ---
24     Create (aPB1:PaveBlock from BOPTools; 
25             aPB2:PaveBlock from BOPTools); 
26         ---Purpose:  
27         --- Constructor that uses couple of pave blocks
28         ---
29     Create (aPB1:PaveBlock from BOPTools; 
30             aF:Integer from  Standard); 
31         ---Purpose:  
32         --- Constructor that uses a pave block and a face  
33         ---
34     SetPaveBlock1  (me:out;  aPB1:PaveBlock from BOPTools);          
35         ---Purpose:  
36         --- Modifier  
37         --- Sets first block 
38         ---
39     SetPaveBlock2  (me:out;  aPB2:PaveBlock from BOPTools);          
40         ---Purpose:  
41         --- Modifier  
42         --- Sets second block  
43         ---
44     SetFace  (me:out; aF: Integer from Standard);
45         ---Purpose:  
46         --- Modifier  
47         --- Sets DS-index of the face (if it exists) with which the  
48         --- CommonBlock is common. 0 is  default value   
49         ---
50     PaveBlock1  (me) 
51         returns  PaveBlock from BOPTools; 
52         ---C++:  return const &          
53         ---Purpose:  
54         --- Selector  
55         --- Always returns first block myPB1    
56         ---
57     PaveBlock1  (me:out; anIndex: Integer from  Standard) 
58         returns  PaveBlock from BOPTools; 
59         ---C++:  return  &       
60         ---Purpose:  
61         --- Selector  
62         --- Returns block that belongs to the original edge with 
63         --- DS-index=anIndex    
64         ---
65     PaveBlock2  (me) 
66         returns  PaveBlock from BOPTools; 
67         ---C++:  return const  &        
68         ---Purpose:  
69         --- Selector  
70         --- Always returns first block myPB2  
71         ---
72     PaveBlock2  (me:out; anIndex: Integer from  Standard)  
73         returns  PaveBlock from BOPTools; 
74         ---C++:  return &        
75         ---Purpose:  
76         --- Selector  
77         --- Returns block that does not belong to the original edge with 
78         --- DS-index=anIndex    
79         ---
80     Face(me) 
81         returns Integer from  Standard; 
82         ---Purpose:  
83         --- Selector
84         --- Returns  the DS-index of the face (if exists)  
85         --- with which the CommonBlock is common.   
86         --- Otherwise it returns 0.
87         ---
88
89 fields
90     myPB1  : PaveBlock from BOPTools;  
91     myPB2  : PaveBlock from BOPTools; 
92     myFace : Integer   from Standard; 
93       
94 end CommonBlock;