0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepCheck / BRepCheck_Shell.cdl
1 -- Created on: 1996-01-02
2 -- Created by: Jacques GOUSSARD
3 -- Copyright (c) 1996-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
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
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.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class Shell from BRepCheck inherits Result from BRepCheck
18
19         ---Purpose: 
20
21 uses Shape  from TopoDS,
22      Shell  from TopoDS, 
23      ListOfShape from TopTools,
24      IndexedDataMapOfShapeListOfShape  from  TopTools,
25      Status from BRepCheck
26
27 is
28
29     Create(S: Shell from TopoDS)
30     
31         returns Shell from BRepCheck;
32
33
34     InContext(me: mutable; ContextShape: Shape from TopoDS);
35     
36
37
38     Minimum(me: mutable);
39     
40
41     
42     Blind(me: mutable);
43
44
45     Closed(me: mutable; Update: Boolean from Standard = Standard_False)
46         ---Purpose: Checks if the oriented  faces of the shell  give a
47         --          closed shell.    If the  wire is  closed,  returns
48         --          BRepCheck_NoError.If      <Update>     is  set  to
49         --          Standard_True, registers the status in the list.
50         returns Status from BRepCheck
51         is static;
52
53
54     Orientation(me: mutable; Update: Boolean from Standard = Standard_False)
55         ---Purpose: Checks if the   oriented faces  of  the shell  are
56         --          correctly oriented.  An internal  call is  made to
57         --          the  method  Closed.   If  <Update>    is set   to
58         --          Standard_True, registers the status in the list.
59         returns Status from BRepCheck
60         is static;
61
62
63     SetUnorientable(me: mutable)
64     
65         is static;
66
67
68     IsUnorientable(me)
69     
70         returns Boolean from Standard
71         is static;
72
73
74     NbConnectedSet (me: mutable; theSets : in out ListOfShape from TopTools)
75     
76         returns Integer from Standard;
77
78
79 fields
80
81     myNbori : Integer from Standard;
82     myCdone : Boolean from Standard;
83     myCstat : Status  from BRepCheck;
84     myOdone : Boolean from Standard;
85     myOstat : Status  from BRepCheck;
86     myMapEF : IndexedDataMapOfShapeListOfShape  from  TopTools;
87
88 end Shell;