0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_ArgumentAnalyzer.cdl
CommitLineData
b311480e 1-- Created on: 2004-09-03
2-- Created by: Oleg FEDYAEV
3-- Copyright (c) 2004-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
21class ArgumentAnalyzer from BOP
22 ---Purpose: check the validity of argument(s) for Boolean Operations
23
24uses
25 Shape from TopoDS,
26 Operation from BOP,
27 CheckStatus from BOP,
28 Operation from BOP,
29 ShapeEnum from TopAbs,
30 ListOfCheckResult from BOP
31
32is
33 Create
34 returns ArgumentAnalyzer;
35 ---Purpose: empty constructor
36
37 SetShape1(me: in out; TheShape: Shape from TopoDS);
38 ---Purpose: sets object shape
39
40 SetShape2(me: in out; TheShape: Shape from TopoDS);
41 ---Purpose: sets tool shape
42
43 GetShape1(me)
44 returns Shape from TopoDS;
45 ---C++: return const &
46 ---Purpose: returns object shape;
47
48 GetShape2(me)
49 returns Shape from TopoDS;
50 ---C++: return const &
51 ---Purpose: returns tool shape
52
53 --modified by NIZHNY-MKK Fri Sep 3 17:14:55 2004.BEGIN
54 ---options
55 OperationType(me: in out)
56 returns Operation from BOP;
57 ---C++: return &
58 ---Purpose: returns ref
59
60 StopOnFirstFaulty(me: in out)
61 returns Boolean from Standard;
62 ---C++: return &
63 ---Purpose: returns ref
64
65 ArgumentTypeMode(me: in out)
66 returns Boolean from Standard;
67 ---C++: return &
68 ---C++: inline
69 ---Purpose: Returns (modifiable) mode
70 -- that means checking types of shapes.
71
72 SelfInterMode(me: in out)
73 returns Boolean from Standard;
74 ---C++: return &
75 ---C++: inline
76 ---Purpose: Returns (modifiable) mode that means
77 -- checking of self-intersection of shapes.
78
79 SmallEdgeMode(me: in out)
80 returns Boolean from Standard;
81 ---C++: return &
82 ---C++: inline
83 ---Purpose: Returns (modifiable) mode that means
84 -- checking of small edges.
85
86 RebuildFaceMode(me: in out)
87 returns Boolean from Standard;
88 ---C++: return &
89 ---C++: inline
90 ---Purpose: Returns (modifiable) mode that means
91 -- checking of possibility to split or rebuild faces.
92
93 TangentMode(me: in out)
94 returns Boolean from Standard;
95 ---C++: return &
96 ---C++: inline
97 ---Purpose: Returns (modifiable) mode that means
98 -- checking of tangency between subshapes.
99
100 MergeVertexMode(me: in out)
101 returns Boolean from Standard;
102 ---C++: return &
103 ---C++: inline
104 ---Purpose: Returns (modifiable) mode that means
105 -- checking of problem of merging vertices.
106
107 MergeEdgeMode(me: in out)
108 returns Boolean from Standard;
109 ---C++: return &
110 ---C++: inline
111 ---Purpose: Returns (modifiable) mode that means
112 -- checking of problem of merging edges.
113
114-- MergeFaceMode(me: in out)
115-- returns Boolean from Standard;
116-- ---C++: return &
117-- ---C++: inline
118-- ---Purpose: Returns (modifiable) mode that means
119-- -- checking of problem of merging faces.
120
121 --modified by NIZHNY-MKK Fri Sep 3 17:15:02 2004.END
122
123 ---
124 Perform(me: out);
125 ---Purpose: performs analysis
126
127 HasFaulty(me)
128 returns Boolean from Standard;
129 ---Purpose: result of test
130
131 GetCheckResult(me)
132 returns ListOfCheckResult from BOP;
133 ---C++: return const &
134 ---Purpose: returns a result of test
135
136 --- protected
137 TestTypes(me: out)
138 is protected;
139
140 TestSelfInterferences(me: out)
141 is protected;
142
143 TestSmallEdge(me: out)
144 is protected;
145
146 TestRebuildFace(me: out)
147 is protected;
148
149 TestTangent(me: out)
150 is protected;
151
152 TestMergeSubShapes(me: out; theType: ShapeEnum from TopAbs)
153 is protected;
154
155 TestMergeVertex(me: out)
156 is protected;
157
158 TestMergeEdge(me: out)
159 is protected;
160
161-- TestMergeFace(me: out)
162-- is protected;
163
164
165fields
166
167 myShape1 : Shape from TopoDS;
168 myShape2 : Shape from TopoDS;
169 myStopOnFirst : Boolean from Standard;
170 --modified by NIZHNY-MKK Fri Sep 3 17:08:38 2004.BEGIN
171 myOperation : Operation from BOP;
172 myArgumentTypeMode : Boolean from Standard;
173 mySelfInterMode : Boolean from Standard;
174 mySmallEdgeMode : Boolean from Standard;
175 myRebuildFaceMode: Boolean from Standard;
176 myTangentMode : Boolean from Standard;
177 myMergeVertexMode: Boolean from Standard;
178 myMergeEdgeMode : Boolean from Standard;
179-- myMergeFaceMode : Boolean from Standard;
180
181 --modified by NIZHNY-MKK Fri Sep 3 17:08:41 2004.END
182 myResult : ListOfCheckResult from BOP;
183
184end ArgumentAnalyzer;