src/BOPTools/BOPTools_CheckResult.cdl

   1 -- Created on: 2004-09-02
   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 BOPTools
  22     ---Purpose: contains information about faulty shapes
  23     --          and faulty types
  24 uses
  25
  26     Shape       from TopoDS,
  27     ListOfShape from TopTools,
  28     CheckStatus from BOPTools,
  29     Geometry    from Geom
  30
  31 is
  32
  33     Create
  34         returns CheckResult;
  35     ---Purpose: empty constructor
  36
  37     AddShape(me: in out; TheShape: Shape from TopoDS);
  38     ---Purpose: adds a shape with faulty to a list
  39
  40     GetShapes(me)
  41         returns ListOfShape from TopTools;
  42     ---C++: return const &
  43     ---Purpose: gets access to faulty shapes in a list const
  44
  45     SetCheckStatus(me:in out; TheStatus: CheckStatus from BOPTools);
  46     ---Purpose: sets faulty status for shapes
  47
  48     GetCheckStatus(me)
  49         returns  CheckStatus from BOPTools;
  50     ---Purpose: gets faulty status for shapes
  51
  52     SetInterferenceGeometry(me: in out; TheGeometry: Geometry from Geom);
  53     ---Purpose: sets an attached geometry to faulty shapes if any
  54
  55     GetInterferenceGeometry(me)
  56         returns Geometry from Geom;
  57     ---C++: return const &
  58     ---Purpose: gets an attached geometry to shapes if any
  59
  60 fields
  61
  62     myStatus   : CheckStatus from BOPTools;
  63     myShapes   : ListOfShape from TopTools;
  64     myGeometry : Geometry    from Geom;
  65
  66 end CheckResult;