]> SALOME platform Git repositories - modules/shaper.git/blob - src/ExchangePlugin/ExchangePlugin_Dump.h
Salome HOME
Add command "Rename" to a folder context menu
[modules/shaper.git] / src / ExchangePlugin / ExchangePlugin_Dump.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 EXCHANGEPLUGIN_DUMP_H_
22 #define EXCHANGEPLUGIN_DUMP_H_
23
24 #include <ExchangePlugin.h>
25
26 #include <ModelAPI_Feature.h>
27
28 /**
29  * \class ExchangePlugin_Dump
30  * \ingroup Plugins
31  * \brief Store full model as a Python script
32  */
33 class ExchangePlugin_Dump : public ModelAPI_Feature
34 {
35 public:
36   /// Feature kind
37   inline static const std::string& ID()
38   {
39     static const std::string MY_DUMP_ID("Dump");
40     return MY_DUMP_ID;
41   }
42   /// attribute name of file path
43   inline static const std::string& FILE_PATH_ID()
44   {
45     static const std::string MY_FILE_PATH_ID("file_path");
46     return MY_FILE_PATH_ID;
47   }
48   /// attribute name of file format
49   inline static const std::string& FILE_FORMAT_ID()
50   {
51     static const std::string MY_FILE_FORMAT_ID("file_format");
52     return MY_FILE_FORMAT_ID;
53   }
54
55   /// Default constructor
56   EXCHANGEPLUGIN_EXPORT ExchangePlugin_Dump();
57   /// Default destructor
58   EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_Dump();
59
60   /// Returns the unique kind of a feature
61   EXCHANGEPLUGIN_EXPORT virtual const std::string& getKind()
62   {
63     return ExchangePlugin_Dump::ID();
64   }
65
66   /// Request for initialization of data model of the feature: adding all attributes
67   EXCHANGEPLUGIN_EXPORT virtual void initAttributes();
68
69   /// Computes or recomputes the results
70   EXCHANGEPLUGIN_EXPORT virtual void execute();
71
72   /// Reimplemented from ModelAPI_Feature::isMacro(). Returns true.
73   EXCHANGEPLUGIN_EXPORT virtual bool isMacro() const { return true; }
74
75   /// Reimplemented from ModelAPI_Feature::isPreviewNeeded(). Returns false.
76   EXCHANGEPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
77
78 protected:
79   /// Performs dump to the file
80   EXCHANGEPLUGIN_EXPORT void dump(const std::string& theFileName);
81 };
82
83 #endif