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