Salome HOME
Copyright update 2020
[modules/smesh.git] / src / SMESHUtils / SMESH_ComputeError.hxx
index 204427f088dc5275ac9f13d267caf7bc7a6348fb..57e4214ff0ab5c3d6b73eacf350c91d19cc6ad76 100644 (file)
@@ -1,9 +1,9 @@
-// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
-//  File   : SMESH_Hypothesis.hxx
+//  File   : SMESH_ComputeError.hxx
 //  Author : Edward AGAPOV (eap)
 //  Module : SMESH
 //
 #ifndef SMESH_ComputeError_HeaderFile
 #define SMESH_ComputeError_HeaderFile
 
+#include "SMESH_Utils.hxx"
+#include "SMDS_ElementHolder.hxx"
+
 #include <string>
 #include <list>
 #include <boost/shared_ptr.hpp>
@@ -40,69 +43,87 @@ enum SMESH_ComputeErrorName
 {
   // If you modify it, pls update SMESH_ComputeError::CommonName() below.
   // Positive values are for algo specific errors
-  COMPERR_OK             = -1,
-  COMPERR_BAD_INPUT_MESH = -2,  //!< wrong mesh on lower submesh
-  COMPERR_STD_EXCEPTION  = -3,  //!< some std exception raised
-  COMPERR_OCC_EXCEPTION  = -4,  //!< OCC exception raised
-  COMPERR_SLM_EXCEPTION  = -5,  //!< SALOME exception raised
-  COMPERR_EXCEPTION      = -6,  //!< other exception raised
-  COMPERR_MEMORY_PB      = -7,  //!< std::bad_alloc exception
-  COMPERR_ALGO_FAILED    = -8,  //!< algo failed for some reason
-  COMPERR_BAD_SHAPE      = -9,  //!< bad geometry
-  COMPERR_WARNING        = -10, //!< algo reports error but sub-mesh is computed anyway
-  COMPERR_CANCELED       = -11  //!< compute canceled
+  COMPERR_OK               = -1,
+  COMPERR_BAD_INPUT_MESH   = -2,  //!< wrong mesh on lower submesh
+  COMPERR_STD_EXCEPTION    = -3,  //!< some std exception raised
+  COMPERR_OCC_EXCEPTION    = -4,  //!< OCC exception raised
+  COMPERR_SLM_EXCEPTION    = -5,  //!< SALOME exception raised
+  COMPERR_EXCEPTION        = -6,  //!< other exception raised
+  COMPERR_MEMORY_PB        = -7,  //!< std::bad_alloc exception
+  COMPERR_ALGO_FAILED      = -8,  //!< algo failed for some reason
+  COMPERR_BAD_SHAPE        = -9,  //!< bad geometry
+  COMPERR_WARNING          = -10, //!< algo reports error but sub-mesh is computed anyway
+  COMPERR_CANCELED         = -11, //!< compute canceled
+  COMPERR_NO_MESH_ON_SHAPE = -12, //!< no mesh elements assigned to sub-shape
+  COMPERR_BAD_PARMETERS    = -13, //!< incorrect hypotheses parameters
+  COMPERR_LAST_ALGO_ERROR  = -100,//!< terminator of mesh computation errors
+  // Errors of SMESH_MeshEditor follow
+  EDITERR_NO_MEDIUM_ON_GEOM= -101 /* during conversion to quadratic,
+                                     some medium nodes not placed on geometry
+                                     to avoid distorting elements, which are
+                                     stored in SMESH_ComputeError::myBadElements */
 };
 
 // =============================================================
 /*!
- * \brief Contains an algorithm and description of an occured error
+ * \brief Contains an algorithm and description of an occurred error
  */
 // =============================================================
 
-struct SMESH_ComputeError
+struct SMESHUtils_EXPORT SMESH_ComputeError
 {
   int               myName; //!< SMESH_ComputeErrorName or anything algo specific
   std::string       myComment;
   const SMESH_Algo* myAlgo;
 
-  std::list<const SMDS_MeshElement*> myBadElements; //!< to explain COMPERR_BAD_INPUT_MESH
-
   static SMESH_ComputeErrorPtr New( int               error   = COMPERR_OK,
                                     std::string       comment = "",
                                     const SMESH_Algo* algo    = 0)
   { return SMESH_ComputeErrorPtr( new SMESH_ComputeError( error, comment, algo )); }
 
-  SMESH_ComputeError(int               error   = COMPERR_OK,
-                     std::string       comment = "",
-                     const SMESH_Algo* algo    = 0)
-    :myName(error),myComment(comment),myAlgo(algo) {}
+  SMESH_ComputeError( int               error   = COMPERR_OK,
+                      std::string       comment = "",
+                      const SMESH_Algo* algo    = 0)
+    : myName(error), myComment(comment), myAlgo(algo) {}
 
-  bool IsOK()     { return myName == COMPERR_OK; }
-  bool IsKO()     { return myName != COMPERR_OK && myName != COMPERR_WARNING; }
-  bool IsCommon() { return myName < 0; }
-  inline std::string CommonName() const;
+  bool IsOK()        const { return myName == COMPERR_OK; }
+  bool IsKO()        const { return myName != COMPERR_OK && myName != COMPERR_WARNING; }
+  bool IsCommon()    const { return myName < 0 && myName > COMPERR_LAST_ALGO_ERROR; }
+  virtual bool HasBadElems() const { return false; }
 
-};
+  // not inline methods are implemented in   src/SMESHUtils/SMESH_TryCatch.cxx
 
-#define _case2char(err) case err: return #err;
+  // Return myName as text, to be used to dump errors in terminal
+  std::string CommonName() const;
+
+  // Return the most severe error
+  static SMESH_ComputeErrorPtr Worst( SMESH_ComputeErrorPtr er1,
+                                      SMESH_ComputeErrorPtr er2 );
+
+  virtual ~SMESH_ComputeError() {}
+};
 
-std::string SMESH_ComputeError::CommonName() const
+struct SMESHUtils_EXPORT SMESH_BadInputElements : public SMESH_ComputeError, SMDS_ElementHolder
 {
-  switch( myName ) {
-  _case2char(COMPERR_OK            );
-  _case2char(COMPERR_BAD_INPUT_MESH);
-  _case2char(COMPERR_STD_EXCEPTION );
-  _case2char(COMPERR_OCC_EXCEPTION );
-  _case2char(COMPERR_SLM_EXCEPTION );
-  _case2char(COMPERR_EXCEPTION     );
-  _case2char(COMPERR_MEMORY_PB     );
-  _case2char(COMPERR_ALGO_FAILED   );
-  _case2char(COMPERR_BAD_SHAPE     );
-  _case2char(COMPERR_WARNING       );
-  _case2char(COMPERR_CANCELED      );
-  default:;
-  }
-  return "";
-}
+  typedef std::list<const SMDS_MeshElement*> TElemList;
+  TElemList myBadElements; //!< to explain COMPERR_BAD_INPUT_MESH
+
+  SMESH_BadInputElements(const SMDS_Mesh*  mesh,
+                         int               error   = COMPERR_OK,
+                         std::string       comment = "",
+                         const SMESH_Algo* algo    = 0)
+    :SMESH_ComputeError(error, comment ,algo), SMDS_ElementHolder(mesh) {}
+
+  const SMDS_Mesh* GetMesh() const { return myMesh; }
+  const TElemList& GetElements()   { return myBadElements; }
+
+  virtual bool HasBadElems() const { return !myBadElements.empty(); }
+
+  // methods of SMDS_ElementHolder
+  virtual SMDS_ElemIteratorPtr getElements();
+  virtual void tmpClear();
+  virtual void add( const SMDS_MeshElement* element );
+  virtual void compact() { }
+};
 
 #endif