1 // Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 // File : SMESH_Hypothesis.hxx
21 // Author : Edward AGAPOV (eap)
24 #ifndef SMESH_ComputeError_HeaderFile
25 #define SMESH_ComputeError_HeaderFile
29 #include <boost/shared_ptr.hpp>
32 class SMDS_MeshElement;
33 struct SMESH_ComputeError;
35 typedef boost::shared_ptr<SMESH_ComputeError> SMESH_ComputeErrorPtr;
37 // =============================================================
39 enum SMESH_ComputeErrorName
41 // If you modify it, pls update SMESH_ComputeError::CommonName() below.
42 // Positive values are for algo specific errors
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
55 // =============================================================
57 * \brief Contains an algorithm and description of an occured error
59 // =============================================================
61 struct SMESH_ComputeError
63 int myName; //!< SMESH_ComputeErrorName or anything algo specific
64 std::string myComment;
65 const SMESH_Algo* myAlgo;
67 std::list<const SMDS_MeshElement*> myBadElements; //!< to explain COMPERR_BAD_INPUT_MESH
69 static SMESH_ComputeErrorPtr New( int error = COMPERR_OK,
70 std::string comment = "",
71 const SMESH_Algo* algo = 0)
72 { return SMESH_ComputeErrorPtr( new SMESH_ComputeError( error, comment, algo )); }
74 SMESH_ComputeError(int error = COMPERR_OK,
75 std::string comment = "",
76 const SMESH_Algo* algo = 0)
77 :myName(error),myComment(comment),myAlgo(algo) {}
79 bool IsOK() { return myName == COMPERR_OK; }
80 bool IsKO() { return myName != COMPERR_OK && myName != COMPERR_WARNING; }
81 bool IsCommon() { return myName < 0; }
82 inline std::string CommonName() const;
86 #define _case2char(err) case err: return #err;
88 std::string SMESH_ComputeError::CommonName() const
91 _case2char(COMPERR_OK );
92 _case2char(COMPERR_BAD_INPUT_MESH);
93 _case2char(COMPERR_STD_EXCEPTION );
94 _case2char(COMPERR_OCC_EXCEPTION );
95 _case2char(COMPERR_SLM_EXCEPTION );
96 _case2char(COMPERR_EXCEPTION );
97 _case2char(COMPERR_MEMORY_PB );
98 _case2char(COMPERR_ALGO_FAILED );
99 _case2char(COMPERR_BAD_SHAPE );
100 _case2char(COMPERR_WARNING );