src/Model/Model_Session.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef Model_Session_H_
  22 #define Model_Session_H_
  23
  24 #include "Model.h"
  25 #include <ModelAPI_Session.h>
  26 #include <ModelAPI_Feature.h>
  27
  28 #include <Events_Listener.h>
  29 #include <map>
  30
  31 class Model_Document;
  32
  33 /**\class Model_Session
  34  * \ingroup DataModel
  35  * \brief Object that knows (from the initial XML file) which
  36  * plugin contains which feature, loads and stores reference to loaded plugins by
  37  * the feature functionality request.
  38  */
  39 class Model_Session : public ModelAPI_Session, public Events_Listener
  40 {
  41   bool myPluginsInfoLoaded;  ///< it true if plugins information is loaded
  42   /// map of feature IDs to plugin name and document kind
  43   std::map<std::string, std::pair<std::string, std::string> > myPlugins;
  44   std::map<std::string, ModelAPI_Plugin*> myPluginObjs;  ///< instances of the already plugins
  45   std::string myCurrentPluginName;  ///< name of the plugin that must be loaded currently
  46   std::shared_ptr<ModelAPI_Document> myCurrentDoc;  ///< current working document
  47    ///< map from plugin id to plugins which are used by it (must be loaded before this one)
  48   std::map<std::string, std::string> myUsePlugins;
  49
  50   /// if true, generates error if document is updated outside of transaction
  51   bool myCheckTransactions;
  52   bool myOperationAttachedToNext; ///< the current operation must be committed twice, with nested
  53  public:
  54
  55   //! Loads the OCAF document from the file.
  56   //! \param theFileName full name of the file to load
  57   //! \returns true if file was loaded successfully
  58   MODEL_EXPORT virtual bool load(const char* theFileName);
  59
  60   //! Saves the OCAF document to the file.
  61   //! \param theFileName full name of the file to store
  62   //! \param theResults the result full file names that were stored by "save"
  63   //! \returns true if file was stored successfully
  64   MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
  65
  66   //! Closes all documents
  67   MODEL_EXPORT virtual void closeAll();
  68
  69   //! Starts a new operation (opens a transaction)
  70   //! \param theId string-identifier of the started transaction
  71   //! \param theAttachedToNested if it is true,
  72   //!                            it means that this transaction is attached to the nested
  73   //!          where it is located and will be committed on the next commit with the nested
  74   MODEL_EXPORT virtual void startOperation(
  75     const std::string& theId = "", const bool theAttachedToNested = false);
  76   //! Finishes the previously started operation (closes the transaction)
  77   MODEL_EXPORT virtual void finishOperation();
  78   //! Aborts the operation
  79   MODEL_EXPORT virtual void abortOperation();
  80   //! Returns true if operation has been started, but not yet finished or aborted
  81   MODEL_EXPORT virtual bool isOperation();
  82   //! Returns true if document was modified (since creation/opening)
  83   MODEL_EXPORT virtual bool isModified();
  84
  85   //! Returns True if there are available Undos
  86   MODEL_EXPORT virtual bool canUndo();
  87   //! Undoes last operation
  88   MODEL_EXPORT virtual void undo();
  89   //! Returns True if there are available Redos
  90   MODEL_EXPORT virtual bool canRedo();
  91   //! Redoes last operation
  92   MODEL_EXPORT virtual void redo();
  93   //! Returns stack of performed operations
  94   MODEL_EXPORT virtual std::list<std::string> undoList();
  95   //! Returns stack of rolled back operations
  96   MODEL_EXPORT virtual std::list<std::string> redoList();
  97
  98   /// Returns the root document of the application (that may contains sub-documents)
  99   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> moduleDocument();
 100
 101   /// Returns the document by ID, loads if not loaded yet. Returns null if no such document.
 102   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> document(int theDocID);
 103
 104   /// Return true if root document has been already created
 105   MODEL_EXPORT virtual bool hasModuleDocument();
 106
 107   /// Returns the current document that used for current work in the application
 108   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> activeDocument();
 109
 110   /// Defines the current document that used for current work in the application
 111   MODEL_EXPORT virtual void setActiveDocument(
 112     std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true);
 113
 114   /// Returns all the opened documents of the session (without postponed)
 115   MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments();
 116
 117   /// Returns true if document is not loaded yet
 118   MODEL_EXPORT virtual bool isLoadByDemand(const std::string theDocID, const int theDocIndex);
 119
 120   /// Registers the plugin that creates features.
 121   /// It is obligatory for each plugin to call this function on loading to be found by
 122   /// the plugin manager on call of the feature)
 123   MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin);
 124
 125   /// Processes the configuration file reading
 126   MODEL_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 127
 128   /// Copies the document to the new one
 129   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> copy(
 130       std::shared_ptr<ModelAPI_Document> theSource, const int theDestID);
 131
 132   /// Returns the validators factory: the only one instance per application
 133   MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();
 134
 135   /// Sets the flag to check modifications outside the transaction or not
 136   void setCheckTransactions(const bool theCheck)
 137   {
 138     myCheckTransactions = theCheck;
 139   }
 140
 141   /// Is called only once, on startup of the application
 142   Model_Session();
 143
 144   /// Returns the global identifier of the current transaction (needed for the update algo)
 145   MODEL_EXPORT virtual int transactionID();
 146
 147
 148   /// Returns true if auto-update in the application is blocked
 149   MODEL_EXPORT virtual bool isAutoUpdateBlocked();
 150
 151   /// Set state of the auto-update of features result in the application
 152   MODEL_EXPORT virtual void blockAutoUpdate(const bool theBlock);
 153
 154  protected:
 155   /// Loads (if not done yet) the information about the features and plugins
 156   void LoadPluginsInfo();
 157
 158   /// Creates the feature object using plugins functionality
 159   FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner);
 160
 161   /// Get the plugin by name. If it is not loaded, load plugin.
 162   ModelAPI_Plugin* getPlugin(const std::string& thePluginName);
 163
 164   friend class Model_Document;
 165   friend class Model_Objects;
 166 };
 167
 168 #endif