1 // File: Model_Session.hxx
2 // Created: 20 Mar 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef Model_Session_H_
6 #define Model_Session_H_
9 #include <ModelAPI_Session.h>
10 #include <ModelAPI_Feature.h>
12 #include <Events_Listener.h>
17 /**\class Model_Session
19 * \brief Object that knows (from the initial XML file) which
20 * plugin contains which feature, loads and stores reference to loaded plugins by
21 * the feature functionality request.
23 class Model_Session : public ModelAPI_Session, public Events_Listener
25 bool myPluginsInfoLoaded; ///< it true if plugins information is loaded
26 /// map of feature IDs to plugin name
27 std::map<std::string, std::string> myPlugins;
28 std::map<std::string, ModelAPI_Plugin*> myPluginObjs; ///< instances of the already plugins
29 std::string myCurrentPluginName; ///< name of the plugin that must be loaded currently
30 boost::shared_ptr<ModelAPI_Document> myCurrentDoc; ///< current working document
31 bool myCheckTransactions; ///< if true, generates error if document is updated outside of transaction
34 //! Loads the OCAF document from the file.
35 //! \param theFileName full name of the file to load
36 //! \param theStudyID identifier of the SALOME study to associate with loaded file
37 //! \returns true if file was loaded successfully
38 MODEL_EXPORT virtual bool load(const char* theFileName);
40 //! Saves the OCAF document to the file.
41 //! \param theFileName full name of the file to store
42 //! \param theResults the result full file names that were stored by "save"
43 //! \returns true if file was stored successfully
44 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
46 //! Starts a new operation (opens a tansaction)
47 MODEL_EXPORT virtual void startOperation();
48 //! Finishes the previously started operation (closes the transaction)
49 MODEL_EXPORT virtual void finishOperation();
50 //! Aborts the operation
51 MODEL_EXPORT virtual void abortOperation();
52 //! Returns true if operation has been started, but not yet finished or aborted
53 MODEL_EXPORT virtual bool isOperation();
54 //! Returns true if document was modified (since creation/opening)
55 MODEL_EXPORT virtual bool isModified();
57 //! Returns True if there are available Undos
58 MODEL_EXPORT virtual bool canUndo();
59 //! Undoes last operation
60 MODEL_EXPORT virtual void undo();
61 //! Returns True if there are available Redos
62 MODEL_EXPORT virtual bool canRedo();
63 //! Redoes last operation
64 MODEL_EXPORT virtual void redo();
66 /// Returns the root document of the application (that may contains sub-documents)
67 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Document> moduleDocument();
69 /// Return true if root document has been already created
70 MODEL_EXPORT virtual bool hasModuleDocument();
72 /// Returns the current document that used for current work in the application
73 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Document> activeDocument();
75 /// Defines the current document that used for current work in the application
76 MODEL_EXPORT virtual void setActiveDocument(boost::shared_ptr<ModelAPI_Document> theDoc);
78 /// Registers the plugin that creates features.
79 /// It is obligatory for each plugin to call this function on loading to be found by
80 /// the plugin manager on call of the feature)
81 MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin);
83 /// Processes the configuration file reading
84 MODEL_EXPORT virtual void processEvent(const Events_Message* theMessage);
86 /// Copies the document to the new one wit hthe given id
87 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Document> copy(
88 boost::shared_ptr<ModelAPI_Document> theSource, std::string theID);
90 /// Returns the validators factory: the only one instance per application
91 MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();
93 void setCheckTransactions(const bool theCheck)
95 myCheckTransactions = theCheck;
98 /// Is called only once, on startup of the application
102 /// Loads (if not done yet) the information about the features and plugins
103 void LoadPluginsInfo();
105 /// Creates the feature object using plugins functionality
106 virtual FeaturePtr createFeature(std::string theFeatureID);