X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Document.h;h=2a97982b0a79f8b8711a316ac37144bc2b6edd90;hb=5183e45dbb598541fb76e679b285b1e599916eaa;hp=99311a6281a3cada2df4f015d19d6d6a3d7debf4;hpb=3874b57fe5aba25ff5aee2a07654fc23c1ee8eb0;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index 99311a628..2a97982b0 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,22 @@ 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) - virtual std::shared_ptr addFeature(std::string theID) = 0; + //! \param theID creates feature and puts it in the document (if it is not action) + //! \param theMakeCurrent to make current this new feature in this document + virtual std::shared_ptr addFeature(std::string theID, + const bool theMakeCurrent = true) = 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; @@ -57,42 +69,86 @@ public: //! Returns the object in the group by the index (started from zero) //! \param theGroupID group that contains an object //! \param theIndex zero-based index of feature in the group - //! \param theHidden if it is true, it counts also the features that are not in tree virtual std::shared_ptr object(const std::string& theGroupID, - const int theIndex, - const bool theHidden = false) = 0; + const int theIndex) = 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; + //! 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; - /// To virtually destroy the fields of successors - virtual ~ModelAPI_Document() - { - } + //! Returns the object index in the group. Object must be visible. Otherwise returns -1. + //! \param theObject object of this document + //! \returns index started from zero, or -1 if object is invisible or belongs to another document + virtual const int index(std::shared_ptr theObject) = 0; - /// Creates a construction cresults + //! Returns the number of objects in the group of objects + virtual int size(const std::string& theGroupID) = 0; + + //! Returns the feature that is currently edited in this document, normally + //! this is the latest created feature + //! \param theVisible use visible features only: flag is true for Object Browser functionality + //! \returns null if next created feature must be the first + virtual std::shared_ptr currentFeature(const bool theVisible) = 0; + + //! Sets the current feature: all features below will be disabled, new features + //! will be appended after this one. + //! \param theCurrent the selected feature as current: blow it everythin become disabled + //! \param theVisible use visible features only: flag is true for Object Browser functionality + virtual void setCurrentFeature(std::shared_ptr theCurrent, + const bool theVisible) = 0; + //! Makes the current feature one feature upper + virtual void setCurrentFeatureUp() = 0; + + //! To virtually destroy the fields of successors + MODELAPI_EXPORT virtual ~ModelAPI_Document(); + + //! Creates a construction cresults virtual std::shared_ptr createConstruction( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - /// Creates a body results + //! Creates a body results virtual std::shared_ptr createBody( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - /// Creates a part results + //! Creates a part results virtual std::shared_ptr createPart( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - /// Creates a group results + //! Creates a group results 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; + //! Returns all features of the document including the hidden features which are not in + //! history. Not very fast method, for calling once, not in big cycles. + virtual std::list > allFeatures() = 0; + + //! Informs the document that it becomes active and some actions must be performed + virtual void setActive(const bool theFlag) = 0; + //! Returns true if this document is currently active + virtual bool isActive() const = 0; + + /// Returns true if document is opened and valid + virtual bool isOpened() = 0; + + protected: - /// Only for SWIG wrapping it is here - MODELAPI_EXPORT ModelAPI_Document() - { - } + //! 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 updateHistory(const std::shared_ptr theObject) = 0; + //! Internally makes document know that feature was removed or added in history after creation + MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0; + + friend class ModelAPI_Object; // to add or remove from the history + friend class ModelAPI_Result; // to add or remove from the history }; //! Pointer on document object