1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_
21 #define SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_
23 //--------------------------------------------------------------------------------------
24 #include "ExchangeAPI.h"
29 #include <ModelHighAPI_Interface.h>
30 #include <ModelHighAPI_Macro.h>
32 #include <ExchangePlugin_ExportFeature.h>
33 //--------------------------------------------------------------------------------------
34 class ModelHighAPI_Selection;
35 //--------------------------------------------------------------------------------------
38 /// \class ExchangeAPI_Export
39 /// \ingroup CPPHighAPI
40 /// \brief Interface for Export feature.
41 class ExchangeAPI_Export: public ModelHighAPI_Interface
44 /// Constructor without values.
46 explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature);
48 /// Constructor with values for XAO export.
50 explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature,
51 const std::string & theFilePath,
52 const std::string & theAuthor = std::string(),
53 const std::string & theGeometryName = std::string());
55 /// Constructor with values for export in other formats than XAO.
57 explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature,
58 const std::string & theFilePath,
59 const std::list<ModelHighAPI_Selection> & theSelectionList,
60 const std::string & theFileFormat = std::string());
64 virtual ~ExchangeAPI_Export();
66 INTERFACE_7(ExchangePlugin_ExportFeature::ID(),
67 exportType, ExchangePlugin_ExportFeature::EXPORT_TYPE_ID(),
68 ModelAPI_AttributeString, /** ExportType */,
69 filePath, ExchangePlugin_ExportFeature::FILE_PATH_ID(),
70 ModelAPI_AttributeString, /** file path */,
71 xaoFilePath, ExchangePlugin_ExportFeature::XAO_FILE_PATH_ID(),
72 ModelAPI_AttributeString, /** xao_file_path */,
73 fileFormat, ExchangePlugin_ExportFeature::FILE_FORMAT_ID(),
74 ModelAPI_AttributeString, /** file format */,
75 selectionList, ExchangePlugin_ExportFeature::SELECTION_LIST_ID(),
76 ModelAPI_AttributeString, /** selection list */,
77 xaoAuthor, ExchangePlugin_ExportFeature::XAO_AUTHOR_ID(),
78 ModelAPI_AttributeString, /** xao author */,
79 xaoGeometryName, ExchangePlugin_ExportFeature::XAO_GEOMETRY_NAME_ID(),
80 ModelAPI_AttributeString, /** xao geometry name */)
82 /// Dump wrapped feature
84 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
87 /// Pointer on Export object
88 typedef std::shared_ptr<ExchangeAPI_Export> ExportPtr;
90 /**\ingroup CPPHighAPI
91 * \brief Export to file
94 ExportPtr exportToFile(const std::shared_ptr<ModelAPI_Document> & thePart,
95 const std::string & theFilePath,
96 const std::list<ModelHighAPI_Selection> & theSelectionList,
97 const std::string & theFileFormat = std::string());
99 /**\ingroup CPPHighAPI
103 ExportPtr exportToXAO(const std::shared_ptr<ModelAPI_Document> & thePart,
104 const std::string & theFilePath,
105 const std::string & theAuthor = std::string(),
106 const std::string & theGeometryName = std::string());
108 //--------------------------------------------------------------------------------------
109 //--------------------------------------------------------------------------------------
110 #endif /* SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_ */