0024428: Implementation of LGPL license
[occt.git] / src / BRepCheck / BRepCheck_Result.cdl
1 -- Created on: 1995-12-07
2 -- Created by: Jacques GOUSSARD
3 -- Copyright (c) 1995-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
9 -- under the terms of the GNU Lesser General Public 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 deferred class Result from BRepCheck inherits TShared from MMgt
18
19         ---Purpose: 
20
21 uses Shape                                       from TopoDS,
22      ListOfStatus                                from BRepCheck,
23      DataMapOfShapeListOfStatus                  from BRepCheck,
24      DataMapIteratorOfDataMapOfShapeListOfStatus from BRepCheck
25
26 raises NoSuchObject from Standard
27
28 is
29
30     Initialize;
31
32     Init(me: mutable; S: Shape from TopoDS);
33
34
35     InContext(me: mutable; ContextShape: Shape from TopoDS)
36     
37         is deferred;
38
39
40     Minimum(me: mutable)
41     
42         is deferred;
43
44     
45     Blind(me: mutable)
46     
47         is deferred;
48
49     SetFailStatus(me: mutable; S: Shape from TopoDS);
50
51
52     Status(me)
53     
54         returns ListOfStatus from BRepCheck
55         ---C++: return const&
56         ---C++: inline
57         is static;
58
59     IsMinimum(me)
60     
61         returns Boolean from Standard
62         ---C++: inline
63         is static;
64
65
66     IsBlind(me)
67     
68         returns Boolean from Standard
69         ---C++: inline
70         is static;
71
72
73     StatusOnShape(me: mutable; S: Shape from TopoDS)
74         ---Purpose: If  not  already   done,  performs the   InContext
75         --          control and returns the list of status.
76         returns ListOfStatus from BRepCheck
77         ---C++: return const&
78         raises
79             NoSuchObject from Standard
80         is static;
81
82
83     InitContextIterator(me: mutable)
84     
85         is static;
86
87
88     MoreShapeInContext(me)
89     
90         returns Boolean from Standard
91         ---C++: inline
92         is static;
93
94
95     ContextualShape(me)
96     
97         returns Shape from TopoDS
98         ---C++: return const&
99         ---C++: inline
100         raises
101             NoSuchObject from Standard
102         is static;
103
104
105     StatusOnShape(me)
106     
107         returns ListOfStatus from BRepCheck
108         ---C++: return const&
109         ---C++: inline
110         raises
111             NoSuchObject from Standard
112         is static;
113
114
115     NextShapeInContext(me: mutable)
116     
117         is static;
118
119
120 fields
121
122     myShape : Shape                      from TopoDS    is protected;
123     myMin   : Boolean                    from Standard  is protected;
124     myBlind : Boolean                    from Standard  is protected;
125     myMap   : DataMapOfShapeListOfStatus from BRepCheck is protected;
126     myIter  : DataMapIteratorOfDataMapOfShapeListOfStatus from BRepCheck;
127
128 end Result;