1 // Copyright (C) 2014-2017 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<mailto: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
47 /// if true, generates error if document is updated outside of transaction
48 bool myCheckTransactions;
49 bool myOperationAttachedToNext; ///< the current operation must be committed twice, with nested
52 //! Loads the OCAF document from the file.
53 //! \param theFileName full name of the file to load
54 //! \returns true if file was loaded successfully
55 MODEL_EXPORT virtual bool load(const char* theFileName);
57 //! Saves the OCAF document to the file.
58 //! \param theFileName full name of the file to store
59 //! \param theResults the result full file names that were stored by "save"
60 //! \returns true if file was stored successfully
61 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
63 //! Closes all documents
64 MODEL_EXPORT virtual void closeAll();
66 //! Starts a new operation (opens a transaction)
67 //! \param theId string-identifier of the started transaction
68 //! \param theAttachedToNested if it is true,
69 //! it means that this transaction is attached to the nested
70 //! where it is located and will be committed on the next commit with the nested
71 MODEL_EXPORT virtual void startOperation(
72 const std::string& theId = "", const bool theAttachedToNested = false);
73 //! Finishes the previously started operation (closes the transaction)
74 MODEL_EXPORT virtual void finishOperation();
75 //! Aborts the operation
76 MODEL_EXPORT virtual void abortOperation();
77 //! Returns true if operation has been started, but not yet finished or aborted
78 MODEL_EXPORT virtual bool isOperation();
79 //! Returns true if document was modified (since creation/opening)
80 MODEL_EXPORT virtual bool isModified();
82 //! Returns True if there are available Undos
83 MODEL_EXPORT virtual bool canUndo();
84 //! Undoes last operation
85 MODEL_EXPORT virtual void undo();
86 //! Returns True if there are available Redos
87 MODEL_EXPORT virtual bool canRedo();
88 //! Redoes last operation
89 MODEL_EXPORT virtual void redo();
90 //! Returns stack of performed operations
91 MODEL_EXPORT virtual std::list<std::string> undoList();
92 //! Returns stack of rolled back operations
93 MODEL_EXPORT virtual std::list<std::string> redoList();
95 /// Returns the root document of the application (that may contains sub-documents)
96 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> moduleDocument();
98 /// Returns the document by ID, loads if not loaded yet. Returns null if no such document.
99 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> document(int theDocID);
101 /// Return true if root document has been already created
102 MODEL_EXPORT virtual bool hasModuleDocument();
104 /// Returns the current document that used for current work in the application
105 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> activeDocument();
107 /// Defines the current document that used for current work in the application
108 MODEL_EXPORT virtual void setActiveDocument(
109 std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true);
111 /// Returns all the opened documents of the session (without postponed)
112 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments();
114 /// Returns true if document is not loaded yet
115 MODEL_EXPORT virtual bool isLoadByDemand(const std::string theDocID);
117 /// Registers the plugin that creates features.
118 /// It is obligatory for each plugin to call this function on loading to be found by
119 /// the plugin manager on call of the feature)
120 MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin);
122 /// Processes the configuration file reading
123 MODEL_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
125 /// Copies the document to the new one
126 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> copy(
127 std::shared_ptr<ModelAPI_Document> theSource, const int theDestID);
129 /// Returns the validators factory: the only one instance per application
130 MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();
132 /// Sets the flag to check modifications outside the transaction or not
133 void setCheckTransactions(const bool theCheck)
135 myCheckTransactions = theCheck;
138 /// Is called only once, on startup of the application
141 /// Returns the global identifier of the current transaction (needed for the update algo)
142 MODEL_EXPORT virtual int transactionID();
145 /// Loads (if not done yet) the information about the features and plugins
146 void LoadPluginsInfo();
148 /// Creates the feature object using plugins functionality
149 FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner);
151 friend class Model_Document;
152 friend class Model_Objects;