0023024: Update headers of OCCT files
[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-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23 class Shell from BRepCheck inherits Result from BRepCheck
24
25         ---Purpose: 
26
27 uses Shape  from TopoDS,
28      Shell  from TopoDS, 
29      ListOfShape from TopTools,
30      IndexedDataMapOfShapeListOfShape  from  TopTools,
31      Status from BRepCheck
32
33 is
34
35     Create(S: Shell from TopoDS)
36     
37         returns mutable Shell from BRepCheck;
38
39
40     InContext(me: mutable; ContextShape: Shape from TopoDS);
41     
42
43
44     Minimum(me: mutable);
45     
46
47     
48     Blind(me: mutable);
49
50
51     Closed(me: mutable; Update: Boolean from Standard = Standard_False)
52         ---Purpose: Checks if the oriented  faces of the shell  give a
53         --          closed shell.    If the  wire is  closed,  returns
54         --          BRepCheck_NoError.If      <Update>     is  set  to
55         --          Standard_True, registers the status in the list.
56         returns Status from BRepCheck
57         is static;
58
59
60     Orientation(me: mutable; Update: Boolean from Standard = Standard_False)
61         ---Purpose: Checks if the   oriented faces  of  the shell  are
62         --          correctly oriented.  An internal  call is  made to
63         --          the  method  Closed.   If  <Update>    is set   to
64         --          Standard_True, registers the status in the list.
65         returns Status from BRepCheck
66         is static;
67
68
69     SetUnorientable(me: mutable)
70     
71         is static;
72
73
74     IsUnorientable(me)
75     
76         returns Boolean from Standard
77         is static;
78
79
80     NbConnectedSet (me: mutable; theSets : in out ListOfShape from TopTools)
81     
82         returns Integer from Standard;
83
84
85 fields
86
87     myNbori : Integer from Standard;
88     myCdone : Boolean from Standard;
89     myCstat : Status  from BRepCheck;
90     myOdone : Boolean from Standard;
91     myOstat : Status  from BRepCheck;
92     myMapEF : IndexedDataMapOfShapeListOfShape  from  TopTools;
93
94 end Shell;