Salome HOME
Merge branch 'master' of newgeom:newgeom.git
[modules/shaper.git] / src / Model / Model_Document.h
index b314d9dc896c1bd9ca4f5081dd3008a3c32fa58e..340ecd4ccf9d662be95224b9c883686c01a1ac99 100644 (file)
@@ -7,13 +7,21 @@
 
 #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.
@@ -61,11 +69,18 @@ public:
 
   //! 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)
+  MODEL_EXPORT virtual void removeFeature(FeaturePtr 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);
+  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);
@@ -74,54 +89,76 @@ public:
   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)
+  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);
 
-  ///! Returns the vector of groups already added to the document
-  MODEL_EXPORT virtual const std::vector<std::string>& getGroups() const;
+  /// 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 index of feature in the group (zero based)
-  //! \retruns -1 if not found
-  MODEL_EXPORT virtual int featureIndex(boost::shared_ptr<ModelAPI_Feature> theFeature);
 
 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(boost::shared_ptr<ModelAPI_Feature> theFeature);
-
-  //! Adds to the document the new feature
-  void addFeature(const boost::shared_ptr<ModelAPI_Feature> theFeature);
+  void setUniqueName(FeaturePtr theFeature);
 
-  //! Synchronizes myGroups, myGroupsNames, myFeatures and mySubs list with the updated document
-  void synchronizeFeatures();
+  //! 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
   /// number of transactions after the last "save" call, used for "IsModified" method
   int myTransactionsAfterSave;
-  /// 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;
-  /// true if the current operation is nested
-  bool myIsNested;
 };
 
 #endif