1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ExchangePlugin_ExportFeature.h
4 // Created: May 14, 2015
5 // Author: Sergey POKHODENKO
7 #ifndef EXCHANGEPLUGIN_EXPORTFEATURE_H_
8 #define EXCHANGEPLUGIN_EXPORTFEATURE_H_
10 #include <ExchangePlugin.h>
11 #include <ModelAPI_Feature.h>
12 #include <ModelAPI_Result.h>
17 * \class ExchangePlugin_ExportFeature
19 * \brief Feature for export shapes to the external files in CAD formats.
21 * The list of supported formats is defined in the configuration file.
23 class ExchangePlugin_ExportFeature : public ModelAPI_Feature
27 inline static const std::string& ID()
29 static const std::string MY_EXPORT_ID("Export");
32 /// attribute name for file format
33 inline static const std::string& EXPORT_TYPE_ID()
35 static const std::string MY_EXPORT_TYPE_ID("ExportType");
36 return MY_EXPORT_TYPE_ID;
38 /// attribute name of file path
39 inline static const std::string& FILE_PATH_ID()
41 static const std::string MY_FILE_PATH_ID("file_path");
42 return MY_FILE_PATH_ID;
44 /// attribute name of file format
45 inline static const std::string& FILE_FORMAT_ID()
47 static const std::string MY_FILE_FORMAT_ID("file_format");
48 return MY_FILE_FORMAT_ID;
50 /// attribute name of selection list
51 inline static const std::string& SELECTION_LIST_ID()
53 static const std::string MY_SELECTION_LIST_ID("selection_list");
54 return MY_SELECTION_LIST_ID;
56 /// attribute name of author for XAO format
57 inline static const std::string& XAO_AUTHOR_ID()
59 static const std::string MY_XAO_AUTHOR_ID("xao_author");
60 return MY_XAO_AUTHOR_ID;
62 /// Default constructor
63 EXCHANGEPLUGIN_EXPORT ExchangePlugin_ExportFeature();
64 /// Default destructor
65 EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ExportFeature();
67 /// Returns the unique kind of a feature
68 EXCHANGEPLUGIN_EXPORT virtual const std::string& getKind()
70 return ExchangePlugin_ExportFeature::ID();
73 /// Request for initialization of data model of the feature: adding all attributes
74 EXCHANGEPLUGIN_EXPORT virtual void initAttributes();
76 /// Computes or recomputes the results
77 EXCHANGEPLUGIN_EXPORT virtual void execute();
79 /// Reimplemented from ModelAPI_Feature::isMacro(). Returns true.
80 EXCHANGEPLUGIN_EXPORT virtual bool isMacro() const { return true; }
82 /// Reimplemented from ModelAPI_Feature::isPreviewNeeded(). Returns false.
83 EXCHANGEPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
86 /// Performs export of the file
87 EXCHANGEPLUGIN_EXPORT void exportFile(const std::string& theFileName,
88 const std::string& theFormat,
89 std::shared_ptr<GeomAPI_Shape> theShape);
91 /// Performs export to XAO file
92 EXCHANGEPLUGIN_EXPORT void exportXAO(const std::string& theFileName,
93 std::shared_ptr<GeomAPI_Shape> theShape);
96 #endif /* EXPORT_EXPORTFEATURE_H_ */