0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepAlgo / BRepAlgo_EdgeConnector.cdl
CommitLineData
b311480e 1-- Created on: 1997-08-22
2-- Created by: Prestataire Mary FABIEN
3-- Copyright (c) 1997-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 8-- This library is free software; you can redistribute it and/or modify it under
9-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 10-- by the Free Software Foundation, with special exception defined in the file
11-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12-- distribution for complete text of the license and disclaimer of any warranty.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class EdgeConnector from BRepAlgo inherits TShared from MMgt
18
19 ---Purpose: Used by DSAccess to reconstruct an EdgeSet of connected edges. The result produced by
20 -- MakeBlock is a list of non-standard TopoDS_wire,
21 -- which can present connexions of edge of order > 2
22 -- in certain vertex. The method IsWire
23 -- indicates standard/non-standard character of all wire produced.
24
25uses
26
27 ListOfShape from TopTools,
28 MapOfShape from TopTools,
29 Shape from TopoDS,
30 Edge from TopoDS,
31 HDataStructure from TopOpeBRepDS,
32 ShapeSet from TopOpeBRepBuild,
33 BlockBuilder from TopOpeBRepBuild,
34 DataMapOfShapeBoolean from BRepAlgo
35
36is
37
38 Create returns EdgeConnector from BRepAlgo;
39
40 Add(me : mutable; e : Edge from TopoDS);
41 ---Purpose:
42
43 Add(me : mutable; LOEdge : in out ListOfShape from TopTools);
44 ---Purpose:
45
46 AddStart(me : mutable; e : Shape from TopoDS);
47 ---Purpose:
48
49 AddStart(me : mutable; LOEdge : in out ListOfShape from TopTools);
50 ---Purpose:
51
52 ClearStartElement(me : mutable);
53
54 MakeBlock(me : mutable)
55 ---Purpose: returns a list of wire non standard
56 ---C++: return &
57 returns ListOfShape from TopTools;
58
59 Done(me : mutable);
60
61 IsDone(me)
62 ---Purpose: NYI
63 ---Purpose: returns true if proceeded to MakeBlock()
64 returns Boolean from Standard;
65
66 IsWire(me : mutable; W : Shape from TopoDS)
67 ---Purpose: NYI
68 ---Purpose: returns true if W is a Wire standard.
69 -- W must belong to the list returned by MakeBlock.
70 returns Boolean from Standard;
71
72fields
73
74 myListeOfEdge : ListOfShape from TopTools;
75 myListeOfStartEdge : ListOfShape from TopTools;
76 myResultMap : DataMapOfShapeBoolean from BRepAlgo;
77 myResultList : ListOfShape from TopTools;
78 myBlockB : BlockBuilder from TopOpeBRepBuild;
79 myIsDone : Boolean from Standard;
80
81end EdgeConnector from BRepAlgo;