src/GeomAlgoAPI/GeomAlgoAPI_Tools.h

   1 // Copyright (C) 2014-2021  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GEOMALGOAPI_TOOLS_H_
  21 #define GEOMALGOAPI_TOOLS_H_
  22
  23 #include <GeomAlgoAPI.h>
  24
  25 #include <memory>
  26 #include <string>
  27
  28 class GeomAlgoAPI_MakeShape;
  29
  30 namespace GeomAlgoAPI_Tools {
  31 /// Type of booelan operation
  32 enum BOPType {
  33   BOOL_CUT,      ///< Cut objects
  34   BOOL_FUSE,     ///< Fuse objects
  35   BOOL_COMMON,   ///< Take common part of objects
  36   BOOL_PARTITION ///< Parition operation
  37 };
  38
  39 /** \class Localizer
  40  *  \ingroup DataAlgo
  41  *  \brief Localizer tool.
  42  */
  43 class Localizer
  44 {
  45 public:
  46   GEOMALGOAPI_EXPORT Localizer();
  47   GEOMALGOAPI_EXPORT ~Localizer();
  48 private:
  49   std::string myCurLocale;
  50 };
  51
  52 /** \class File_Tools
  53  *  \ingroup DataAlgo
  54  *  \brief File tool.
  55  */
  56 class File_Tools {
  57 public:
  58   /**
  59    * Returns an extension of theFileName
  60    */
  61   GEOMALGOAPI_EXPORT static std::string extension(const std::string& theFileName);
  62   /**
  63    * Returns a name of theFileName
  64    */
  65   GEOMALGOAPI_EXPORT static std::string name(const std::string& theFileName);
  66   /**
  67    * Returns a directory path of theFileName
  68    */
  69   GEOMALGOAPI_EXPORT static std::string path(const std::string& theFileName);
  70 };
  71
  72 /** \class AlgoError
  73  *  \ingroup DataAlgo
  74  *  \brief Verify error in MakeShape algorithm.
  75  */
  76 class AlgoError {
  77 public:
  78   /** \brief Verify MakeShape algorithm for failures
  79    *  \param[in]  theAlgorithm object to verify the failure
  80    *  \param[in]  theFeature   kind of the feature, the algorithm belongs to
  81    *  \param[out] theError     error string (empty if the feature succeed)
  82    *  \return \c true if succeed
  83    */
  84   GEOMALGOAPI_EXPORT static bool isAlgorithmFailed(
  85       const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgorithm,
  86       const std::string& theFeature,
  87       std::string& theError);
  88 };
  89
  90 } // GeomAlgoAPI_Tools
  91
  92 #endif /* GEOMALGOAPI_TOOLS_H_ */