X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Session.h;h=cc6987bd3653898a99c96d804776d1465d37fdff;hb=881cf7420dccf3c43837390efa9cded7b24836a2;hp=9f30af65833bfaadc902a12921bf9794cbfa03b4;hpb=f4f01be0d0f2642aaca4844b34c98a062e2afbb9;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Session.h b/src/ModelAPI/ModelAPI_Session.h index 9f30af658..cc6987bd3 100644 --- a/src/ModelAPI/ModelAPI_Session.h +++ b/src/ModelAPI/ModelAPI_Session.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Session.hxx // Created: 20 Mar 2014 // Author: Mikhail PONIKAROV @@ -8,7 +10,7 @@ #include "ModelAPI.h" #include #include -#include +#include class ModelAPI_Feature; class ModelAPI_Plugin; @@ -26,11 +28,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; @@ -43,11 +44,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; @@ -62,31 +68,41 @@ 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, bool theSendSignal = true) = 0; + std::shared_ptr theDoc, bool theSendSignal = true) = 0; /// Returns all the opened documents of the session (without postponed) - virtual std::list > allOpenedDocuments() = 0; + virtual std::list > allOpenedDocuments() = 0; + + /// Returns true if document is not loaded yet + virtual bool isLoadByDemand(const std::string theDocID) = 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; @@ -96,15 +112,17 @@ class MODELAPI_EXPORT 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; - static void setSession(boost::shared_ptr theManager); + /// Load plugin by its name + virtual void forceLoadPlugin(const std::string& thePluginName) = 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