1 // Copyright (C) 2007-2016 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_ComputeError.hxx
21 // Author : Edward AGAPOV (eap)
24 #ifndef SMESH_ComputeError_HeaderFile
25 #define SMESH_ComputeError_HeaderFile
27 #include "SMESH_Utils.hxx"
31 #include <boost/shared_ptr.hpp>
34 class SMDS_MeshElement;
35 struct SMESH_ComputeError;
37 typedef boost::shared_ptr<SMESH_ComputeError> SMESH_ComputeErrorPtr;
39 // =============================================================
41 enum SMESH_ComputeErrorName
43 // If you modify it, pls update SMESH_ComputeError::CommonName() below.
44 // Positive values are for algo specific errors
46 COMPERR_BAD_INPUT_MESH = -2, //!< wrong mesh on lower submesh
47 COMPERR_STD_EXCEPTION = -3, //!< some std exception raised
48 COMPERR_OCC_EXCEPTION = -4, //!< OCC exception raised
49 COMPERR_SLM_EXCEPTION = -5, //!< SALOME exception raised
50 COMPERR_EXCEPTION = -6, //!< other exception raised
51 COMPERR_MEMORY_PB = -7, //!< std::bad_alloc exception
52 COMPERR_ALGO_FAILED = -8, //!< algo failed for some reason
53 COMPERR_BAD_SHAPE = -9, //!< bad geometry
54 COMPERR_WARNING = -10, //!< algo reports error but sub-mesh is computed anyway
55 COMPERR_CANCELED = -11, //!< compute canceled
56 COMPERR_NO_MESH_ON_SHAPE = -12, //!< no mesh elements assigned to sub-shape
57 COMPERR_BAD_PARMETERS = -13, //!< incorrect hypotheses parameters
58 COMPERR_LAST_ALGO_ERROR = -100,//!< terminator of mesh computation errors
59 // Errors of SMESH_MeshEditor follow
60 EDITERR_NO_MEDIUM_ON_GEOM= -101 /* during conversion to quadratic,
61 some medium nodes not placed on geometry
62 to avoid distorting elements, which are
63 stored in SMESH_ComputeError::myBadElements */
66 // =============================================================
68 * \brief Contains an algorithm and description of an occurred error
70 // =============================================================
72 struct SMESHUtils_EXPORT SMESH_ComputeError
74 int myName; //!< SMESH_ComputeErrorName or anything algo specific
75 std::string myComment;
76 const SMESH_Algo* myAlgo;
78 std::list<const SMDS_MeshElement*> myBadElements; //!< to explain COMPERR_BAD_INPUT_MESH
80 static SMESH_ComputeErrorPtr New( int error = COMPERR_OK,
81 std::string comment = "",
82 const SMESH_Algo* algo = 0)
83 { return SMESH_ComputeErrorPtr( new SMESH_ComputeError( error, comment, algo )); }
85 SMESH_ComputeError(int error = COMPERR_OK,
86 std::string comment = "",
87 const SMESH_Algo* algo = 0)
88 :myName(error),myComment(comment),myAlgo(algo) {}
90 bool IsOK() const { return myName == COMPERR_OK; }
91 bool IsKO() const { return myName != COMPERR_OK && myName != COMPERR_WARNING; }
92 bool IsCommon() const { return myName < 0 && myName > COMPERR_LAST_ALGO_ERROR; }
93 bool HasBadElems() const { return !myBadElements.empty(); }
95 // not inline methods are implemented in src/SMESHUtils/SMESH_TryCatch.cxx
97 // Return myName as text, to be used to dump errors in terminal
98 std::string CommonName() const;
100 // Return the most severe error
101 static SMESH_ComputeErrorPtr Worst( SMESH_ComputeErrorPtr er1,
102 SMESH_ComputeErrorPtr er2 );