src/GeomAlgoAPI/GeomAlgoAPI_Tools.h

   1 // Copyright (C) 2014-2019  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
  32 /** \class Localizer
  33  *  \ingroup DataAlgo
  34  *  \brief Localizer tool.
  35  */
  36 class Localizer
  37 {
  38 public:
  39   GEOMALGOAPI_EXPORT Localizer();
  40   GEOMALGOAPI_EXPORT ~Localizer();
  41 private:
  42   std::string myCurLocale;
  43 };
  44
  45 /** \class File_Tools
  46  *  \ingroup DataAlgo
  47  *  \brief File tool.
  48  */
  49 class File_Tools {
  50 public:
  51   /**
  52    * Returns an extension of theFileName
  53    */
  54   GEOMALGOAPI_EXPORT static std::string extension(const std::string& theFileName);
  55   /**
  56    * Returns a name of theFileName
  57    */
  58   GEOMALGOAPI_EXPORT static std::string name(const std::string& theFileName);
  59 };
  60
  61 /** \class AlgoError
  62  *  \ingroup DataAlgo
  63  *  \brief Verify error in MakeShape algorithm.
  64  */
  65 class AlgoError {
  66 public:
  67   /** \brief Verify MakeShape algorithm for failures
  68    *  \param[in]  theAlgorithm object to verify the failure
  69    *  \param[in]  theFeature   kind of the feature, the algorithm belongs to
  70    *  \param[out] theError     error string (empty if the feature succeed)
  71    *  \return \c true if succeed
  72    */
  73   GEOMALGOAPI_EXPORT static bool isAlgorithmFailed(
  74       const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgorithm,
  75       const std::string& theFeature,
  76       std::string& theError);
  77 };
  78
  79 } // GeomAlgoAPI_Tools
  80
  81 #endif /* GEOMALGOAPI_TOOLS_H_ */