src/IMeshTools/IMeshTools_ModelAlgo.hxx

   1 // Created on: 2016-04-19
   2 // Copyright (c) 2016 OPEN CASCADE SAS
   3 // Created by: Oleg AGASHIN
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _IMeshTools_ModelAlgo_HeaderFile
  17 #define _IMeshTools_ModelAlgo_HeaderFile
  18
  19 #include <Standard_ErrorHandler.hxx>
  20 #include <Standard_Failure.hxx>
  21 #include <Standard_Transient.hxx>
  22 #include <Standard_Type.hxx>
  23 #include <Message_ProgressRange.hxx>
  24
  25 class IMeshData_Model;
  26 struct IMeshTools_Parameters;
  27
  28 //! Interface class providing API for algorithms intended to update or modify discrete model.
  29 class IMeshTools_ModelAlgo : public Standard_Transient
  30 {
  31 public:
  32
  33   //! Destructor.
  34   Standard_EXPORT virtual ~IMeshTools_ModelAlgo()
  35   {
  36   }
  37
  38   //! Exceptions protected processing of the given model.
  39   Standard_Boolean Perform (
  40     const Handle (IMeshData_Model)& theModel,
  41     const IMeshTools_Parameters&    theParameters,
  42     const Message_ProgressRange&    theRange)
  43   {
  44     try
  45     {
  46       OCC_CATCH_SIGNALS
  47
  48       return performInternal (theModel, theParameters, theRange);
  49     }
  50     catch (Standard_Failure const&)
  51     {
  52       return Standard_False;
  53     }
  54   }
  55
  56   DEFINE_STANDARD_RTTI_INLINE(IMeshTools_ModelAlgo, Standard_Transient)
  57
  58 protected:
  59
  60   //! Constructor.
  61   Standard_EXPORT IMeshTools_ModelAlgo()
  62   {
  63   }
  64
  65   //! Performs processing of the given model.
  66   Standard_EXPORT virtual Standard_Boolean performInternal (
  67     const Handle (IMeshData_Model)& theModel,
  68     const IMeshTools_Parameters&    theParameters,
  69     const Message_ProgressRange&    theRange) = 0;
  70 };
  71
  72 #endif