X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Session.h;h=19172f3877389cb708f750595acd544f1d353b6e;hb=7ba8e2b57ff8965ae644b538c167b7b301e6e41b;hp=cc1494a13e7ff22d9545b5661dd330ff896ad17c;hpb=489132d99e1d417d5c7ce93fed8fb8ee138befbc;p=modules%2Fshaper.git diff --git a/src/Model/Model_Session.h b/src/Model/Model_Session.h index cc1494a13..19172f387 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 @@ -23,24 +25,67 @@ class Model_Document; class Model_Session : public ModelAPI_Session, public Events_Listener { bool myPluginsInfoLoaded; ///< it true if plugins information is loaded - /// map of feature IDs to plugin name - std::map myPlugins; + /// map of feature IDs to plugin name and document kind + 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 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); + + //! 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 + MODEL_EXPORT virtual bool save(const char* theFileName, std::list& theResults); + + //! Closes all documents + MODEL_EXPORT virtual void closeAll(); + + //! Starts a new operation (opens a tansaction) + MODEL_EXPORT virtual void startOperation(); + //! Finishes the previously started operation (closes the transaction) + MODEL_EXPORT virtual void finishOperation(); + //! Aborts the operation + MODEL_EXPORT virtual void abortOperation(); + //! Returns true if operation has been started, but not yet finished or aborted + MODEL_EXPORT virtual bool isOperation(); + //! Returns true if document was modified (since creation/opening) + MODEL_EXPORT virtual bool isModified(); + + //! Returns True if there are available Undos + MODEL_EXPORT virtual bool canUndo(); + //! Undoes last operation + MODEL_EXPORT virtual void undo(); + //! Returns True if there are available Redos + MODEL_EXPORT virtual bool canRedo(); + //! Redoes last operation + MODEL_EXPORT virtual void redo(); + /// Returns the root document of the application (that may contains sub-documents) - MODEL_EXPORT virtual boost::shared_ptr rootDocument(); + 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(std::string theDocID); /// Return true if root document has been already created - MODEL_EXPORT virtual bool hasRootDocument(); + MODEL_EXPORT virtual bool hasModuleDocument(); /// Returns the current document that used for current work in the application - MODEL_EXPORT virtual boost::shared_ptr currentDocument(); + MODEL_EXPORT virtual std::shared_ptr activeDocument(); /// Defines the current document that used for current work in the application - MODEL_EXPORT virtual void setCurrentDocument(boost::shared_ptr theDoc); + MODEL_EXPORT virtual void setActiveDocument( + std::shared_ptr theDoc, bool theSendSignal = true); + + /// Returns all the opened documents of the session (without postponed) + MODEL_EXPORT virtual std::list > allOpenedDocuments(); /// Registers the plugin that creates features. /// It is obligatory for each plugin to call this function on loading to be found by @@ -48,11 +93,11 @@ 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 Events_Message* 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); + MODEL_EXPORT virtual std::shared_ptr copy( + std::shared_ptr theSource, std::string theID); /// Returns the validators factory: the only one instance per application MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();