Constriction type for all sketch entities

[modules/shaper.git] / src / ModelAPI / ModelAPI_Document.h

diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h
index 84439e6863d466b7b27a6ba3e816c43b031e3c66..bf1fa3832d33882d18817394b605a244e24a81cc 100644 (file)
--- a/src/ModelAPI/ModelAPI_Document.h
+++ b/src/ModelAPI/ModelAPI_Document.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_Document.cxx
 // Created:     28 Feb 2014
 // Author:      Mikhail PONIKAROV
@@ -10,6 +12,7 @@
 #include <memory>
 #include <vector>
 #include <list>
+#include <set>
 
 class ModelAPI_Feature;
 class ModelAPI_Object;
@@ -20,7 +23,7 @@ class ModelAPI_ResultPart;
 class ModelAPI_ResultGroup;
 class ModelAPI_Data;
 
-/**\class Model_Document
+/**\class ModelAPI_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.
@@ -39,12 +42,20 @@ public:
   virtual void close(const bool theForever = false) = 0;
 
   //! Adds to the document the new feature of the given feature id
-  //! \param creates feature and puts it in the document (if it is not action)
+  //! \param theID creates feature and puts it in the document (if it is not action)
   virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID) = 0;
 
+  //! Return a list of features, which refers to the feature
+  //! \param theFeature a feature
+  //! \param theRefs a list of features
+  //! \param isSendError a flag whether the error message should be send
+  virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
+                             std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
+                             const bool isSendError = true) = 0;
+
   //! Removes the feature from the document
-  virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
-                             const bool theCheck = true) = 0;
+  //! \param theFeature a feature to be removed
+  virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
 
   ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
   virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
@@ -65,9 +76,7 @@ public:
   virtual int size(const std::string& theGroupID, const bool theHidden = false) = 0;
 
   /// To virtually destroy the fields of successors
-  virtual ~ModelAPI_Document()
-  {
-  }
+  MODELAPI_EXPORT virtual ~ModelAPI_Document();
 
   /// Creates a construction cresults
   virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
@@ -88,9 +97,7 @@ public:
 
 protected:
   /// Only for SWIG wrapping it is here
-  MODELAPI_EXPORT ModelAPI_Document()
-  {
-  }
+  MODELAPI_EXPORT ModelAPI_Document();
 };
 
 //! Pointer on document object