// Created: 28 Feb 2014
// Author: Mikhail PONIKAROV
-#ifndef Model_Document_HeaderFile
-#define Model_Document_HeaderFile
+#ifndef Model_Document_H_
+#define Model_Document_H_
#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.
* Document contains all data that must be stored/retrived in the file.
* Also it provides acces to this data: open/save, transactions management etc.
*/
-class Model_Document: public ModelAPI_Document
+class Model_Document : public ModelAPI_Document
{
-public:
+ public:
+ //! Returns the kind of the document: "PartSet", "Part", or something else.
+ //! This kind is used for feature buttons enable/disable depending on active document
+ //! (it uses workbench "document" identifier in XML configuration file for this)
+ MODEL_EXPORT virtual const std::string& kind() const {return myKind;}
//! Loads the OCAF document from the file.
//! \param theFileName full name of the file to load
//! 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);
+ MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
//! Removes document data
MODEL_EXPORT virtual void close();
//! 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);
+ MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID);
+
+ //! Removes the feature from the document (with result)
+ //! \param theCheck if it is false, do not check the references
+ MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature, const bool theCheck = true);
//! 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);
+ MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel);
+
+ //! Returns the existing object: result or feature
+ //! \param theLabel base label of the object
+ MODEL_EXPORT virtual ObjectPtr object(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);
+ //! Internal sub-document by ID
+ MODEL_EXPORT virtual boost::shared_ptr<Model_Document> subDoc(std::string theDocID);
+
///! Returns the id of hte document
- MODEL_EXPORT virtual const std::string& id() const {return myID;}
+ 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 boost::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)
+ //! \param theHidden if it is true, it counts also the features that are not in tree
+ MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex,
+ const bool theHidden = false);
//! Returns the number of features in the group
- MODEL_EXPORT virtual int size(const std::string& theGroupID);
+ //! If theHidden is true, it counts also the features that are not in tree
+ MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false);
+
+ /// 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);
+ /// Creates a group results
+ MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultGroup> createGroup(
+ 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 true if parametric updater need to execute feature on recomputartion
+ ///! On abort, undo or redo it is not necessary: results in document are updated automatically
+ bool executeFeatures() {return myExecuteFeatures;}
+
+ protected:
+
+ //! Returns (creates if needed) the features label
+ TDF_Label featuresLabel();
- ///! Returns the vector of groups already added to the document
- MODEL_EXPORT virtual const std::vector<std::string>& getGroups() const;
+ //! Initializes feature with a unique name in this group (unique name is generated as
+ //! feature type + "_" + index
+ void setUniqueName(FeaturePtr theFeature);
- //! Returns the index of feature in the group (zero based)
- //! \retruns -1 if not found
- MODEL_EXPORT virtual int featureIndex(boost::shared_ptr<ModelAPI_Feature> theFeature);
+ //! Synchronizes myFeatures list with the updated document
+ //! \param theMarkUpdated causes the "update" event for all features
+ //! \param theUpdateReferences causes the update of back-references
+ void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences);
+ //! Synchronizes the BackReferences list in Data of Features and Results
+ void synchronizeBackRefs();
-protected:
+ //! Creates new document with binary file format
+ Model_Document(const std::string theID, const std::string theKind);
- //! Returns (creates if needed) the group label
- TDF_Label groupLabel(const std::string theGroup);
+ Handle_TDocStd_Document document()
+ {
+ return myDoc;
+ }
- //! 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);
+ //! performs compactification of all nested operations into one
+ //! \returns true if resulting transaction is not empty and can be undoed
+ bool compactNested();
- //! Adds to the document the new feature
- void addFeature(const boost::shared_ptr<ModelAPI_Feature> theFeature);
+ //! Initializes the data fields of the feature
+ void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
- //! Synchronizes myGroups, myGroupsNames, myFeatures and mySubs list with the updated document
- void synchronizeFeatures();
+ //! 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);
- //! Creates new document with binary file format
- Model_Document(const std::string theID);
+ //! returns the label of result by index; creates this label if it was not created before
+ TDF_Label resultLabel(const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
- friend class Model_Application;
+ //! Updates the results list of the feature basing on the current data tree
+ void updateResults(FeaturePtr theFeature);
+
+ //! Returns all sub documents
+ const std::set<std::string>& subDocuments() const {return mySubs;}
-private:
- std::string myID; ///< identifier of the document in the application
- Handle_TDocStd_Document myDoc; ///< OCAF document
+ friend class Model_Application;
+ friend class Model_Session;
+ friend class Model_AttributeReference;
+ friend class DFBrowser;
+
+ private:
+ std::string myID; ///< identifier of the document in the application
+ std::string myKind; ///< kind 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 myTransactionsAfterSave for the nested transaction start
- int myNestedStart;
- /// root labels of the features groups identified by names
- std::map<std::string, TDF_Label> myGroups;
- std::vector<std::string> myGroupsNames; ///< names of added groups to the document
- /// Features managed by this document: by group name
- std::map<std::string, std::vector<boost::shared_ptr<ModelAPI_Feature> > > myFeatures;
- std::set<std::string> mySubs; ///< set of identifiers of sub-documents of this document
+ /// 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;
+ /// If it is true, features are not executed on update (on abort, undo, redo)
+ bool myExecuteFeatures;
};
#endif