include/opencascade/IMeshTools_ModelAlgo.hxx

0001 // Created on: 2016-04-19
0002 // Copyright (c) 2016 OPEN CASCADE SAS
0003 // Created by: Oleg AGASHIN
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _IMeshTools_ModelAlgo_HeaderFile
0017 #define _IMeshTools_ModelAlgo_HeaderFile
0018
0019 #include <Standard_Transient.hxx>
0020 #include <Message_ProgressRange.hxx>
0021
0022 class IMeshData_Model;
0023 struct IMeshTools_Parameters;
0024
0025 //! Interface class providing API for algorithms intended to update or modify discrete model.
0026 class IMeshTools_ModelAlgo : public Standard_Transient
0027 {
0028 public:
0029
0030   //! Destructor.
0031   virtual ~IMeshTools_ModelAlgo()
0032   {
0033   }
0034
0035   //! Exceptions protected processing of the given model.
0036   Standard_Boolean Perform (
0037     const Handle (IMeshData_Model)& theModel,
0038     const IMeshTools_Parameters&    theParameters,
0039     const Message_ProgressRange&    theRange)
0040   {
0041     try
0042     {
0043       OCC_CATCH_SIGNALS
0044
0045       return performInternal (theModel, theParameters, theRange);
0046     }
0047     catch (Standard_Failure const&)
0048     {
0049       return Standard_False;
0050     }
0051   }
0052
0053   DEFINE_STANDARD_RTTIEXT(IMeshTools_ModelAlgo, Standard_Transient)
0054
0055 protected:
0056
0057   //! Constructor.
0058   IMeshTools_ModelAlgo()
0059   {
0060   }
0061
0062   //! Performs processing of the given model.
0063   Standard_EXPORT virtual Standard_Boolean performInternal (
0064     const Handle (IMeshData_Model)& theModel,
0065     const IMeshTools_Parameters&    theParameters,
0066     const Message_ProgressRange&    theRange) = 0;
0067 };
0068
0069 #endif