src/ExchangeAPI/ExchangeAPI_Export.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_EXPORT_H_
  22 #define SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_
  23
  24 //--------------------------------------------------------------------------------------
  25 #include "ExchangeAPI.h"
  26
  27 #include <list>
  28 #include <string>
  29
  30 #include <ModelHighAPI_Interface.h>
  31 #include <ModelHighAPI_Macro.h>
  32
  33 #include <ExchangePlugin_ExportFeature.h>
  34 //--------------------------------------------------------------------------------------
  35 class ModelHighAPI_Selection;
  36 //--------------------------------------------------------------------------------------
  37
  38
  39 /// \class ExchangeAPI_Export
  40 /// \ingroup CPPHighAPI
  41 /// \brief Interface for Export feature.
  42 class ExchangeAPI_Export: public ModelHighAPI_Interface
  43 {
  44 public:
  45   /// Constructor without values.
  46   EXCHANGEAPI_EXPORT
  47   explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  48
  49   /// Constructor with values for XAO export.
  50   EXCHANGEAPI_EXPORT
  51   explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  52                               const std::string & theFilePath,
  53                               const std::string & theAuthor = std::string(),
  54                               const std::string & theGeometryName = std::string());
  55
  56   /// Constructor with values for export in other formats than XAO.
  57   EXCHANGEAPI_EXPORT
  58   explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  59                               const std::string & theFilePath,
  60                               const std::list<ModelHighAPI_Selection> & theSelectionList,
  61                               const std::string & theFileFormat = std::string());
  62
  63   /// Destructor.
  64   EXCHANGEAPI_EXPORT
  65   virtual ~ExchangeAPI_Export();
  66
  67   INTERFACE_7(ExchangePlugin_ExportFeature::ID(),
  68              exportType, ExchangePlugin_ExportFeature::EXPORT_TYPE_ID(),
  69              ModelAPI_AttributeString, /** ExportType */,
  70              filePath, ExchangePlugin_ExportFeature::FILE_PATH_ID(),
  71              ModelAPI_AttributeString, /** file path */,
  72              xaoFilePath, ExchangePlugin_ExportFeature::XAO_FILE_PATH_ID(),
  73              ModelAPI_AttributeString, /** xao_file_path */,
  74              fileFormat, ExchangePlugin_ExportFeature::FILE_FORMAT_ID(),
  75              ModelAPI_AttributeString, /** file format */,
  76              selectionList, ExchangePlugin_ExportFeature::SELECTION_LIST_ID(),
  77              ModelAPI_AttributeString, /** selection list */,
  78              xaoAuthor, ExchangePlugin_ExportFeature::XAO_AUTHOR_ID(),
  79              ModelAPI_AttributeString, /** xao author */,
  80              xaoGeometryName, ExchangePlugin_ExportFeature::XAO_GEOMETRY_NAME_ID(),
  81              ModelAPI_AttributeString, /** xao geometry name */)
  82
  83   /// Dump wrapped feature
  84   EXCHANGEAPI_EXPORT
  85   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  86 };
  87
  88 /// Pointer on Export object
  89 typedef std::shared_ptr<ExchangeAPI_Export> ExportPtr;
  90
  91 /**\ingroup CPPHighAPI
  92  * \brief Export to file
  93  */
  94 EXCHANGEAPI_EXPORT
  95 ExportPtr exportToFile(const std::shared_ptr<ModelAPI_Document> & thePart,
  96                   const std::string & theFilePath,
  97                   const std::list<ModelHighAPI_Selection> & theSelectionList,
  98                   const std::string & theFileFormat = std::string());
  99
 100 /**\ingroup CPPHighAPI
 101  * \brief Export XAO
 102  */
 103 EXCHANGEAPI_EXPORT
 104 ExportPtr exportToXAO(const std::shared_ptr<ModelAPI_Document> & thePart,
 105                  const std::string & theFilePath,
 106                  const std::string & theAuthor = std::string(),
 107                  const std::string & theGeometryName = std::string());
 108
 109 //--------------------------------------------------------------------------------------
 110 //--------------------------------------------------------------------------------------
 111 #endif /* SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_ */