X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Session.h;h=fae2a9e97bc2b415a35fc4692e6f8f0b731a2fc0;hb=f14192492e36f4febc93b2ad7ab7f866cbbdf71b;hp=54e807693d9ac7032af15e0f6e1aad3f7828a754;hpb=15822811a0c323a95d1a6ac80fcbe3481988b4f0;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Session.h b/src/ModelAPI/ModelAPI_Session.h index 54e807693..fae2a9e97 100644 --- a/src/ModelAPI/ModelAPI_Session.h +++ b/src/ModelAPI/ModelAPI_Session.h @@ -1,6 +1,21 @@ -// File: ModelAPI_Session.hxx -// Created: 20 Mar 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2019 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_ @@ -8,12 +23,13 @@ #include "ModelAPI.h" #include #include -#include +#include class ModelAPI_Feature; class ModelAPI_Plugin; class ModelAPI_Document; class ModelAPI_ValidatorsFactory; +class ModelAPI_FiltersFactory; /**\class ModelAPI_Session * \ingroup DataModel @@ -26,11 +42,10 @@ class MODELAPI_EXPORT ModelAPI_Session { public: /// Returns the real implementation (the alone instance per application) of the plugin manager - static boost::shared_ptr get(); + static std::shared_ptr get(); //! Loads the OCAF document from the file. //! \param theFileName full name of the file to load - //! \param theStudyID identifier of the SALOME study to associate with loaded file //! \returns true if file was loaded successfully virtual bool load(const char* theFileName) = 0; @@ -40,11 +55,19 @@ class MODELAPI_EXPORT ModelAPI_Session //! \returns true if file was stored successfully virtual bool save(const char* theFileName, std::list& theResults) = 0; - //! Starts a new operation (opens a tansaction) - virtual void startOperation() = 0; + //! Closes all documents + virtual void closeAll() = 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; @@ -59,48 +82,67 @@ 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; /// 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; /// Returns the root document of the application (that may contains sub-documents) - virtual boost::shared_ptr moduleDocument() = 0; + virtual std::shared_ptr moduleDocument() = 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; /// Returns the current document that used for current work in the application - virtual boost::shared_ptr activeDocument() = 0; + virtual std::shared_ptr activeDocument() = 0; /// Defines the current document that used for current work in the application - virtual void setActiveDocument(boost::shared_ptr theDoc) = 0; + virtual void setActiveDocument( + std::shared_ptr theDoc, bool theSendSignal = true) = 0; + + /// 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 boost::shared_ptr copy(boost::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; - /// Is needed for python wrapping by swig, call Get to get an instance - ModelAPI_Session(); + /// 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() { } - protected: - /// Creates the feature object using plugins functionality - virtual boost::shared_ptr createFeature(std::string theFeatureID) = 0; + /// 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; - static void setSession(boost::shared_ptr theManager); + /// Set state of the auto-update of features result in the application + virtual void blockAutoUpdate(const bool theBlock) = 0; - friend class Model_Document; + protected: + /// Sets the session interface implementation (once per application launch) + static void setSession(std::shared_ptr theManager); }; -typedef boost::shared_ptr SessionPtr; +typedef std::shared_ptr SessionPtr; #endif