Updated copyright comment

[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Tools.h

diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Tools.h b/src/GeomAlgoAPI/GeomAlgoAPI_Tools.h
index e70e6e9536417afc0f3fd1603743c8dc890c0023..c5713f3ab9c51a99d7edbeb29cc83ef7b7127691 100644 (file)
--- a/src/GeomAlgoAPI/GeomAlgoAPI_Tools.h
+++ b/src/GeomAlgoAPI/GeomAlgoAPI_Tools.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2024  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
@@ -12,9 +12,9 @@
 //
 // 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
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef GEOMALGOAPI_TOOLS_H_
@@ -22,9 +22,19 @@
 
 #include <GeomAlgoAPI.h>
 
+#include <memory>
 #include <string>
 
+class GeomAlgoAPI_MakeShape;
+
 namespace GeomAlgoAPI_Tools {
+/// Type of booelan operation
+enum BOPType {
+  BOOL_CUT,      ///< Cut objects
+  BOOL_FUSE,     ///< Fuse objects
+  BOOL_COMMON,   ///< Take common part of objects
+  BOOL_PARTITION ///< Parition operation
+};
 
 /** \class Localizer
  *  \ingroup DataAlgo
@@ -53,6 +63,28 @@ public:
    * Returns a name of theFileName
    */
   GEOMALGOAPI_EXPORT static std::string name(const std::string& theFileName);
+  /**
+   * Returns a directory path of theFileName
+   */
+  GEOMALGOAPI_EXPORT static std::string path(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