src/SMESHUtils/SMESH_ComputeError.hxx

   1 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 //  File   : SMESH_Hypothesis.hxx
  21 //  Author : Edward AGAPOV (eap)
  22 //  Module : SMESH
  23 //
  24 #ifndef SMESH_ComputeError_HeaderFile
  25 #define SMESH_ComputeError_HeaderFile
  26
  27 #include <string>
  28 #include <list>
  29 #include <boost/shared_ptr.hpp>
  30
  31 class SMESH_Algo;
  32 class SMDS_MeshElement;
  33 struct SMESH_ComputeError;
  34
  35 typedef boost::shared_ptr<SMESH_ComputeError> SMESH_ComputeErrorPtr;
  36
  37 // =============================================================
  38
  39 enum SMESH_ComputeErrorName
  40 {
  41   // If you modify it, pls update SMESH_ComputeError::CommonName() below.
  42   // Positive values are for algo specific errors
  43   COMPERR_OK               = -1,
  44   COMPERR_BAD_INPUT_MESH   = -2,  //!< wrong mesh on lower submesh
  45   COMPERR_STD_EXCEPTION    = -3,  //!< some std exception raised
  46   COMPERR_OCC_EXCEPTION    = -4,  //!< OCC exception raised
  47   COMPERR_SLM_EXCEPTION    = -5,  //!< SALOME exception raised
  48   COMPERR_EXCEPTION        = -6,  //!< other exception raised
  49   COMPERR_MEMORY_PB        = -7,  //!< std::bad_alloc exception
  50   COMPERR_ALGO_FAILED      = -8,  //!< algo failed for some reason
  51   COMPERR_BAD_SHAPE        = -9,  //!< bad geometry
  52   COMPERR_WARNING          = -10, //!< algo reports error but sub-mesh is computed anyway
  53   COMPERR_CANCELED         = -11, //!< compute canceled
  54   COMPERR_NO_MESH_ON_SHAPE = -12  //!< no mesh elements assigned to sub-shape
  55 };
  56
  57 // =============================================================
  58 /*!
  59  * \brief Contains an algorithm and description of an occured error
  60  */
  61 // =============================================================
  62
  63 struct SMESH_ComputeError
  64 {
  65   int               myName; //!< SMESH_ComputeErrorName or anything algo specific
  66   std::string       myComment;
  67   const SMESH_Algo* myAlgo;
  68
  69   std::list<const SMDS_MeshElement*> myBadElements; //!< to explain COMPERR_BAD_INPUT_MESH
  70
  71   static SMESH_ComputeErrorPtr New( int               error   = COMPERR_OK,
  72                                     std::string       comment = "",
  73                                     const SMESH_Algo* algo    = 0)
  74   { return SMESH_ComputeErrorPtr( new SMESH_ComputeError( error, comment, algo )); }
  75
  76   SMESH_ComputeError(int               error   = COMPERR_OK,
  77                      std::string       comment = "",
  78                      const SMESH_Algo* algo    = 0)
  79     :myName(error),myComment(comment),myAlgo(algo) {}
  80
  81   bool IsOK()     { return myName == COMPERR_OK; }
  82   bool IsKO()     { return myName != COMPERR_OK && myName != COMPERR_WARNING; }
  83   bool IsCommon() { return myName < 0; }
  84   inline std::string CommonName() const;
  85
  86 };
  87
  88 #define _case2char(err) case err: return #err;
  89
  90 std::string SMESH_ComputeError::CommonName() const
  91 {
  92   switch( myName ) {
  93   _case2char(COMPERR_OK            );
  94   _case2char(COMPERR_BAD_INPUT_MESH);
  95   _case2char(COMPERR_STD_EXCEPTION );
  96   _case2char(COMPERR_OCC_EXCEPTION );
  97   _case2char(COMPERR_SLM_EXCEPTION );
  98   _case2char(COMPERR_EXCEPTION     );
  99   _case2char(COMPERR_MEMORY_PB     );
 100   _case2char(COMPERR_ALGO_FAILED   );
 101   _case2char(COMPERR_BAD_SHAPE     );
 102   _case2char(COMPERR_WARNING       );
 103   _case2char(COMPERR_CANCELED      );
 104   default:;
 105   }
 106   return "";
 107 }
 108
 109 #endif