X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Session.h;h=9dc711aba5f61f1ae34a9f0f30f7de24f60c1a9e;hb=88ee9b2b81cf93a6324336b57e30cc8a3a487499;hp=ebfef43d0f943958ea15e15b935723e3fa6c77da;hpb=96912644cf6607688466ac69f1f098fd2fff37b7;p=modules%2Fshaper.git diff --git a/src/Model/Model_Session.h b/src/Model/Model_Session.h index ebfef43d0..9dc711aba 100644 --- a/src/Model/Model_Session.h +++ b/src/Model/Model_Session.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: Model_Session.hxx -// Created: 20 Mar 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2022 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef Model_Session_H_ #define Model_Session_H_ @@ -14,6 +27,10 @@ #include #include +#ifdef TINSPECTOR +#include "Model_Application.h" +#endif + class Model_Document; /**\class Model_Session @@ -26,11 +43,18 @@ class Model_Session : public ModelAPI_Session, public Events_Listener { bool myPluginsInfoLoaded; ///< it true if plugins information is loaded /// map of feature IDs to plugin name and document kind - std::map > myPlugins; + std::map > myPlugins; std::map myPluginObjs; ///< instances of the already plugins std::string myCurrentPluginName; ///< name of the plugin that must be loaded currently std::shared_ptr myCurrentDoc; ///< current working document - bool myCheckTransactions; ///< if true, generates error if document is updated outside of transaction + ///< map from plugin id to plugins which are used by it (must be loaded before this one) + std::map myUsePlugins; + + /// if true, generates error if document is updated outside of transaction + bool myCheckTransactions; + /// if true, the current operation must be committed twice, + /// with nested (list for any nesting depth) + std::list myOperationAttachedToNext; public: //! Loads the OCAF document from the file. @@ -47,11 +71,16 @@ class Model_Session : public ModelAPI_Session, public Events_Listener //! Closes all documents MODEL_EXPORT virtual void closeAll(); - //! Starts a new operation (opens a tansaction) - MODEL_EXPORT virtual void startOperation(const std::string& theId = ""); + //! Starts a new operation (opens a transaction) + //! \param theId string-identifier of the started transaction + //! \param theAttachedToNested if it is true, + //! it means that this transaction is attached to the nested + //! where it is located and will be committed on the next commit with the nested + MODEL_EXPORT virtual void startOperation( + const std::string& theId = "", const bool theAttachedToNested = false); //! Finishes the previously started operation (closes the transaction) MODEL_EXPORT virtual void finishOperation(); - //! Aborts the operation + //! Aborts the operation MODEL_EXPORT virtual void abortOperation(); //! Returns true if operation has been started, but not yet finished or aborted MODEL_EXPORT virtual bool isOperation(); @@ -75,7 +104,7 @@ class Model_Session : public ModelAPI_Session, public Events_Listener MODEL_EXPORT virtual std::shared_ptr moduleDocument(); /// Returns the document by ID, loads if not loaded yet. Returns null if no such document. - MODEL_EXPORT virtual std::shared_ptr document(std::string theDocID); + MODEL_EXPORT virtual std::shared_ptr document(int theDocID); /// Return true if root document has been already created MODEL_EXPORT virtual bool hasModuleDocument(); @@ -90,21 +119,30 @@ class Model_Session : public ModelAPI_Session, public Events_Listener /// Returns all the opened documents of the session (without postponed) MODEL_EXPORT virtual std::list > allOpenedDocuments(); + /// Returns true if document is not loaded yet + MODEL_EXPORT virtual bool isLoadByDemand(const std::wstring theDocID, const int theDocIndex); + /// Registers the plugin that creates features. - /// It is obligatory for each plugin to call this function on loading to be found by + /// It is obligatory for each plugin to call this function on loading to be found by /// the plugin manager on call of the feature) MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin); + /// Verifies the license for the plugin is valid + MODEL_EXPORT virtual bool checkLicense(const std::string& thePluginName); + /// Processes the configuration file reading MODEL_EXPORT virtual void processEvent(const std::shared_ptr& theMessage); - /// Copies the document to the new one wit hthe given id + /// Copies the document to the new one MODEL_EXPORT virtual std::shared_ptr copy( - std::shared_ptr theSource, std::string theID); + std::shared_ptr theSource, const int theDestID); /// Returns the validators factory: the only one instance per application MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators(); + /// Returns the filters factory: the only one instance per application + MODEL_EXPORT virtual ModelAPI_FiltersFactory* filters(); + /// Sets the flag to check modifications outside the transaction or not void setCheckTransactions(const bool theCheck) { @@ -114,6 +152,22 @@ class Model_Session : public ModelAPI_Session, public Events_Listener /// Is called only once, on startup of the application Model_Session(); + /// Returns the global identifier of the current transaction (needed for the update algo) + MODEL_EXPORT virtual int transactionID(); + + + /// Returns true if auto-update in the application is blocked + MODEL_EXPORT virtual bool isAutoUpdateBlocked(); + + /// Set state of the auto-update of features result in the application + MODEL_EXPORT virtual void blockAutoUpdate(const bool theBlock); + +#ifdef TINSPECTOR + MODEL_EXPORT virtual Handle(TDocStd_Application) application() { + return Model_Application::getApplication(); + } +#endif + protected: /// Loads (if not done yet) the information about the features and plugins void LoadPluginsInfo(); @@ -121,6 +175,9 @@ class Model_Session : public ModelAPI_Session, public Events_Listener /// Creates the feature object using plugins functionality FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner); + /// Get the plugin by name. If it is not loaded, load plugin. + ModelAPI_Plugin* getPlugin(const std::string& thePluginName); + friend class Model_Document; friend class Model_Objects; };