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 Model_Session_H_
21 #define Model_Session_H_
24 #include <ModelAPI_Session.h>
25 #include <ModelAPI_Feature.h>
27 #include <Events_Listener.h>
32 /**\class Model_Session
34 * \brief Object that knows (from the initial XML file) which
35 * plugin contains which feature, loads and stores reference to loaded plugins by
36 * the feature functionality request.
38 class Model_Session : public ModelAPI_Session, public Events_Listener
40 bool myPluginsInfoLoaded; ///< it true if plugins information is loaded
41 /// map of feature IDs to plugin name and document kind
42 std::map<std::string, std::pair<std::string, std::string> > myPlugins;
43 std::map<std::string, ModelAPI_Plugin*> myPluginObjs; ///< instances of the already plugins
44 std::string myCurrentPluginName; ///< name of the plugin that must be loaded currently
45 std::shared_ptr<ModelAPI_Document> myCurrentDoc; ///< current working document
46 ///< map from plugin id to plugins which are used by it (must be loaded before this one)
47 std::map<std::string, std::string> myUsePlugins;
49 /// if true, generates error if document is updated outside of transaction
50 bool myCheckTransactions;
51 bool myOperationAttachedToNext; ///< the current operation must be committed twice, with nested
54 //! Loads the OCAF document from the file.
55 //! \param theFileName full name of the file to load
56 //! \returns true if file was loaded successfully
57 MODEL_EXPORT virtual bool load(const char* theFileName);
59 //! Saves the OCAF document to the file.
60 //! \param theFileName full name of the file to store
61 //! \param theResults the result full file names that were stored by "save"
62 //! \returns true if file was stored successfully
63 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
65 //! Closes all documents
66 MODEL_EXPORT virtual void closeAll();
68 //! Starts a new operation (opens a transaction)
69 //! \param theId string-identifier of the started transaction
70 //! \param theAttachedToNested if it is true,
71 //! it means that this transaction is attached to the nested
72 //! where it is located and will be committed on the next commit with the nested
73 MODEL_EXPORT virtual void startOperation(
74 const std::string& theId = "", const bool theAttachedToNested = false);
75 //! Finishes the previously started operation (closes the transaction)
76 MODEL_EXPORT virtual void finishOperation();
77 //! Aborts the operation
78 MODEL_EXPORT virtual void abortOperation();
79 //! Returns true if operation has been started, but not yet finished or aborted
80 MODEL_EXPORT virtual bool isOperation();
81 //! Returns true if document was modified (since creation/opening)
82 MODEL_EXPORT virtual bool isModified();
84 //! Returns True if there are available Undos
85 MODEL_EXPORT virtual bool canUndo();
86 //! Undoes last operation
87 MODEL_EXPORT virtual void undo();
88 //! Returns True if there are available Redos
89 MODEL_EXPORT virtual bool canRedo();
90 //! Redoes last operation
91 MODEL_EXPORT virtual void redo();
92 //! Returns stack of performed operations
93 MODEL_EXPORT virtual std::list<std::string> undoList();
94 //! Returns stack of rolled back operations
95 MODEL_EXPORT virtual std::list<std::string> redoList();
97 /// Returns the root document of the application (that may contains sub-documents)
98 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> moduleDocument();
100 /// Returns the document by ID, loads if not loaded yet. Returns null if no such document.
101 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> document(int theDocID);
103 /// Return true if root document has been already created
104 MODEL_EXPORT virtual bool hasModuleDocument();
106 /// Returns the current document that used for current work in the application
107 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> activeDocument();
109 /// Defines the current document that used for current work in the application
110 MODEL_EXPORT virtual void setActiveDocument(
111 std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true);
113 /// Returns all the opened documents of the session (without postponed)
114 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments();
116 /// Returns true if document is not loaded yet
117 MODEL_EXPORT virtual bool isLoadByDemand(const std::string theDocID, const int theDocIndex);
119 /// Registers the plugin that creates features.
120 /// It is obligatory for each plugin to call this function on loading to be found by
121 /// the plugin manager on call of the feature)
122 MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin);
124 /// Processes the configuration file reading
125 MODEL_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
127 /// Copies the document to the new one
128 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> copy(
129 std::shared_ptr<ModelAPI_Document> theSource, const int theDestID);
131 /// Returns the validators factory: the only one instance per application
132 MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();
134 /// Sets the flag to check modifications outside the transaction or not
135 void setCheckTransactions(const bool theCheck)
137 myCheckTransactions = theCheck;
140 /// Is called only once, on startup of the application
143 /// Returns the global identifier of the current transaction (needed for the update algo)
144 MODEL_EXPORT virtual int transactionID();
147 /// Returns true if auto-update in the application is blocked
148 MODEL_EXPORT virtual bool isAutoUpdateBlocked();
150 /// Set state of the auto-update of features result in the application
151 MODEL_EXPORT virtual void blockAutoUpdate(const bool theBlock);
154 /// Loads (if not done yet) the information about the features and plugins
155 void LoadPluginsInfo();
157 /// Creates the feature object using plugins functionality
158 FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner);
160 /// Get the plugin by name. If it is not loaded, load plugin.
161 ModelAPI_Plugin* getPlugin(const std::string& thePluginName);
163 friend class Model_Document;
164 friend class Model_Objects;