0024624: Lost word in license statement in source files
[occt.git] / src / BOPAlgo / BOPAlgo_CheckResult.cdl
1 -- Created on: 2004-09-03
2 -- Created by: Oleg FEDYAEV
3 -- Copyright (c) 2004-2014 OPEN CASCADE SAS
4 --
5 -- This file is part of Open CASCADE Technology software library.
6 --
7 -- This library is free software; you can redistribute it and/or modify it under
8 -- the terms of the GNU Lesser General Public License version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
12 --
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
15
16 class CheckResult from BOPAlgo
17     ---Purpose: contains information about faulty shapes and faulty types
18     ---         can't be processed by Boolean Operations
19
20 uses
21
22     Shape       from TopoDS, 
23     CheckStatus from BOPAlgo,
24     ListOfShape from BOPCol
25     
26 is
27
28     Create
29     returns CheckResult;
30     ---Purpose: empty constructor
31     
32     SetShape1(me: in out; TheShape : Shape from TopoDS);
33     ---Purpose: sets ancestor shape (object) for faulty sub-shapes
34     
35     AddFaultyShape1(me: in out; TheShape: Shape from TopoDS);
36     ---Purpose: adds faulty sub-shapes from object to a list
37     
38     SetShape2(me: in out; TheShape: Shape from TopoDS);
39     ---Purpose: sets ancestor shape (tool) for faulty sub-shapes
40     
41     AddFaultyShape2(me: in out; TheShape: Shape from TopoDS);
42     ---Purpose: adds faulty sub-shapes from tool to a list
43     
44     GetShape1(me)
45     returns Shape from TopoDS;
46     ---C++: return const&
47     ---Purpose: returns ancestor shape (object) for faulties
48
49     GetShape2(me)
50     returns Shape from TopoDS;
51     ---C++: return const&
52     ---Purpose: returns ancestor shape (tool) for faulties
53
54     GetFaultyShapes1(me)
55     returns ListOfShape from BOPCol;
56     ---C++: return const&
57     ---Purpose: returns list of faulty shapes for object
58
59     GetFaultyShapes2(me)
60     returns ListOfShape from BOPCol;
61     ---C++: return const&
62     ---Purpose: returns list of faulty shapes for tool
63
64     SetCheckStatus(me: in out; TheStatus: CheckStatus from BOPAlgo);
65     ---Purpose: set status of faulty
66     
67     GetCheckStatus(me)
68     returns CheckStatus from BOPAlgo;
69     ---Purpose: gets status of faulty
70   
71 fields
72
73     myShape1 : Shape from TopoDS;
74     myShape2 : Shape from TopoDS;
75     myStatus : CheckStatus from BOPAlgo;
76     myFaulty1 : ListOfShape from BOPCol;
77     myFaulty2 : ListOfShape from BOPCol;
78
79 end CheckResult;