0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BOPAlgo / BOPAlgo_CheckResult.cdl
CommitLineData
b311480e 1-- Created on: 2004-09-03
2-- Created by: Oleg FEDYAEV
973c2be1 3-- Copyright (c) 2004-2014 OPEN CASCADE SAS
b311480e 4--
973c2be1 5-- This file is part of Open CASCADE Technology software library.
b311480e 6--
d5f74e42 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
973c2be1 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.
b311480e 12--
973c2be1 13-- Alternatively, this file may be used under the terms of Open CASCADE
14-- commercial license or contractual agreement.
7fd59977 15
4e57c75e 16class CheckResult from BOPAlgo
7fd59977 17 ---Purpose: contains information about faulty shapes and faulty types
18 --- can't be processed by Boolean Operations
19
20uses
21
4e57c75e 22 Shape from TopoDS,
23 CheckStatus from BOPAlgo,
24 ListOfShape from BOPCol
25
7fd59977 26is
27
28 Create
4e57c75e 29 returns CheckResult;
7fd59977 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);
e98e3990 42 ---Purpose: adds faulty sub-shapes from tool to a list
7fd59977 43
44 GetShape1(me)
4e57c75e 45 returns Shape from TopoDS;
46 ---C++: return const&
47 ---Purpose: returns ancestor shape (object) for faulties
7fd59977 48
49 GetShape2(me)
4e57c75e 50 returns Shape from TopoDS;
51 ---C++: return const&
52 ---Purpose: returns ancestor shape (tool) for faulties
53
7fd59977 54 GetFaultyShapes1(me)
4e57c75e 55 returns ListOfShape from BOPCol;
56 ---C++: return const&
57 ---Purpose: returns list of faulty shapes for object
58
7fd59977 59 GetFaultyShapes2(me)
4e57c75e 60 returns ListOfShape from BOPCol;
61 ---C++: return const&
62 ---Purpose: returns list of faulty shapes for tool
7fd59977 63
4e57c75e 64 SetCheckStatus(me: in out; TheStatus: CheckStatus from BOPAlgo);
7fd59977 65 ---Purpose: set status of faulty
66
67 GetCheckStatus(me)
4e57c75e 68 returns CheckStatus from BOPAlgo;
e98e3990 69 ---Purpose: gets status of faulty
70
71 SetMaxDistance1(me:out;
72 theDist : Real from Standard);
73 ---Purpose: Sets max distance for the first shape
74
75 SetMaxDistance2(me:out;
76 theDist : Real from Standard);
77 ---Purpose: Sets max distance for the second shape
78
79 SetMaxParameter1(me:out;
80 thePar : Real from Standard);
81 ---Purpose: Sets the parameter for the first shape
82
83 SetMaxParameter2(me:out;
84 thePar : Real from Standard);
85 ---Purpose: Sets the parameter for the second shape
86
87 GetMaxDistance1(me)
88 returns Real from Standard;
89 ---Purpose: Returns the distance for the first shape
90
91 GetMaxDistance2(me)
92 returns Real from Standard;
93 ---Purpose: Returns the distance for the second shape
94
95 GetMaxParameter1(me)
96 returns Real from Standard;
97 ---Purpose: Returns the parameter for the fircst shape
98
99 GetMaxParameter2(me)
100 returns Real from Standard;
101 ---Purpose: Returns the parameter for the second shape
4e57c75e 102
7fd59977 103fields
104
105 myShape1 : Shape from TopoDS;
106 myShape2 : Shape from TopoDS;
4e57c75e 107 myStatus : CheckStatus from BOPAlgo;
108 myFaulty1 : ListOfShape from BOPCol;
e98e3990 109 myFaulty2 : ListOfShape from BOPCol;
110 myMaxDist1 : Real from Standard;
111 myMaxDist2 : Real from Standard;
112 myMaxPar1 : Real from Standard;
113 myMaxPar2 : Real from Standard;
7fd59977 114
115end CheckResult;