X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Session.h;h=2f778aa2e6ee6b9e2859338e41e7e5676c36d281;hb=54af887c1203416f38576cbdbcde6e539142a079;hp=0c6df4987d33b99d70c7c5a3dccfc5633137ed49;hpb=489132d99e1d417d5c7ce93fed8fb8ee138befbc;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Session.h b/src/ModelAPI/ModelAPI_Session.h index 0c6df4987..2f778aa2e 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 @@ -7,7 +9,8 @@ #include "ModelAPI.h" #include -#include +#include +#include class ModelAPI_Feature; class ModelAPI_Plugin; @@ -25,7 +28,49 @@ 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 + //! \returns true if file was loaded successfully + virtual bool load(const char* theFileName) = 0; + + //! 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" + //! \returns true if file was stored successfully + virtual bool save(const char* theFileName, std::list& theResults) = 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 commited 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 + virtual void abortOperation() = 0; + //! Returns true if operation has been started, but not yet finished or aborted + virtual bool isOperation() = 0; + //! Returns true if document was modified (since creation/opening) + virtual bool isModified() = 0; + + //! Returns True if there are available Undos + virtual bool canUndo() = 0; + //! Undoes last operation + virtual void undo() = 0; + //! Returns True if there are available Redos + 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 @@ -33,41 +78,47 @@ class MODELAPI_EXPORT ModelAPI_Session virtual void registerPlugin(ModelAPI_Plugin* thePlugin) = 0; /// Returns the root document of the application (that may contains sub-documents) - virtual boost::shared_ptr rootDocument() = 0; + 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; /// Return true if root document has been already created - virtual bool hasRootDocument() = 0; + virtual bool hasModuleDocument() = 0; /// Returns the current document that used for current work in the application - virtual boost::shared_ptr currentDocument() = 0; + virtual std::shared_ptr activeDocument() = 0; /// Defines the current document that used for current work in the application - virtual void setCurrentDocument(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::string theDocID) = 0; /// Copies the document to the new one with the given id - virtual boost::shared_ptr copy(boost::shared_ptr theSource, + virtual std::shared_ptr copy(std::shared_ptr theSource, std::string theID) = 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(); - /// 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; - - static void setSession(boost::shared_ptr theManager); + /// Returns the global identifier of the current transaction (needed for the update algo) + virtual int transactionID() = 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