X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Session.h;h=f31928620f78a87febc82bfbe2366db719a99524;hb=530f5aff42069e844c4a4ef164088ea23ba0e2dd;hp=fd4f9c0b5ac3e35a1800082dbba8b67bf2036521;hpb=67e9407be59cbfa36082e09f077f9da274c25bfe;p=modules%2Fshaper.git diff --git a/src/Model/Model_Session.h b/src/Model/Model_Session.h index fd4f9c0b5..f31928620 100644 --- a/src/Model/Model_Session.h +++ b/src/Model/Model_Session.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: Model_Session.hxx // Created: 20 Mar 2014 // Author: Mikhail PONIKAROV @@ -27,13 +29,13 @@ class Model_Session : public ModelAPI_Session, public Events_Listener std::map > myPlugins; std::map myPluginObjs; ///< instances of the already plugins std::string myCurrentPluginName; ///< name of the plugin that must be loaded currently - boost::shared_ptr myCurrentDoc; ///< current working document + std::shared_ptr myCurrentDoc; ///< current working document bool myCheckTransactions; ///< if true, generates error if document is updated outside of transaction + bool myOperationAttachedToNext; ///< the current operation must be committed twice, with nested public: //! 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 MODEL_EXPORT virtual bool load(const char* theFileName); @@ -43,8 +45,15 @@ class Model_Session : public ModelAPI_Session, public Events_Listener //! \returns true if file was stored successfully MODEL_EXPORT virtual bool save(const char* theFileName, std::list& theResults); - //! Starts a new operation (opens a tansaction) - MODEL_EXPORT virtual void startOperation(); + //! Closes all documents + MODEL_EXPORT virtual void closeAll(); + + //! 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 @@ -62,22 +71,32 @@ class Model_Session : public ModelAPI_Session, public Events_Listener MODEL_EXPORT virtual bool canRedo(); //! Redoes last operation MODEL_EXPORT virtual void redo(); + //! Returns stack of performed operations + MODEL_EXPORT virtual std::list undoList(); + //! Returns stack of rolled back operations + MODEL_EXPORT virtual std::list redoList(); /// Returns the root document of the application (that may contains sub-documents) - MODEL_EXPORT virtual boost::shared_ptr moduleDocument(); + 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(int theDocID); /// Return true if root document has been already created MODEL_EXPORT virtual bool hasModuleDocument(); /// Returns the current document that used for current work in the application - MODEL_EXPORT virtual boost::shared_ptr activeDocument(); + MODEL_EXPORT virtual std::shared_ptr activeDocument(); /// Defines the current document that used for current work in the application MODEL_EXPORT virtual void setActiveDocument( - boost::shared_ptr theDoc, bool theSendSignal = true); + std::shared_ptr theDoc, bool theSendSignal = true); /// Returns all the opened documents of the session (without postponed) - MODEL_EXPORT virtual std::list > allOpenedDocuments(); + MODEL_EXPORT virtual std::list > allOpenedDocuments(); + + /// Returns true if document is not loaded yet + MODEL_EXPORT virtual bool isLoadByDemand(const std::string theDocID); /// Registers the plugin that creates features. /// It is obligatory for each plugin to call this function on loading to be found by @@ -85,15 +104,16 @@ class Model_Session : public ModelAPI_Session, public Events_Listener MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin); /// Processes the configuration file reading - MODEL_EXPORT virtual void processEvent(const boost::shared_ptr& theMessage); + MODEL_EXPORT virtual void processEvent(const std::shared_ptr& theMessage); - /// Copies the document to the new one wit hthe given id - MODEL_EXPORT virtual boost::shared_ptr copy( - boost::shared_ptr theSource, std::string theID); + /// Copies the document to the new one + MODEL_EXPORT virtual std::shared_ptr copy( + std::shared_ptr theSource, const int theDestID); /// Returns the validators factory: the only one instance per application MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators(); + /// Sets the flag to check modifications outside the transaction or not void setCheckTransactions(const bool theCheck) { myCheckTransactions = theCheck; @@ -102,12 +122,18 @@ 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(); + protected: /// Loads (if not done yet) the information about the features and plugins void LoadPluginsInfo(); /// Creates the feature object using plugins functionality - virtual FeaturePtr createFeature(std::string theFeatureID); + FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner); + + friend class Model_Document; + friend class Model_Objects; }; #endif