src/BOP/BOP_CheckResult.cdl

   1 -- Created on: 2004-09-03
   2 -- Created by: Oleg FEDYAEV
   3 -- Copyright (c) 2004-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21 class CheckResult from BOP
  22     ---Purpose: contains information about faulty shapes and faulty types
  23     ---         can't be processed by Boolean Operations
  24
  25 uses
  26
  27     Shape       from TopoDS,
  28     ListOfShape from TopTools,
  29     CheckStatus from BOP
  30
  31 is
  32
  33     Create
  34         returns CheckResult;
  35     ---Purpose: empty constructor
  36
  37     SetShape1(me: in out; TheShape : Shape from TopoDS);
  38     ---Purpose: sets ancestor shape (object) for faulty sub-shapes
  39
  40     AddFaultyShape1(me: in out; TheShape: Shape from TopoDS);
  41     ---Purpose: adds faulty sub-shapes from object to a list
  42
  43     SetShape2(me: in out; TheShape: Shape from TopoDS);
  44     ---Purpose: sets ancestor shape (tool) for faulty sub-shapes
  45
  46     AddFaultyShape2(me: in out; TheShape: Shape from TopoDS);
  47     ---Purpose: adds faulty sub-shapes from tool to a list
  48
  49     GetShape1(me)
  50         returns Shape from TopoDS;
  51         ---C++: return const &
  52         ---Purpose: returns ancestor shape (object) for faulties
  53
  54     GetShape2(me)
  55         returns Shape from TopoDS;
  56         ---C++: return const &
  57         ---Purpose: returns ancestor shape (tool) for faulties
  58
  59     GetFaultyShapes1(me)
  60         returns ListOfShape from TopTools;
  61         ---C++: return const &
  62         ---Purpose: returns list of faulty shapes for object
  63
  64     GetFaultyShapes2(me)
  65         returns ListOfShape from TopTools;
  66         ---C++: return const &
  67         ---Purpose: returns list of faulty shapes for tool
  68
  69     SetCheckStatus(me: in out; TheStatus: CheckStatus from BOP);
  70     ---Purpose: set status of faulty
  71
  72     GetCheckStatus(me)
  73         returns CheckStatus from BOP;
  74         ---Purpose: gets status of faulty
  75
  76 fields
  77
  78     myShape1 : Shape from TopoDS;
  79     myShape2 : Shape from TopoDS;
  80     myStatus : CheckStatus from BOP;
  81     myFaulty1 : ListOfShape from TopTools;
  82     myFaulty2 : ListOfShape from TopTools;
  83
  84 end CheckResult;