X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Document.h;h=5f344ea085160b4f18000328183db249ea526a73;hb=23d55c9a069dc7bde8c49f67edd900992aea2dcc;hp=1a5aee9bf535aabecb2c7eff61386a4923343555;hpb=784d687fe1671ba7856b721b8958889b4d426c29;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index 1a5aee9bf..5f344ea08 100644 --- 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 @@ -7,9 +9,10 @@ #include #include -#include +#include #include #include +#include class ModelAPI_Feature; class ModelAPI_Object; @@ -17,9 +20,11 @@ class ModelAPI_Result; 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. @@ -34,18 +39,29 @@ public: virtual const std::string& kind() const = 0; //! Removes document data - virtual void close() = 0; + //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo) + 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 boost::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( - boost::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 boost::shared_ptr subDocument(std::string theDocID) = 0; + virtual std::shared_ptr subDocument(std::string theDocID) = 0; ///! Returns the id of the document virtual const std::string& id() const = 0; @@ -53,44 +69,76 @@ 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 boost::shared_ptr - object(const std::string& theGroupID, const int theIndex, const bool theHidden = false) = 0; + virtual std::shared_ptr object(const std::string& theGroupID, + const int theIndex) = 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 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; //! 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; + 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 - virtual ~ModelAPI_Document() - { - } + MODELAPI_EXPORT virtual ~ModelAPI_Document(); /// Creates a construction cresults - virtual boost::shared_ptr createConstruction( - const boost::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + virtual std::shared_ptr createConstruction( + const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; /// Creates a body results - virtual boost::shared_ptr createBody( - const boost::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + virtual std::shared_ptr createBody( + const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; /// Creates a part results - virtual boost::shared_ptr createPart( - const boost::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + virtual std::shared_ptr createPart( + const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + /// Creates a group results + virtual std::shared_ptr createGroup( + const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - //! Returns a feature by result (owner of result) - virtual boost::shared_ptr feature( - const boost::shared_ptr& theResult) = 0; + virtual std::shared_ptr createParameter( + const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - ///! Reutrns true is result was conecaled because of usage it by other object - virtual bool isConcealed(const boost::shared_ptr& theResult) = 0; + //! Returns a feature by result (owner of result) + virtual std::shared_ptr feature( + const std::shared_ptr& theResult) = 0; protected: /// Only for SWIG wrapping it is here - MODELAPI_EXPORT ModelAPI_Document() - { - } + 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 -typedef boost::shared_ptr DocumentPtr; +typedef std::shared_ptr DocumentPtr; #endif