Salome HOME
Issue #2873: Freeze when inserting a new folder
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Tools.h
index 7877f702896389920cdd79aefa80764d1da16b16..2cb26c75b8c532ae85288392836e00ad6bb3aafa 100644 (file)
@@ -1,16 +1,32 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:    GeomAlgoAPI_Tools.h
-// Created: May 18, 2015
-// Author:  Sergey POKHODENKO
+// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+//
+// 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, 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
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef GEOMALGOAPI_TOOLS_H_
 #define GEOMALGOAPI_TOOLS_H_
 
 #include <GeomAlgoAPI.h>
 
+#include <memory>
 #include <string>
 
+class GeomAlgoAPI_MakeShape;
+
 namespace GeomAlgoAPI_Tools {
 
 /** \class Localizer
@@ -42,6 +58,24 @@ public:
   GEOMALGOAPI_EXPORT static std::string name(const std::string& theFileName);
 };
 
+/** \class AlgoError
+ *  \ingroup DataAlgo
+ *  \brief Verify error in MakeShape algorithm.
+ */
+class AlgoError {
+public:
+  /** \brief Verify MakeShape algorithm for failures
+   *  \param[in]  theAlgorithm object to verify the failure
+   *  \param[in]  theFeature   kind of the feature, the algorithm belongs to
+   *  \param[out] theError     error string (empty if the feature succeed)
+   *  \return \c true if succeed
+   */
+  GEOMALGOAPI_EXPORT static bool isAlgorithmFailed(
+      const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgorithm,
+      const std::string& theFeature,
+      std::string& theError);
+};
+
 } // GeomAlgoAPI_Tools
 
 #endif /* GEOMALGOAPI_TOOLS_H_ */