]> SALOME platform Git repositories - modules/shaper.git/blob - src/ExchangeAPI/ExchangeAPI_Export.h
Salome HOME
Improve code coverage for elliptic arcs.
[modules/shaper.git] / src / ExchangeAPI / ExchangeAPI_Export.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_EXPORT_H_
21 #define SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_
22
23 //--------------------------------------------------------------------------------------
24 #include "ExchangeAPI.h"
25
26 #include <list>
27 #include <string>
28
29 #include <ModelHighAPI_Interface.h>
30 #include <ModelHighAPI_Macro.h>
31
32 #include <ExchangePlugin_ExportFeature.h>
33 //--------------------------------------------------------------------------------------
34 class ModelHighAPI_Selection;
35 //--------------------------------------------------------------------------------------
36
37
38 /// \class ExchangeAPI_Export
39 /// \ingroup CPPHighAPI
40 /// \brief Interface for Export feature.
41 class ExchangeAPI_Export: public ModelHighAPI_Interface
42 {
43 public:
44   /// Constructor without values.
45   EXCHANGEAPI_EXPORT
46   explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature);
47
48   /// Constructor with values for XAO export.
49   EXCHANGEAPI_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());
54
55   /// Constructor with values for XAO of selected result export.
56   EXCHANGEAPI_EXPORT
57     explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature,
58       const std::string & theFilePath,
59       const ModelHighAPI_Selection& theResult,
60       const std::string & theAuthor,
61       const std::string & theGeometryName = std::string());
62
63   /// Constructor with values for export in other formats than XAO.
64   EXCHANGEAPI_EXPORT
65   explicit ExchangeAPI_Export(const std::shared_ptr<ModelAPI_Feature>& theFeature,
66                               const std::string & theFilePath,
67                               const std::list<ModelHighAPI_Selection> & theSelectionList,
68                               const std::string & theFileFormat = std::string());
69
70   /// Destructor.
71   EXCHANGEAPI_EXPORT
72   virtual ~ExchangeAPI_Export();
73
74   INTERFACE_7(ExchangePlugin_ExportFeature::ID(),
75              exportType, ExchangePlugin_ExportFeature::EXPORT_TYPE_ID(),
76              ModelAPI_AttributeString, /** ExportType */,
77              filePath, ExchangePlugin_ExportFeature::FILE_PATH_ID(),
78              ModelAPI_AttributeString, /** file path */,
79              xaoFilePath, ExchangePlugin_ExportFeature::XAO_FILE_PATH_ID(),
80              ModelAPI_AttributeString, /** xao_file_path */,
81              fileFormat, ExchangePlugin_ExportFeature::FILE_FORMAT_ID(),
82              ModelAPI_AttributeString, /** file format */,
83              selectionList, ExchangePlugin_ExportFeature::SELECTION_LIST_ID(),
84              ModelAPI_AttributeString, /** selection list */,
85              xaoAuthor, ExchangePlugin_ExportFeature::XAO_AUTHOR_ID(),
86              ModelAPI_AttributeString, /** xao author */,
87              xaoGeometryName, ExchangePlugin_ExportFeature::XAO_GEOMETRY_NAME_ID(),
88              ModelAPI_AttributeString, /** xao geometry name */)
89
90   /// Dump wrapped feature
91   EXCHANGEAPI_EXPORT
92   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
93 };
94
95 /// Pointer on Export object
96 typedef std::shared_ptr<ExchangeAPI_Export> ExportPtr;
97
98 /**\ingroup CPPHighAPI
99  * \brief Export to file
100  */
101 EXCHANGEAPI_EXPORT
102 ExportPtr exportToFile(const std::shared_ptr<ModelAPI_Document> & thePart,
103                   const std::string & theFilePath,
104                   const std::list<ModelHighAPI_Selection> & theSelectionList,
105                   const std::string & theFileFormat = std::string());
106
107 /**\ingroup CPPHighAPI
108  * \brief Exports to XAO file all results of the current document
109  */
110 EXCHANGEAPI_EXPORT
111 ExportPtr exportToXAO(const std::shared_ptr<ModelAPI_Document> & thePart,
112                  const std::string & theFilePath,
113                  const std::string & theAuthor = std::string(),
114                  const std::string & theGeometryName = std::string());
115
116 /**\ingroup CPPHighAPI
117 * \brief Exports to XAO file the selected result with groups parts related to it only.
118 */
119 EXCHANGEAPI_EXPORT
120 ExportPtr exportToXAO(const std::shared_ptr<ModelAPI_Document> & thePart,
121   const std::string & theFilePath,
122   const ModelHighAPI_Selection& theSelectedShape,
123   const std::string & theAuthor = std::string(),
124   const std::string & theGeometryName = std::string());
125
126 //--------------------------------------------------------------------------------------
127 //--------------------------------------------------------------------------------------
128 #endif /* SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_ */