Salome HOME
Update the doxygen documentation
[modules/shaper.git] / src / ModelAPI / ModelAPI_Session.h
index c97105421512fd83b16efbab28bdd012501b3666..619509dd2cfdeb97f5d75ec53db32c7556aed5c5 100644 (file)
@@ -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 <string>
 #include <list>
-#include <boost/shared_ptr.hpp>
+#include <memory>
 
 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<ModelAPI_Session> get();
+  static std::shared_ptr<ModelAPI_Session> 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,6 +41,9 @@ class MODELAPI_EXPORT ModelAPI_Session
   //! \returns true if file was stored successfully
   virtual bool save(const char* theFileName, std::list<std::string>& theResults) = 0;
 
+  //! Closes all documents
+  virtual void closeAll() = 0;
+
   //! Starts a new operation (opens a tansaction)
   virtual void startOperation() = 0;
   //! Finishes the previously started operation (closes the transaction)
@@ -66,31 +70,31 @@ 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<ModelAPI_Document> moduleDocument() = 0;
+  virtual std::shared_ptr<ModelAPI_Document> moduleDocument() = 0;
+
+  /// Returns the document by ID, loads if not loaded yet. Returns null if no such document.
+  virtual std::shared_ptr<ModelAPI_Document> document(std::string 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<ModelAPI_Document> activeDocument() = 0;
+  virtual std::shared_ptr<ModelAPI_Document> activeDocument() = 0;
 
   /// Defines the current document that used for current work in the application
   virtual void setActiveDocument(
-    boost::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true) = 0;
+    std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true) = 0;
 
   /// Returns all the opened documents of the session (without postponed)
-  virtual std::list<boost::shared_ptr<ModelAPI_Document> > allOpenedDocuments() = 0;
+  virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments() = 0;
 
   /// Copies the document to the new one with the given id
-  virtual boost::shared_ptr<ModelAPI_Document> copy(boost::shared_ptr<ModelAPI_Document> theSource,
+  virtual std::shared_ptr<ModelAPI_Document> copy(std::shared_ptr<ModelAPI_Document> 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()
   {
@@ -98,13 +102,13 @@ class MODELAPI_EXPORT ModelAPI_Session
 
  protected:
   /// Creates the feature object using plugins functionality
-  virtual boost::shared_ptr<ModelAPI_Feature> createFeature(std::string theFeatureID) = 0;
-
-  static void setSession(boost::shared_ptr<ModelAPI_Session> theManager);
+  virtual std::shared_ptr<ModelAPI_Feature> createFeature(std::string theFeatureID) = 0;
+  /// Sets the session interface implementation (once per application launch)
+  static void setSession(std::shared_ptr<ModelAPI_Session> theManager);
 
   friend class Model_Document;
 };
 
-typedef boost::shared_ptr<ModelAPI_Session> SessionPtr;
+typedef std::shared_ptr<ModelAPI_Session> SessionPtr;
 
 #endif