src/BOPTools/BOPTools_Checker.cdl

   1 -- Created on: 2002-08-05
   2 -- Created by: Peter KURNEV
   3 -- Copyright (c) 2002-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
  22 class Checker from BOPTools inherits PaveFiller from BOPTools
  23
  24         ---Purpose:
  25         --  class that provides the algorithm
  26         --  to  check a shape on self-interference.
  27
  28
  29 uses
  30     ListOfCheckResults from BOPTools,
  31     InterferencePool from BOPTools,
  32     Shape            from TopoDS,
  33     ShapeEnum        from TopAbs,
  34     Geometry         from Geom
  35
  36 is
  37     Create
  38         returns  Checker from BOPTools;
  39         ---Purpose:
  40         --- Empty Contructor
  41         ---
  42     Create (aS:Shape from TopoDS)
  43         returns  Checker from BOPTools;
  44         ---Purpose:
  45         --- Contructs the object using the shape <aS> to check
  46         ---
  47     Create  (aIP: InterferencePool from BOPTools)
  48         returns  Checker from BOPTools;
  49         ---Purpose:
  50         --- Contructs the object using the <InterferencePool>
  51         ---
  52     Destroy (me:out)
  53         is redefined;
  54         ---C++: alias "Standard_EXPORT virtual ~BOPTools_Checker(){Destroy();}"
  55         ---Purpose:
  56         --- Destructor
  57         ---
  58
  59     SetPerformType(me: in out; StopOnFirstFaulty: Boolean from Standard);
  60         ---Purpose: if <StopOnFirstFaulty == Standard_True> the process stops
  61         --          and the exception throws; otherwise all faulties are searched
  62
  63     Perform    (me:out)
  64         is redefined;
  65         ---Purpose:
  66         --- Launches  the  algorithm
  67         ---
  68     SetShape(me:out;
  69         aS:Shape from TopoDS);
  70         ---Purpose:
  71         --- Selector
  72         ---
  73     Shape(me)
  74         returns Shape from TopoDS;
  75         ---C++:return const &
  76         ---Purpose:
  77         --- Selector
  78         ---
  79
  80     GetCheckResult(me)
  81         returns ListOfCheckResults from BOPTools;
  82         ---C++: return const &
  83         ---Purpose: returnes a result of check
  84
  85     HasFaulty(me)
  86         returns Boolean from Standard;
  87         ---Purpose:
  88         --- Selector.
  89         --- Retrns TRUE if there is interferred sub-shapes .
  90         ---
  91     PerformVV  (me:out)
  92         is  redefined protected ;
  93         ---Purpose:
  94         --- See in base classe, please
  95         ---
  96     PerformVE  (me:out)
  97         is  redefined protected ;
  98         ---Purpose:
  99         --- See in base classe, please
 100         ---
 101     PerformVF  (me:out)
 102         is  redefined protected ;
 103         ---Purpose:
 104         --- See in base classe, please
 105         ---
 106     PerformEE  (me:out)
 107         is  redefined protected ;
 108         ---Purpose:
 109         --- See in base classe, please
 110         ---
 111     PerformEF  (me:out)
 112         is  redefined protected ;
 113         ---Purpose:
 114         --- See in base classe, please
 115         ---
 116     PerformFF  (me:out)
 117         is  redefined protected ;
 118         ---Purpose:
 119         --- See in base classe, please
 120         ---
 121     PrepareEdges  (me:out)
 122         is redefined protected ;
 123         ---Purpose:
 124         --- Prepare end paves for each edge
 125         ---
 126     PreparePaveBlocks (me:out;
 127                         aType1: ShapeEnum  from  TopAbs;
 128                         aType2: ShapeEnum  from  TopAbs)
 129         is redefined protected ;
 130         ---Purpose:
 131         --- Internal usage
 132         ---
 133     PreparePaveBlocks (me:out;
 134                        anE:Integer from Standard)
 135         is redefined protected ;
 136         ---Purpose:
 137         --- Prepare end paves for the edge <anE>
 138         ---
 139 fields
 140     myShape        :  Shape              from TopoDS;
 141     myCheckResults :  ListOfCheckResults from BOPTools;
 142     myStopOnFirst  :  Boolean            from Standard;
 143     myEntryType    :  Integer            from Standard;
 144
 145 end Checker;