1 // Copyright (C) 2007-2014 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, or (at your option) any later version.
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
53 COMPERR_CANCELED = -11, //!< compute canceled
54 COMPERR_NO_MESH_ON_SHAPE = -12, //!< no mesh elements assigned to sub-shape
55 COMPERR_BAD_PARMETERS = -13, //!< incorrect hypotheses parameters
56 COMPERR_LAST_ALGO_ERROR = -100,//!< terminator of mesh computation errors
57 // Errors of SMESH_MeshEditor follow
58 EDITERR_NO_MEDIUM_ON_GEOM= -101 /* during conversion to quadratic,
59 some medium nodes not placed on geometry
60 to avoid distorting elements, which are
61 stored in SMESH_ComputeError::myBadElements */
64 // =============================================================
66 * \brief Contains an algorithm and description of an occured error
68 // =============================================================
70 struct SMESH_ComputeError
72 int myName; //!< SMESH_ComputeErrorName or anything algo specific
73 std::string myComment;
74 const SMESH_Algo* myAlgo;
76 std::list<const SMDS_MeshElement*> myBadElements; //!< to explain COMPERR_BAD_INPUT_MESH
78 static SMESH_ComputeErrorPtr New( int error = COMPERR_OK,
79 std::string comment = "",
80 const SMESH_Algo* algo = 0)
81 { return SMESH_ComputeErrorPtr( new SMESH_ComputeError( error, comment, algo )); }
83 SMESH_ComputeError(int error = COMPERR_OK,
84 std::string comment = "",
85 const SMESH_Algo* algo = 0)
86 :myName(error),myComment(comment),myAlgo(algo) {}
88 bool IsOK() const { return myName == COMPERR_OK; }
89 bool IsKO() const { return myName != COMPERR_OK && myName != COMPERR_WARNING; }
90 bool IsCommon() const { return myName < 0 && myName > COMPERR_LAST_ALGO_ERROR; }
91 bool HasBadElems() const { return !myBadElements.empty(); }
92 inline std::string CommonName() const;
96 #define _case2char(err) case err: return #err;
98 // Return myName as text, to be used to dump errors in terminal
99 std::string SMESH_ComputeError::CommonName() const
102 _case2char(COMPERR_OK );
103 _case2char(COMPERR_BAD_INPUT_MESH );
104 _case2char(COMPERR_STD_EXCEPTION );
105 _case2char(COMPERR_OCC_EXCEPTION );
106 _case2char(COMPERR_SLM_EXCEPTION );
107 _case2char(COMPERR_EXCEPTION );
108 _case2char(COMPERR_MEMORY_PB );
109 _case2char(COMPERR_ALGO_FAILED );
110 _case2char(COMPERR_BAD_SHAPE );
111 _case2char(COMPERR_WARNING );
112 _case2char(COMPERR_CANCELED );
113 _case2char(COMPERR_NO_MESH_ON_SHAPE);
114 _case2char(COMPERR_BAD_PARMETERS );