X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Document.h;h=8093123bd4ee523c3b2c9e5da27dd9150b952e91;hb=b2418a13c302e03ed5f80dbdae0cd20f0abd16af;hp=b0aabbec3569713383e07dbe439f5aecde2b6013;hpb=b8aa080b5bd95efebbcbe29dc61c27b9a32acefb;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index b0aabbec3..8093123bd 100644 --- a/src/ModelAPI/ModelAPI_Document.h +++ b/src/ModelAPI/ModelAPI_Document.h @@ -12,6 +12,7 @@ #include #include #include +#include class ModelAPI_Feature; class ModelAPI_Object; @@ -20,9 +21,10 @@ class ModelAPI_ResultConstruction; class ModelAPI_ResultBody; class ModelAPI_ResultPart; class ModelAPI_ResultGroup; +class ModelAPI_ResultParameter; 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. @@ -41,12 +43,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 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 theFeature, + std::set >& theRefs, + const bool isSendError = true) = 0; + //! Removes the feature from the document - virtual void removeFeature(std::shared_ptr theFeature, - const bool theCheck = true) = 0; + //! \param theFeature a feature to be removed + virtual void removeFeature(std::shared_ptr theFeature) = 0; ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist virtual std::shared_ptr subDocument(std::string theDocID) = 0; @@ -62,6 +72,13 @@ public: const int theIndex, const bool theHidden = false) = 0; + //! Returns the first found object in the group by the object name + //! \param theGroupID group that contains an object + //! \param theName name of the object to search + //! \returns null if such object is not found + virtual std::shared_ptr objectByName(const std::string& theGroupID, + const std::string& theName) = 0; + //! Returns the number of objects in the group of objects //! If theHidden is true, it counts also the features that are not in tree virtual int size(const std::string& theGroupID, const bool theHidden = false) = 0; @@ -82,6 +99,9 @@ public: virtual std::shared_ptr createGroup( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + virtual std::shared_ptr createParameter( + const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + //! Returns a feature by result (owner of result) virtual std::shared_ptr feature( const std::shared_ptr& theResult) = 0; @@ -89,6 +109,11 @@ public: protected: /// Only for SWIG wrapping it is here MODELAPI_EXPORT ModelAPI_Document(); + + /// Internally makes document know that feature was removed or added in history after creation + MODELAPI_EXPORT virtual void addToHistory(const std::shared_ptr theObject) = 0; + + friend class ModelAPI_Object; // to add or remove from the history }; //! Pointer on document object