1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Session.hxx
4 // Created: 20 Mar 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef Model_Session_H_
8 #define Model_Session_H_
11 #include <ModelAPI_Session.h>
12 #include <ModelAPI_Feature.h>
14 #include <Events_Listener.h>
19 /**\class Model_Session
21 * \brief Object that knows (from the initial XML file) which
22 * plugin contains which feature, loads and stores reference to loaded plugins by
23 * the feature functionality request.
25 class Model_Session : public ModelAPI_Session, public Events_Listener
27 bool myPluginsInfoLoaded; ///< it true if plugins information is loaded
28 /// map of feature IDs to plugin name and document kind
29 std::map<std::string, std::pair<std::string, std::string> > myPlugins;
30 std::map<std::string, ModelAPI_Plugin*> myPluginObjs; ///< instances of the already plugins
31 std::string myCurrentPluginName; ///< name of the plugin that must be loaded currently
32 std::shared_ptr<ModelAPI_Document> myCurrentDoc; ///< current working document
34 /// if true, generates error if document is updated outside of transaction
35 bool myCheckTransactions;
36 bool myOperationAttachedToNext; ///< the current operation must be committed twice, with nested
39 //! Loads the OCAF document from the file.
40 //! \param theFileName full name of the file to load
41 //! \returns true if file was loaded successfully
42 MODEL_EXPORT virtual bool load(const char* theFileName);
44 //! Saves the OCAF document to the file.
45 //! \param theFileName full name of the file to store
46 //! \param theResults the result full file names that were stored by "save"
47 //! \returns true if file was stored successfully
48 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
50 //! Closes all documents
51 MODEL_EXPORT virtual void closeAll();
53 //! Starts a new operation (opens a transaction)
54 //! \param theId string-identifier of the started transaction
55 //! \param theAttachedToNested if it is true,
56 //! it means that this transaction is attached to the nested
57 //! where it is located and will be committed on the next commit with the nested
58 MODEL_EXPORT virtual void startOperation(
59 const std::string& theId = "", const bool theAttachedToNested = false);
60 //! Finishes the previously started operation (closes the transaction)
61 MODEL_EXPORT virtual void finishOperation();
62 //! Aborts the operation
63 MODEL_EXPORT virtual void abortOperation();
64 //! Returns true if operation has been started, but not yet finished or aborted
65 MODEL_EXPORT virtual bool isOperation();
66 //! Returns true if document was modified (since creation/opening)
67 MODEL_EXPORT virtual bool isModified();
69 //! Returns True if there are available Undos
70 MODEL_EXPORT virtual bool canUndo();
71 //! Undoes last operation
72 MODEL_EXPORT virtual void undo();
73 //! Returns True if there are available Redos
74 MODEL_EXPORT virtual bool canRedo();
75 //! Redoes last operation
76 MODEL_EXPORT virtual void redo();
77 //! Returns stack of performed operations
78 MODEL_EXPORT virtual std::list<std::string> undoList();
79 //! Returns stack of rolled back operations
80 MODEL_EXPORT virtual std::list<std::string> redoList();
82 /// Returns the root document of the application (that may contains sub-documents)
83 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> moduleDocument();
85 /// Returns the document by ID, loads if not loaded yet. Returns null if no such document.
86 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> document(int theDocID);
88 /// Return true if root document has been already created
89 MODEL_EXPORT virtual bool hasModuleDocument();
91 /// Returns the current document that used for current work in the application
92 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> activeDocument();
94 /// Defines the current document that used for current work in the application
95 MODEL_EXPORT virtual void setActiveDocument(
96 std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true);
98 /// Returns all the opened documents of the session (without postponed)
99 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments();
101 /// Returns true if document is not loaded yet
102 MODEL_EXPORT virtual bool isLoadByDemand(const std::string theDocID);
104 /// Registers the plugin that creates features.
105 /// It is obligatory for each plugin to call this function on loading to be found by
106 /// the plugin manager on call of the feature)
107 MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin);
109 /// Processes the configuration file reading
110 MODEL_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
112 /// Copies the document to the new one
113 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> copy(
114 std::shared_ptr<ModelAPI_Document> theSource, const int theDestID);
116 /// Returns the validators factory: the only one instance per application
117 MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();
119 /// Sets the flag to check modifications outside the transaction or not
120 void setCheckTransactions(const bool theCheck)
122 myCheckTransactions = theCheck;
125 /// Is called only once, on startup of the application
128 /// Returns the global identifier of the current transaction (needed for the update algo)
129 MODEL_EXPORT virtual int transactionID();
132 /// Loads (if not done yet) the information about the features and plugins
133 void LoadPluginsInfo();
135 /// Creates the feature object using plugins functionality
136 FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner);
138 friend class Model_Document;
139 friend class Model_Objects;