src/ExchangeAPI/ExchangeAPI_Import.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 SRC_EXCHANGEAPI_EXCHANGEAPI_IMPORT_H_
  22 #define SRC_EXCHANGEAPI_EXCHANGEAPI_IMPORT_H_
  23
  24 //--------------------------------------------------------------------------------------
  25 #include "ExchangeAPI.h"
  26
  27 #include <string>
  28
  29 #include <ExchangePlugin_ImportFeature.h>
  30
  31 #include <ModelHighAPI_Interface.h>
  32 #include <ModelHighAPI_Macro.h>
  33 //--------------------------------------------------------------------------------------
  34 /**\class ExchangeAPI_Import
  35  * \ingroup CPPHighAPI
  36  * \brief Interface for Import feature
  37  */
  38 class ExchangeAPI_Import : public ModelHighAPI_Interface
  39 {
  40 public:
  41   /// Constructor without values
  42   EXCHANGEAPI_EXPORT
  43   explicit ExchangeAPI_Import(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  44   /// Constructor with values
  45   EXCHANGEAPI_EXPORT
  46   ExchangeAPI_Import(const std::shared_ptr<ModelAPI_Feature> & theFeature,
  47                      const std::string & theFilePath);
  48   /// Destructor
  49   EXCHANGEAPI_EXPORT
  50   virtual ~ExchangeAPI_Import();
  51
  52   INTERFACE_1(ExchangePlugin_ImportFeature::ID(),
  53               filePath, ExchangePlugin_ImportFeature::FILE_PATH_ID(),
  54               ModelAPI_AttributeString, /** File path */
  55   )
  56
  57   /// Set point values
  58   EXCHANGEAPI_EXPORT
  59   void setFilePath(const std::string & theFilePath);
  60
  61   /// Dump wrapped feature
  62   EXCHANGEAPI_EXPORT
  63   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  64 };
  65
  66 //! Pointer on Import object
  67 typedef std::shared_ptr<ExchangeAPI_Import> ImportPtr;
  68
  69 /**\ingroup CPPHighAPI
  70  * \brief Create Import feature
  71  */
  72 EXCHANGEAPI_EXPORT
  73 ImportPtr addImport(const std::shared_ptr<ModelAPI_Document> & thePart,
  74                     const std::string & theFilePath);
  75
  76 //--------------------------------------------------------------------------------------
  77 //--------------------------------------------------------------------------------------
  78 #endif /* SRC_EXCHANGEAPI_EXCHANGEAPI_IMPORT_H_ */