X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2FModelAPI%2FModelAPI_Session.h;h=0e1a2a880d43414fa3ced2b412012d4095637a03;hb=fc72d43b677baa05ae7fd317346fd8b723b799ed;hp=619509dd2cfdeb97f5d75ec53db32c7556aed5c5;hpb=db0e21ea2f1117dd9af3320009ba8b50dc2e828b;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Session.h b/src/ModelAPI/ModelAPI_Session.h index 619509dd2..0e1a2a880 100644 --- a/src/ModelAPI/ModelAPI_Session.h +++ b/src/ModelAPI/ModelAPI_Session.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_Session.hxx -// Created: 20 Mar 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2023 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 ModelAPI_Session_H_ #define ModelAPI_Session_H_ @@ -16,6 +29,7 @@ class ModelAPI_Feature; class ModelAPI_Plugin; class ModelAPI_Document; class ModelAPI_ValidatorsFactory; +class ModelAPI_FiltersFactory; /**\class ModelAPI_Session * \ingroup DataModel @@ -26,6 +40,9 @@ class ModelAPI_ValidatorsFactory; class MODELAPI_EXPORT ModelAPI_Session { +protected: + bool myIsLoading; ///< keeps the state of the loading of the document + public: /// Returns the real implementation (the alone instance per application) of the plugin manager static std::shared_ptr get(); @@ -35,6 +52,9 @@ class MODELAPI_EXPORT ModelAPI_Session //! \returns true if file was loaded successfully virtual bool load(const char* theFileName) = 0; + //! Returns true if a loading process is performed (so, no need to react on a new part creation) + virtual bool isLoading() { return myIsLoading; }; + //! Saves the OCAF document to the file. //! \param theFileName full name of the file to store //! \param theResults the result full file names that were stored by "save" @@ -44,11 +64,16 @@ class MODELAPI_EXPORT ModelAPI_Session //! Closes all documents virtual void closeAll() = 0; - //! Starts a new operation (opens a tansaction) - virtual void startOperation() = 0; + //! Starts a new operation (opens a transaction) + //! \param theId of operation for history (optional) + //! \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 + virtual void startOperation( + const std::string& theId = "", const bool theAttachedToNested = false) = 0; //! Finishes the previously started operation (closes the transaction) virtual void finishOperation() = 0; - //! Aborts the operation + //! Aborts the operation virtual void abortOperation() = 0; //! Returns true if operation has been started, but not yet finished or aborted virtual bool isOperation() = 0; @@ -63,17 +88,26 @@ class MODELAPI_EXPORT ModelAPI_Session virtual bool canRedo() = 0; //! Redoes last operation virtual void redo() = 0; + //! Returns stack of performed operations (from last to first) + virtual std::list undoList() = 0; + //! Returns stack of rolled back operations (from last rolled back to first) + virtual std::list redoList() = 0; + //! Clears undo and redo lists of all documents in the session + virtual void clearUndoRedo() = 0; /// 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) virtual void registerPlugin(ModelAPI_Plugin* thePlugin) = 0; + /// Verifies the license for the plugin is valid + virtual bool checkLicense(const std::string& thePluginName) = 0; + /// Returns the root document of the application (that may contains sub-documents) virtual std::shared_ptr moduleDocument() = 0; - /// Returns the document by ID, loads if not loaded yet. Returns null if no such document. - virtual std::shared_ptr document(std::string theDocID) = 0; + /// Returns the document by ID. Returns null if no such document. + virtual std::shared_ptr document(int theDocID) = 0; /// Return true if root document has been already created virtual bool hasModuleDocument() = 0; @@ -88,25 +122,36 @@ class MODELAPI_EXPORT ModelAPI_Session /// Returns all the opened documents of the session (without postponed) virtual std::list > allOpenedDocuments() = 0; + /// Returns true if document is not loaded yet + virtual bool isLoadByDemand(const std::wstring theDocID, const int theDocIndex) = 0; + /// Copies the document to the new one with the given id - virtual std::shared_ptr copy(std::shared_ptr theSource, - std::string theID) = 0; + virtual std::shared_ptr copy( + std::shared_ptr theSource, const int theDestID) =0; /// Returns the validators factory: the only one instance per application virtual ModelAPI_ValidatorsFactory* validators() = 0; + /// Returns the filters factory: the only one instance per application + virtual ModelAPI_FiltersFactory* filters() = 0; + /// To virtually destroy the fields of successors virtual ~ModelAPI_Session() { } + /// Returns the global identifier of the current transaction (needed for the update algo) + virtual int transactionID() = 0; + + /// Returns true if auto-update in the application is blocked + virtual bool isAutoUpdateBlocked() = 0; + + /// Set state of the auto-update of features result in the application + virtual void blockAutoUpdate(const bool theBlock) = 0; + protected: - /// Creates the feature object using plugins functionality - virtual std::shared_ptr createFeature(std::string theFeatureID) = 0; /// Sets the session interface implementation (once per application launch) static void setSession(std::shared_ptr theManager); - - friend class Model_Document; }; typedef std::shared_ptr SessionPtr;