0023024: Update headers of OCCT files
[occt.git] / src / BOPTools / BOPTools_CommonBlock.cdl
CommitLineData
b311480e 1-- Created on: 2001-02-15
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
7fd59977 20
21
22class CommonBlock from BOPTools
23
24 ---Purpose:
25 -- The class hold a structure for storing info about a couple
26 -- of pave blocks that are considered as common
27
28uses
29 PaveBlock from BOPTools
30
31
32is
33 Create
34 returns CommonBlock from BOPTools;
35 ---Purpose:
36 --- Empty constructor
37 ---
38 Create (aPB1:PaveBlock from BOPTools;
39 aPB2:PaveBlock from BOPTools);
40 ---Purpose:
41 --- Constructor that uses couple of pave blocks
42 ---
43 Create (aPB1:PaveBlock from BOPTools;
44 aF:Integer from Standard);
45 ---Purpose:
46 --- Constructor that uses a pave block and a face
47 ---
48 SetPaveBlock1 (me:out; aPB1:PaveBlock from BOPTools);
49 ---Purpose:
50 --- Modifier
51 --- Sets first block
52 ---
53 SetPaveBlock2 (me:out; aPB2:PaveBlock from BOPTools);
54 ---Purpose:
55 --- Modifier
56 --- Sets second block
57 ---
58 SetFace (me:out; aF: Integer from Standard);
59 ---Purpose:
60 --- Modifier
61 --- Sets DS-index of the face (if it exists) with which the
62 --- CommonBlock is common. 0 is default value
63 ---
64 PaveBlock1 (me)
65 returns PaveBlock from BOPTools;
66 ---C++: return const &
67 ---Purpose:
68 --- Selector
69 --- Always returns first block myPB1
70 ---
71 PaveBlock1 (me:out; anIndex: Integer from Standard)
72 returns PaveBlock from BOPTools;
73 ---C++: return &
74 ---Purpose:
75 --- Selector
76 --- Returns block that belongs to the original edge with
77 --- DS-index=anIndex
78 ---
79 PaveBlock2 (me)
80 returns PaveBlock from BOPTools;
81 ---C++: return const &
82 ---Purpose:
83 --- Selector
84 --- Always returns first block myPB2
85 ---
86 PaveBlock2 (me:out; anIndex: Integer from Standard)
87 returns PaveBlock from BOPTools;
88 ---C++: return &
89 ---Purpose:
90 --- Selector
91 --- Returns block that does not belong to the original edge with
92 --- DS-index=anIndex
93 ---
94 Face(me)
95 returns Integer from Standard;
96 ---Purpose:
97 --- Selector
98 --- Returns the DS-index of the face (if exists)
99 --- with which the CommonBlock is common.
100 --- Otherwise it returns 0.
101 ---
102
103fields
104 myPB1 : PaveBlock from BOPTools;
105 myPB2 : PaveBlock from BOPTools;
106 myFace : Integer from Standard;
107
108end CommonBlock;