#include <Model.h>
#include <ModelAPI_Document.h>
+#include <ModelAPI_Feature.h>
+#include <ModelAPI_Result.h>
+
#include <TDocStd_Document.hxx>
+#include <NCollection_DataMap.hxx>
+#include <TDF_Label.hxx>
#include <map>
+#include <set>
class Handle_Model_Document;
+// for TDF_Label map usage
+static Standard_Integer HashCode(const TDF_Label& theLab,const Standard_Integer theUpper);
+static Standard_Boolean IsEqual(const TDF_Label& theLab1,const TDF_Label& theLab2);
+
/**\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 ModelAPI_Document
{
public:
//! \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 FeaturePtr addFeature(std::string theID);
- //! Adds to the document the new feature of the given group id
- //! \param theFeature a feature object that will be connected to the document in this method
- //! \param theGroupID identifier of the groups of objects (must be greater than zero)
- MODEL_EXPORT virtual void addFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
- const std::string theGroupID);
+ //! Removes the feature from the document (with result)
+ MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
//! Returns the existing feature by the label
//! \param theLabel base label of the feature
- MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> feature(TDF_Label& theLabel);
+ MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel);
- //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
- MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
+ //! Returns the existing object: result or feature
+ //! \param theLabel base label of the object
+ MODEL_EXPORT virtual ObjectPtr object(TDF_Label theLabel);
- //! Creates an iterator of the features by the specific groups
- MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Iterator> featuresIterator(
- const std::string theGroup);
+ //! 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)
- MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
- feature(const std::string& theGroupID, const int theIndex);
+ //! \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 ObjectPtr object(const std::string& theGroupID, const int theIndex);
+
+ //! Returns the number of features in the group
+ MODEL_EXPORT virtual int size(const std::string& theGroupID);
+
+ /// Creates a construction cresults
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
+ const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
+ /// Creates a body results
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultBody> createBody(
+ const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
+ /// Creates a part results
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultPart> createPart(
+ const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
+
+ //! Returns a feature by result (owner of result)
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Feature>
+ feature(const boost::shared_ptr<ModelAPI_Result>& theResult);
- ///! Returns the vector of groups already added to the document
- MODEL_EXPORT virtual const std::vector<std::string>& getGroups() const;
protected:
- //! Returns (creates if needed) the group label
- TDF_Label groupLabel(const std::string theGroup);
+ //! Returns (creates if needed) the features label
+ TDF_Label featuresLabel();
//! Initializes feature with a unique name in this group (unique name is generated as
//! feature type + "_" + index
- void setUniqueName(
- std::shared_ptr<ModelAPI_Feature> theFeature, const std::string theGroupID);
+ void setUniqueName(FeaturePtr theFeature);
+
+ //! Synchronizes myFeatures list with the updated document
+ void synchronizeFeatures(const bool theMarkUpdated = false);
//! Creates new document with binary file format
Model_Document(const std::string theID);
+ Handle_TDocStd_Document document() {return myDoc;}
+
+ //! performas compactification of all nested operations into one
+ void compactNested();
+
+ //! Initializes the data fields of the feature
+ void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
+
+ //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
+ MODEL_EXPORT virtual void storeResult(boost::shared_ptr<ModelAPI_Data> theFeatureData,
+ boost::shared_ptr<ModelAPI_Result> theResult, const int theResultIndex = 0);
+
+
friend class Model_Application;
+ friend class Model_PluginManager;
+ friend class DFBrowser;
private:
std::string myID; ///< identifier of the document in the application
Handle_TDocStd_Document myDoc; ///< OCAF document
- int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
- std::map<std::string, TDF_Label> myGroups; ///< root labels of the features groups identified by names
- std::vector<std::string> myGroupsNames; ///< names of added groups to the 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)
+ /// For optimization mapped by labels
+ NCollection_DataMap<TDF_Label, FeaturePtr> myObjs;
+
+ ///< 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;
};
#endif
