src/ExchangeAPI/ExchangeAPI_Import.h

   1 // Copyright (C) 2014-2020  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 #include <ModelHighAPI_Reference.h>
  33 #include <ModelHighAPI_Selection.h>
  34 //--------------------------------------------------------------------------------------
  35 /**\class ExchangeAPI_Import
  36  * \ingroup CPPHighAPI
  37  * \brief Interface for Import feature
  38  */
  39 class ExchangeAPI_Import : public ModelHighAPI_Interface
  40 {
  41 public:
  42   /// Constructor without values
  43   EXCHANGEAPI_EXPORT
  44   explicit ExchangeAPI_Import(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  45   /// Constructor with values
  46   EXCHANGEAPI_EXPORT
  47   ExchangeAPI_Import(const std::shared_ptr<ModelAPI_Feature> & theFeature,
  48                      const std::string & theFilePath);
  49   /// Destructor
  50   EXCHANGEAPI_EXPORT
  51   virtual ~ExchangeAPI_Import();
  52
  53   INTERFACE_1(ExchangePlugin_ImportFeature::ID(),
  54               filePath, ExchangePlugin_ImportFeature::FILE_PATH_ID(),
  55               ModelAPI_AttributeString, /** File path */
  56   )
  57
  58   /// Set point values
  59   EXCHANGEAPI_EXPORT
  60   void setFilePath(const std::string & theFilePath);
  61
  62   /// Dump wrapped feature
  63   EXCHANGEAPI_EXPORT
  64   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  65 };
  66
  67 //! Pointer on Import object
  68 typedef std::shared_ptr<ExchangeAPI_Import> ImportPtr;
  69
  70 /**\ingroup CPPHighAPI
  71  * \brief Create Import feature
  72  */
  73 EXCHANGEAPI_EXPORT
  74 ImportPtr addImport(const std::shared_ptr<ModelAPI_Document> & thePart,
  75                     const std::string & theFilePath);
  76
  77 /** \ingroup CPPHighAPI
  78  *  \brief Import features from the file to the document after the current feature (or to the end).
  79  */
  80 EXCHANGEAPI_EXPORT void importPart(
  81     const std::shared_ptr<ModelAPI_Document> & thePart,
  82     const std::string & theFilePath,
  83     const ModelHighAPI_Reference & theAfterThis = ModelHighAPI_Reference());
  84
  85 //--------------------------------------------------------------------------------------
  86 //--------------------------------------------------------------------------------------
  87 #endif /* SRC_EXCHANGEAPI_EXCHANGEAPI_IMPORT_H_ */