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 EXCHANGEPLUGIN_EXPORTFEATURE_H_
21 #define EXCHANGEPLUGIN_EXPORTFEATURE_H_
23 #include <ExchangePlugin.h>
24 #include <ModelAPI_Feature.h>
25 #include <ModelAPI_Result.h>
30 * \class ExchangePlugin_ExportFeature
32 * \brief Feature for export shapes to the external files in CAD formats.
34 * The list of supported formats is defined in the configuration file.
36 class ExchangePlugin_ExportFeature : public ModelAPI_Feature
40 inline static const std::string& ID()
42 static const std::string MY_EXPORT_ID("Export");
45 /// attribute name for file format
46 inline static const std::string& EXPORT_TYPE_ID()
48 static const std::string MY_EXPORT_TYPE_ID("ExportType");
49 return MY_EXPORT_TYPE_ID;
51 /// attribute name of file path
52 inline static const std::string& FILE_PATH_ID()
54 static const std::string MY_FILE_PATH_ID("file_path");
55 return MY_FILE_PATH_ID;
57 /// attribute name of xao file path
58 inline static const std::string& XAO_FILE_PATH_ID()
60 static const std::string MY_XAO_FILE_PATH_ID("xao_file_path");
61 return MY_XAO_FILE_PATH_ID;
63 /// attribute name of file format
64 inline static const std::string& FILE_FORMAT_ID()
66 static const std::string MY_FILE_FORMAT_ID("file_format");
67 return MY_FILE_FORMAT_ID;
69 /// attribute name of selection list
70 inline static const std::string& SELECTION_LIST_ID()
72 static const std::string MY_SELECTION_LIST_ID("selection_list");
73 return MY_SELECTION_LIST_ID;
75 /// attribute name of author for XAO format
76 inline static const std::string& XAO_AUTHOR_ID()
78 static const std::string MY_XAO_AUTHOR_ID("xao_author");
79 return MY_XAO_AUTHOR_ID;
81 /// attribute name of geometry name for XAO format
82 inline static const std::string& XAO_GEOMETRY_NAME_ID()
84 static const std::string MY_XAO_GEOMETRY_NAME_ID("xao_geometry_name");
85 return MY_XAO_GEOMETRY_NAME_ID;
87 /// Default constructor
88 EXCHANGEPLUGIN_EXPORT ExchangePlugin_ExportFeature();
89 /// Default destructor
90 EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ExportFeature();
92 /// Returns the unique kind of a feature
93 EXCHANGEPLUGIN_EXPORT virtual const std::string& getKind()
95 return ExchangePlugin_ExportFeature::ID();
98 /// Request for initialization of data model of the feature: adding all attributes
99 EXCHANGEPLUGIN_EXPORT virtual void initAttributes();
101 /// Reimplemented from ModelAPI_Feature::attributeChanged()
102 EXCHANGEPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
104 /// Computes or recomputes the results
105 EXCHANGEPLUGIN_EXPORT virtual void execute();
107 /// Reimplemented from ModelAPI_Feature::isMacro(). Returns false.
108 // It is macro for not-XAO export. For XAO the feature is kept invisible in the tree
109 // for the export to GEOM functionality correct working.
110 EXCHANGEPLUGIN_EXPORT virtual bool isMacro() const;
112 /// Reimplemented from ModelAPI_Feature::isPreviewNeeded(). Returns false.
113 EXCHANGEPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
115 /// Do not put in history.
116 /// Since it is not a macro, it is not deleted, but we don't want to see it.
117 bool isInHistory() { return false; }
120 /// Performs export of the file
121 EXCHANGEPLUGIN_EXPORT void exportFile(const std::string& theFileName,
122 const std::string& theFormat);
124 /// Performs export to XAO file
125 EXCHANGEPLUGIN_EXPORT void exportXAO(const std::string& theFileName);
128 #endif /* EXPORT_EXPORTFEATURE_H_ */