-- Created by: Peter KURNEV
-- Copyright (c) 2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.

deferred class Algo from BRepAlgoAPI
        inherits MakeShape from BRepBuilderAPI
 ---Purpose: provides the root interface for algorithms

uses
    BaseAllocator from BOPCol,
    ProgressIndicator from Message,
    Shape from TopoDS

--raises

is
    Initialize 
        returns Algo from BRepAlgoAPI;
    ---C++: alias "Standard_EXPORT virtual ~BRepAlgoAPI_Algo();"
    ---Purpose:  Empty constructor  
    
    Initialize (theAllocator: BaseAllocator from BOPCol) 
        returns Algo from BRepAlgoAPI;
    ---Purpose:  Empty constructor   
     
    ErrorStatus (me)
        returns Integer from Standard; 
    ---Purpose: Returns error status of the algorithm 
    --  ==0 - no errors occured 
    --  !=0 - is in the event of various error conditions     
    
    WarningStatus (me)
        returns Integer from Standard;
    ---Purpose: Returns warning  status of the algorithm 
    --  ==0 - no warning occured 
    --  !=0 - is in the event of various warning conditions      
    
    Allocator(me)
        returns BaseAllocator from BOPCol;
    ---C++: return const &

    SetRunParallel(me:out;
            theFlag:Boolean from Standard);
    ---Purpose: Set the flag of parallel processing
    -- if <theFlag> is true  the parallel processing is switched on
    -- if <theFlag> is false the parallel processing is switched off
    --
    RunParallel(me)
        returns Boolean from Standard;
    ---Purpose: Returns the flag of parallel processing

    SetProgressIndicator(me:out;
            theObj: ProgressIndicator from Message);
    ---Purpose: Set the Progress Indicator object.

    UserBreak(me)
        is protected;
    ---Purpose: Breaks the execution if the break signal
    -- is indicated by myProgressIndicator.

    Shape(me)
        returns Shape from TopoDS
        is redefined;
    ---C++: return const &  
    
    Clear(me:out) 
        is virtual protected; 
 
fields 
    myAllocator     : BaseAllocator from BOPCol is protected;
    myErrorStatus   : Integer from Standard is protected;
    myWarningStatus : Integer from Standard is protected;
    myRunParallel   : Boolean from Standard is protected;
    myProgressIndicator : ProgressIndicator from Message is protected;

end Algo;