-// File: Model_Document.hxx
-// Created: 28 Dec 2011
+// File: Model_Document.h
+// Created: 28 Feb 2014
// Author: Mikhail PONIKAROV
-// Copyright: CEA 2011
#ifndef Model_Document_HeaderFile
#define Model_Document_HeaderFile
#include <Model.h>
#include <ModelAPI_Document.h>
+
#include <TDocStd_Document.hxx>
+#include <map>
+#include <set>
class Handle_Model_Document;
/**\class Model_Document
* \ingroup DataModel
- * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
- * Document contains all data of te SALOME Study specific to this module
- * that must be written into the HDF file.
+ * \brief Document for internal data structure of any object storage.
+ * Document contains all data that must be stored/retrived in the file.
* Also it provides acces to this data: open/save, transactions management etc.
- * to provide access to all stored data.
*/
-
-class Model_Document: public TDocStd_Document, public ModelAPI_Document
+class Model_Document: public ModelAPI_Document
{
public:
- DEFINE_STANDARD_RTTI(Model_Document)
- ;
-
- //! Creates new document by the format string of a storage
- Model_Document(const TCollection_ExtendedString& theStorageFormat);
- //! Deletes all high-level data, managed this document
- ~Model_Document();
-
//! 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 bool Load(const char* theFileName);
+ MODEL_EXPORT virtual bool load(const char* theFileName);
//! Saves the OCAF document to the file.
//! \param theFileName full name of the file to store
//! \returns true if file was stored successfully
- MODEL_EXPORT bool Save(const char* theFileName);
+ MODEL_EXPORT virtual bool save(const char* theFileName);
//! Removes document data
- MODEL_EXPORT void Close();
+ MODEL_EXPORT virtual void close();
//! Starts a new operation (opens a tansaction)
- MODEL_EXPORT void StartOperation();
+ MODEL_EXPORT virtual void startOperation();
//! Finishes the previously started operation (closes the transaction)
- MODEL_EXPORT void FinishOperation();
+ //! Returns true if transaction in this document is not empty and really was performed
+ MODEL_EXPORT virtual void finishOperation();
//! Aborts the operation
- MODEL_EXPORT void AbortOperation();
+ MODEL_EXPORT virtual void abortOperation();
//! Returns true if operation has been started, but not yet finished or aborted
- MODEL_EXPORT bool IsOperation();
+ MODEL_EXPORT virtual bool isOperation();
//! Returns true if document was modified (since creation/opening)
- MODEL_EXPORT bool IsModified();
+ MODEL_EXPORT virtual bool isModified();
//! Returns True if there are available Undos
- MODEL_EXPORT bool CanUndo();
+ MODEL_EXPORT virtual bool canUndo();
//! Undoes last operation
- MODEL_EXPORT void Undo();
+ MODEL_EXPORT virtual void undo();
//! Returns True if there are available Redos
- MODEL_EXPORT bool CanRedo();
+ MODEL_EXPORT virtual bool canRedo();
//! Redoes last operation
- MODEL_EXPORT void Redo();
+ MODEL_EXPORT virtual void redo();
+
+ //! Adds to the document the new feature of the given feature id
+ //! \param creates feature and puts it in the document
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
+
+ //! Removes the feature from the document
+ MODEL_EXPORT virtual void removeFeature(boost::shared_ptr<ModelAPI_Feature> theFeature);
+
+ //! Returns the existing feature by the label
+ //! \param theLabel base label of the feature
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Feature> feature(TDF_Label& theLabel);
+
+ //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
+
+ ///! Returns the id of hte document
+ MODEL_EXPORT virtual const std::string& id() const {return myID;}
+
+ //! Returns the feature in the group by the index (started from zero)
+ //! \param theGroupID group that contains a feature
+ //! \param theIndex zero-based index of feature in the group
+ //! \param isOperation if it is true, returns feature (not Object)
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Feature>
+ feature(const std::string& theGroupID, const int theIndex, const bool isOperation = false);
+
+ //! Returns the number of features in the group
+ MODEL_EXPORT virtual int size(const std::string& theGroupID);
protected:
+ //! Returns (creates if needed) the group label
+ TDF_Label groupLabel(const std::string theGroup);
+
+ //! Initializes feature with a unique name in this group (unique name is generated as
+ //! feature type + "_" + index
+ void setUniqueName(boost::shared_ptr<ModelAPI_Feature> theFeature);
+
+ //! Adds to the document the new feature
+ void addFeature(const boost::shared_ptr<ModelAPI_Feature> theFeature);
+
+ //! Returns the object by the feature
+ boost::shared_ptr<ModelAPI_Feature> objectByFeature(
+ const boost::shared_ptr<ModelAPI_Feature> theFeature);
+
+ //! Synchronizes myFeatures list with the updated document
+ void synchronizeFeatures();
+
+ //! Creates new document with binary file format
+ Model_Document(const std::string theID);
+
+ Handle_TDocStd_Document document() {return myDoc;}
+
+ friend class Model_Application;
+ friend class Model_PluginManager;
+
private:
- int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
+ std::string myID; ///< identifier of the document in the application
+ Handle_TDocStd_Document myDoc; ///< OCAF document
+ /// number of transactions after the last "save" call, used for "IsModified" method
+ int myTransactionsAfterSave;
+ /// number of nested transactions performed (or -1 if not nested)
+ int myNestedNum;
+ /// All features managed by this document (not only in history of OB)
+ std::vector<boost::shared_ptr<ModelAPI_Feature> > myFeatures;
+
+ ///< set of identifiers of sub-documents of this document
+ std::set<std::string> mySubs;
+ /// transaction indexes (related to myTransactionsAfterSave) which were empty in this doc
+ std::map<int, bool> myIsEmptyTr;
};
-// Define handle class
-DEFINE_STANDARD_HANDLE(Model_Document, TDocStd_Document)
-
#endif
