src/GeomAlgoAPI/GeomAlgoAPI_Tools.h

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