Salome HOME
Issue #83: rename and transfer some methods related to document
[modules/shaper.git] / src / Model / Model_Document.h
index 4e8278ca531502dacf025f598576694e80becad6..598c3b633f674c283e69f89c7b1edaff4f75341b 100644 (file)
@@ -19,8 +19,8 @@
 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);
+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
@@ -28,9 +28,9 @@ static  Standard_Boolean IsEqual(const TDF_Label& theLab1,const TDF_Label& theLa
  * 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:
 
   //! Loads the OCAF document from the file.
   //! \param theFileName full name of the file to load
@@ -40,8 +40,9 @@ public:
 
   //! 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();
@@ -85,8 +86,14 @@ public:
   //! 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)
   //! \param theGroupID group that contains a feature
@@ -94,7 +101,7 @@ public:
   //! \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);
+                                        const bool theHidden = false);
 
   //! Returns the number of features in the group
   //! If theHidden is true, it counts also the features that are not in tree
@@ -102,20 +109,23 @@ public:
 
   /// Creates a construction cresults
   MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
-    const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
+      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);
+      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);
+      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> 
+  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:
+ protected:
 
   //! Returns (creates if needed) the features label
   TDF_Label featuresLabel();
@@ -130,7 +140,10 @@ protected:
   //! Creates new document with binary file format
   Model_Document(const std::string theID);
 
-  Handle_TDocStd_Document document() {return myDoc;}
+  Handle_TDocStd_Document document()
+  {
+    return myDoc;
+  }
 
   //! performas compactification of all nested operations into one
   void compactNested();
@@ -140,16 +153,22 @@ protected:
 
   //! 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);
+                                        boost::shared_ptr<ModelAPI_Result> theResult,
+                                        const int theResultIndex = 0);
+
+  //! 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);
 
+  //! Updates the results list of the feature basing on the current data tree
+  void updateResults(FeaturePtr theFeature);
 
   friend class Model_Application;
-  friend class Model_PluginManager;
+  friend class Model_Session;
   friend class DFBrowser;
 
-private:
-  std::string myID; ///< identifier of the document in the application
-  Handle_TDocStd_Document myDoc; ///< OCAF document
+ 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;
   /// number of nested transactions performed (or -1 if not nested)
@@ -162,6 +181,8 @@ private:
   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