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
33 bool myCheckTransactions; ///< if true, generates error if document is updated outside of transaction
34 bool myOperationAttachedToNext; ///< the current operation must be commited twice, with nested
37 //! Loads the OCAF document from the file.
38 //! \param theFileName full name of the file to load
39 //! \returns true if file was loaded successfully
40 MODEL_EXPORT virtual bool load(const char* theFileName);
42 //! Saves the OCAF document to the file.
43 //! \param theFileName full name of the file to store
44 //! \param theResults the result full file names that were stored by "save"
45 //! \returns true if file was stored successfully
46 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
48 //! Closes all documents
49 MODEL_EXPORT virtual void closeAll();
51 //! Starts a new operation (opens a tansaction)
52 //! \param theAttachedToNested if it is true, it means that this transaction is attached to the nested
53 //! where it is located and will be commited on the next commit with the nested
54 MODEL_EXPORT virtual void startOperation(
55 const std::string& theId = "", const bool theAttachedToNested = false);
56 //! Finishes the previously started operation (closes the transaction)
57 MODEL_EXPORT virtual void finishOperation();
58 //! Aborts the operation
59 MODEL_EXPORT virtual void abortOperation();
60 //! Returns true if operation has been started, but not yet finished or aborted
61 MODEL_EXPORT virtual bool isOperation();
62 //! Returns true if document was modified (since creation/opening)
63 MODEL_EXPORT virtual bool isModified();
65 //! Returns True if there are available Undos
66 MODEL_EXPORT virtual bool canUndo();
67 //! Undoes last operation
68 MODEL_EXPORT virtual void undo();
69 //! Returns True if there are available Redos
70 MODEL_EXPORT virtual bool canRedo();
71 //! Redoes last operation
72 MODEL_EXPORT virtual void redo();
73 //! Returns stack of performed operations
74 MODEL_EXPORT virtual std::list<std::string> undoList();
75 //! Returns stack of rolled back operations
76 MODEL_EXPORT virtual std::list<std::string> redoList();
78 /// Returns the root document of the application (that may contains sub-documents)
79 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> moduleDocument();
81 /// Returns the document by ID, loads if not loaded yet. Returns null if no such document.
82 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> document(std::string theDocID);
84 /// Return true if root document has been already created
85 MODEL_EXPORT virtual bool hasModuleDocument();
87 /// Returns the current document that used for current work in the application
88 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> activeDocument();
90 /// Defines the current document that used for current work in the application
91 MODEL_EXPORT virtual void setActiveDocument(
92 std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true);
94 /// Returns all the opened documents of the session (without postponed)
95 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments();
97 /// Returns true if document is not loaded yet
98 MODEL_EXPORT virtual bool isLoadByDemand(const std::string theDocID);
100 /// Registers the plugin that creates features.
101 /// It is obligatory for each plugin to call this function on loading to be found by
102 /// the plugin manager on call of the feature)
103 MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin);
105 /// Processes the configuration file reading
106 MODEL_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
108 /// Copies the document to the new one wit hthe given id
109 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> copy(
110 std::shared_ptr<ModelAPI_Document> theSource, std::string theID);
112 /// Returns the validators factory: the only one instance per application
113 MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();
115 /// Sets the flag to check modifications outside the transaction or not
116 void setCheckTransactions(const bool theCheck)
118 myCheckTransactions = theCheck;
121 /// Is called only once, on startup of the application
124 /// Returns the global identifier of the current transaction (needed for the update algo)
125 MODEL_EXPORT virtual int transactionID();
128 /// Loads (if not done yet) the information about the features and plugins
129 void LoadPluginsInfo();
131 /// Creates the feature object using plugins functionality
132 FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner);
134 friend class Model_Document;
135 friend class Model_Objects;