1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_Session.hxx
4 // Created: 20 Mar 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef ModelAPI_Session_H_
8 #define ModelAPI_Session_H_
15 class ModelAPI_Feature;
16 class ModelAPI_Plugin;
17 class ModelAPI_Document;
18 class ModelAPI_ValidatorsFactory;
20 /**\class ModelAPI_Session
22 * \brief Object that knows (from the initial XML file) which
23 * plugin contains which feature, loads and stores reference to loaded plugins by
24 * the feature functionality request.
27 class MODELAPI_EXPORT ModelAPI_Session
30 /// Returns the real implementation (the alone instance per application) of the plugin manager
31 static std::shared_ptr<ModelAPI_Session> get();
33 //! Loads the OCAF document from the file.
34 //! \param theFileName full name of the file to load
35 //! \returns true if file was loaded successfully
36 virtual bool load(const char* theFileName) = 0;
38 //! Saves the OCAF document to the file.
39 //! \param theFileName full name of the file to store
40 //! \param theResults the result full file names that were stored by "save"
41 //! \returns true if file was stored successfully
42 virtual bool save(const char* theFileName, std::list<std::string>& theResults) = 0;
44 //! Closes all documents
45 virtual void closeAll() = 0;
47 //! Starts a new operation (opens a tansaction)
48 virtual void startOperation() = 0;
49 //! Finishes the previously started operation (closes the transaction)
50 virtual void finishOperation() = 0;
51 //! Aborts the operation
52 virtual void abortOperation() = 0;
53 //! Returns true if operation has been started, but not yet finished or aborted
54 virtual bool isOperation() = 0;
55 //! Returns true if document was modified (since creation/opening)
56 virtual bool isModified() = 0;
58 //! Returns True if there are available Undos
59 virtual bool canUndo() = 0;
60 //! Undoes last operation
61 virtual void undo() = 0;
62 //! Returns True if there are available Redos
63 virtual bool canRedo() = 0;
64 //! Redoes last operation
65 virtual void redo() = 0;
67 /// Registers the plugin that creates features.
68 /// It is obligatory for each plugin to call this function on loading to be found by
69 /// the plugin manager on call of the feature)
70 virtual void registerPlugin(ModelAPI_Plugin* thePlugin) = 0;
72 /// Returns the root document of the application (that may contains sub-documents)
73 virtual std::shared_ptr<ModelAPI_Document> moduleDocument() = 0;
75 /// Returns the document by ID, loads if not loaded yet. Returns null if no such document.
76 virtual std::shared_ptr<ModelAPI_Document> document(std::string theDocID) = 0;
78 /// Return true if root document has been already created
79 virtual bool hasModuleDocument() = 0;
81 /// Returns the current document that used for current work in the application
82 virtual std::shared_ptr<ModelAPI_Document> activeDocument() = 0;
84 /// Defines the current document that used for current work in the application
85 virtual void setActiveDocument(
86 std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true) = 0;
88 /// Returns all the opened documents of the session (without postponed)
89 virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments() = 0;
91 /// Copies the document to the new one with the given id
92 virtual std::shared_ptr<ModelAPI_Document> copy(std::shared_ptr<ModelAPI_Document> theSource,
93 std::string theID) = 0;
95 /// Returns the validators factory: the only one instance per application
96 virtual ModelAPI_ValidatorsFactory* validators() = 0;
98 /// To virtually destroy the fields of successors
99 virtual ~ModelAPI_Session()
104 /// Creates the feature object using plugins functionality
105 virtual std::shared_ptr<ModelAPI_Feature> createFeature(std::string theFeatureID) = 0;
106 /// Sets the session interface implementation (once per application launch)
107 static void setSession(std::shared_ptr<ModelAPI_Session> theManager);
109 friend class Model_Document;
112 typedef std::shared_ptr<ModelAPI_Session> SessionPtr;