0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_WireSplitter.cdl
CommitLineData
b311480e 1-- Created on: 2001-04-09
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 WireSplitter from BOP
23
24 ---Purpose:
25 --- the algorithm to split multiconnexed
26 --- wires on a face onto biconnexed ones
27 --- .
28uses
29 Face from TopoDS,
30 Vertex from TopoDS,
31 Edge from TopoDS,
32
33 SequenceOfPnt2d from TColgp,
34 SequenceOfShape from TopTools,
35 ListOfShape from TopTools,
36
37 ListOfListOfShape from BOPTColStd,
38
39 EdgeInfo from BOP,
40 IndexedDataMapOfVertexListEdgeInfo from BOP
41
42--raises
43
44is
45 Create
46 returns WireSplitter from BOP;
47 ---C++: inline
48 ---Purpose:
49 --- Empty constructor;
50 ---
51 SetFace (me:out;
52 aF: Face from TopoDS);
53 ---C++: inline
54 ---Purpose:
55 --- Modifier
56 ---
57 DoWithListOfEdges(me:out;
58 aLE:ListOfShape from TopTools);
59 ---Purpose:
60 --- Perform the algorithm using the list of shapes <aLE> as data
61 ---
62 DoWithFace (me:out);
63 ---Purpose:
64 --- Perform the algorithm using the face as data
65 ---
66 Do (me:out)
67 is private;
68 ---Purpose:
69 --- Perform the algorithm
70 ---
71 IsNothingToDo (me)
72 returns Boolean from Standard;
73 ---C++: inline
74 ---Purpose:
75 --- Returns TRUE if the source wire is biconnexed and
76 --- there is nothing to correct
77 ---
78 IsDone (me)
79 returns Boolean from Standard;
80 ---C++: inline
81 ---Purpose:
82 --- Returns TRUE if the algorithm was performed
83 --- successfuly
84 ---
85 Face (me)
86 returns Face from TopoDS;
87 ---C++: return const &
88 ---C++: inline
89 ---Purpose:
90 --- Selector
91 ---
92 Shapes (me)
93 returns ListOfListOfShape from BOPTColStd;
94 ---C++: return const &
95 ---C++: inline
96 ---Purpose:
97 --- Selector
98 ---
99
100
101fields
102
103 myFace : Face from TopoDS;
104 myIsDone : Boolean from Standard;
105 myNothingToDo: Boolean from Standard;
106 myShapes : ListOfListOfShape from BOPTColStd;
107 mySmartMap : IndexedDataMapOfVertexListEdgeInfo from BOP;
108 myEdges : ListOfShape from TopTools;
109
110end WireSplitter;