]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelAPI/ModelAPI_Session.h
Salome HOME
Issue #2052: Modification of parameters don't work (sketch, extrusion)
[modules/shaper.git] / src / ModelAPI / ModelAPI_Session.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        ModelAPI_Session.hxx
4 // Created:     20 Mar 2014
5 // Author:      Mikhail PONIKAROV
6
7 #ifndef ModelAPI_Session_H_
8 #define ModelAPI_Session_H_
9
10 #include "ModelAPI.h"
11 #include <string>
12 #include <list>
13 #include <memory>
14
15 class ModelAPI_Feature;
16 class ModelAPI_Plugin;
17 class ModelAPI_Document;
18 class ModelAPI_ValidatorsFactory;
19
20 /**\class ModelAPI_Session
21  * \ingroup DataModel
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.
25  */
26
27 class MODELAPI_EXPORT ModelAPI_Session
28 {
29  public:
30   /// Returns the real implementation (the alone instance per application) of the plugin manager
31   static std::shared_ptr<ModelAPI_Session> get();
32
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;
37
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;
43
44   //! Closes all documents
45   virtual void closeAll() = 0;
46
47   //! Starts a new operation (opens a transaction)
48   //! \param theId of operation for history (optional)
49   //! \param theAttachedToNested if it is true,
50   //!          it means that this transaction is attached to the nested
51   //!          where it is located and will be committed on the next commit with the nested
52   virtual void startOperation(
53     const std::string& theId = "", const bool theAttachedToNested = false) = 0;
54   //! Finishes the previously started operation (closes the transaction)
55   virtual void finishOperation() = 0;
56   //! Aborts the operation
57   virtual void abortOperation() = 0;
58   //! Returns true if operation has been started, but not yet finished or aborted
59   virtual bool isOperation() = 0;
60   //! Returns true if document was modified (since creation/opening)
61   virtual bool isModified() = 0;
62
63   //! Returns True if there are available Undos
64   virtual bool canUndo() = 0;
65   //! Undoes last operation
66   virtual void undo() = 0;
67   //! Returns True if there are available Redos
68   virtual bool canRedo() = 0;
69   //! Redoes last operation
70   virtual void redo() = 0;
71   //! Returns stack of performed operations (from last to first)
72   virtual std::list<std::string> undoList() = 0;
73   //! Returns stack of rolled back operations (from last rolled back to first)
74   virtual std::list<std::string> redoList() = 0;
75
76   /// Registers the plugin that creates features.
77   /// It is obligatory for each plugin to call this function on loading to be found by
78   /// the plugin manager on call of the feature)
79   virtual void registerPlugin(ModelAPI_Plugin* thePlugin) = 0;
80
81   /// Returns the root document of the application (that may contains sub-documents)
82   virtual std::shared_ptr<ModelAPI_Document> moduleDocument() = 0;
83
84   /// Returns the document by ID. Returns null if no such document.
85   virtual std::shared_ptr<ModelAPI_Document> document(int theDocID) = 0;
86
87   /// Return true if root document has been already created
88   virtual bool hasModuleDocument() = 0;
89
90   /// Returns the current document that used for current work in the application
91   virtual std::shared_ptr<ModelAPI_Document> activeDocument() = 0;
92
93   /// Defines the current document that used for current work in the application
94   virtual void setActiveDocument(
95     std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true) = 0;
96
97   /// Returns all the opened documents of the session (without postponed)
98   virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments() = 0;
99
100   /// Returns true if document is not loaded yet
101   virtual bool isLoadByDemand(const std::string theDocID) = 0;
102
103   /// Copies the document to the new one with the given id
104   virtual std::shared_ptr<ModelAPI_Document> copy(
105     std::shared_ptr<ModelAPI_Document> theSource, const int theDestID) =0;
106
107   /// Returns the validators factory: the only one instance per application
108   virtual ModelAPI_ValidatorsFactory* validators() = 0;
109
110   /// To virtually destroy the fields of successors
111   virtual ~ModelAPI_Session()
112   {
113   }
114
115   /// Returns the global identifier of the current transaction (needed for the update algo)
116   virtual int transactionID() = 0;
117
118  protected:
119   /// Sets the session interface implementation (once per application launch)
120   static void setSession(std::shared_ptr<ModelAPI_Session> theManager);
121 };
122
123 typedef std::shared_ptr<ModelAPI_Session> SessionPtr;
124
125 #endif