src/IMeshTools/IMeshTools_ModelBuilder.hxx

   1 // Created on: 2016-04-07
   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_ModelBuilder_HeaderFile
  17 #define _IMeshTools_ModelBuilder_HeaderFile
  18
  19 #include <Message_Algorithm.hxx>
  20 #include <Standard_ErrorHandler.hxx>
  21 #include <Standard_Failure.hxx>
  22 #include <Standard_Type.hxx>
  23 #include <TopoDS_Shape.hxx>
  24 #include <IMeshData_Model.hxx>
  25
  26 struct IMeshTools_Parameters;
  27
  28 //! Interface class represents API for tool building discrete model.
  29 //!
  30 //! The following statuses should be used by default:
  31 //! Message_Done1 - model has been sucessfully built.
  32 //! Message_Fail1 - empty shape.
  33 //! Message_Fail2 - model has not been build due to unexpected reason.
  34 class IMeshTools_ModelBuilder : public Message_Algorithm
  35 {
  36 public:
  37
  38   //! Destructor.
  39   virtual ~IMeshTools_ModelBuilder()
  40   {
  41   }
  42
  43   //! Exceptions protected method to create discrete model for the given shape.
  44   //! Returns nullptr in case of failure.
  45   Handle (IMeshData_Model) Perform (
  46     const TopoDS_Shape&          theShape,
  47     const IMeshTools_Parameters& theParameters)
  48   {
  49     ClearStatus ();
  50
  51     try
  52     {
  53       OCC_CATCH_SIGNALS
  54
  55       return performInternal (theShape, theParameters);
  56     }
  57     catch (Standard_Failure const&)
  58     {
  59       SetStatus (Message_Fail2);
  60       return NULL;
  61     }
  62   }
  63
  64   DEFINE_STANDARD_RTTIEXT(IMeshTools_ModelBuilder, Message_Algorithm)
  65
  66 protected:
  67
  68   //! Constructor.
  69   IMeshTools_ModelBuilder()
  70   {
  71   }
  72
  73   //! Creates discrete model for the given shape.
  74   //! Returns nullptr in case of failure.
  75   Standard_EXPORT virtual Handle (IMeshData_Model) performInternal (
  76     const TopoDS_Shape&          theShape,
  77     const IMeshTools_Parameters& theParameters) = 0;
  78 };
  79
  80 #endif