+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
// File: ModelAPI_Session.hxx
// Created: 20 Mar 2014
// Author: Mikhail PONIKAROV
#include "ModelAPI.h"
#include <string>
-#include <boost/shared_ptr.hpp>
+#include <list>
+#include <memory>
class ModelAPI_Feature;
class ModelAPI_Plugin;
{
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
+ //! \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<std::string>& 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<std::string> undoList() = 0;
+ //! Returns stack of rolled back operations (from last rolled back to first)
+ virtual std::list<std::string> redoList() = 0;
/// Registers the plugin that creates features.
/// It is obligatory for each plugin to call this function on loading to be found by
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> rootDocument() = 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 hasRootDocument() = 0;
+ virtual bool hasModuleDocument() = 0;
/// Returns the current document that used for current work in the application
- virtual boost::shared_ptr<ModelAPI_Document> currentDocument() = 0;
+ virtual std::shared_ptr<ModelAPI_Document> activeDocument() = 0;
/// Defines the current document that used for current work in the application
- virtual void setCurrentDocument(boost::shared_ptr<ModelAPI_Document> theDoc) = 0;
+ virtual void setActiveDocument(
+ std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true) = 0;
+
+ /// Returns all the opened documents of the session (without postponed)
+ virtual std::list<std::shared_ptr<ModelAPI_Document> > 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<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()
{
}
- 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);
+ /// 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<ModelAPI_Session> theManager);
};
-typedef boost::shared_ptr<ModelAPI_Session> SessionPtr;
+typedef std::shared_ptr<ModelAPI_Session> SessionPtr;
#endif
