0023024: Update headers of OCCT files

[occt.git] / src / BOPTools / BOPTools_Checker.cdl

-- Created on: 2002-08-05
-- Created by: Peter KURNEV
-- Copyright (c) 2002-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.



class Checker from BOPTools inherits PaveFiller from BOPTools

	---Purpose: 
    	--  class that provides the algorithm 
    	--  to  check a shape on self-interference. 
        	 

uses
    ListOfCheckResults from BOPTools, 
    InterferencePool from BOPTools, 
    Shape            from TopoDS,	     
    ShapeEnum        from TopAbs, 
    Geometry         from Geom

is  
    Create 
	returns  Checker from BOPTools;  
    	---Purpose:  
    	--- Empty Contructor  
    	---
    Create (aS:Shape from TopoDS)    
    	returns  Checker from BOPTools; 
    	---Purpose:  
    	--- Contructs the object using the shape <aS> to check 
    	---
    Create  (aIP: InterferencePool from BOPTools) 
    	returns  Checker from BOPTools;
    	---Purpose: 
    	--- Contructs the object using the <InterferencePool> 
    	---
    Destroy (me:out) 
    	is redefined;
    	---C++: alias "Standard_EXPORT virtual ~BOPTools_Checker(){Destroy();}"  
    	---Purpose:  
    	--- Destructor  
    	---

    SetPerformType(me: in out; StopOnFirstFaulty: Boolean from Standard);
    	---Purpose: if <StopOnFirstFaulty == Standard_True> the process stops
    	--          and the exception throws; otherwise all faulties are searched

    Perform    (me:out)   
    	is redefined; 
    	---Purpose:  
    	--- Launches  the  algorithm 
    	---
    SetShape(me:out; 
    	aS:Shape from TopoDS); 
    	---Purpose:  
    	--- Selector 
    	---
    Shape(me) 
    	returns Shape from TopoDS; 
    	---C++:return const & 	    	    	  
    	---Purpose:  
    	--- Selector 
    	---

    GetCheckResult(me)
    	returns ListOfCheckResults from BOPTools;
	---C++: return const &
	---Purpose: returnes a result of check

    HasFaulty(me) 
    	returns Boolean from Standard; 
    	---Purpose:  
    	--- Selector.  
    	--- Retrns TRUE if there is interferred sub-shapes . 
    	---
    PerformVV  (me:out) 
    	is  redefined protected ; 
    	---Purpose:   
    	--- See in base classe, please   
    	---
    PerformVE  (me:out) 
    	is  redefined protected ;  
    	---Purpose:   
    	--- See in base classe, please   
    	---
    PerformVF  (me:out) 
    	is  redefined protected ;  
    	---Purpose:   
    	--- See in base classe, please   
    	---
    PerformEE  (me:out) 
    	is  redefined protected ;  
    	---Purpose:   
    	--- See in base classe, please   
    	---
    PerformEF  (me:out) 
    	is  redefined protected ; 
    	---Purpose:   
    	--- See in base classe, please   
    	---
    PerformFF  (me:out) 
    	is  redefined protected ;  	 
    	---Purpose:   
    	--- See in base classe, please   
    	---
    PrepareEdges  (me:out) 
    	is redefined protected ; 
    	---Purpose:  
    	--- Prepare end paves for each edge 
    	---
    PreparePaveBlocks (me:out; 
    	    	    	aType1: ShapeEnum  from  TopAbs; 
    	    	    	aType2: ShapeEnum  from  TopAbs) 
    	is redefined protected ;   
    	---Purpose:  
    	--- Internal usage 
    	---
    PreparePaveBlocks (me:out;   
    	    	       anE:Integer from Standard) 
    	is redefined protected ;   
    	---Purpose:  
    	--- Prepare end paves for the edge <anE>
    	---
fields
    myShape        :  Shape              from TopoDS;
    myCheckResults :  ListOfCheckResults from BOPTools;
    myStopOnFirst  :  Boolean            from Standard;
    myEntryType    :  Integer            from Standard;
    
end Checker;