X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Document.h;h=cdfa1d75ed89bb6661e2d7e30a239cfc3eab1a88;hb=a5a4efb5a57703a634a60c097b6ab9179a04e6d4;hp=ab055f32484a4db83d9d447192709832bd74c31f;hpb=dc488f733ac5d7f70745b5764442aa2399bc3c63;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index ab055f324..cdfa1d75e 100644 --- a/src/ModelAPI/ModelAPI_Document.h +++ b/src/ModelAPI/ModelAPI_Document.h @@ -2,13 +2,14 @@ // Created: 28 Feb 2014 // Author: Mikhail PONIKAROV -#ifndef ModelAPI_Document_HeaderFile -#define ModelAPI_Document_HeaderFile +#ifndef ModelAPI_Document_H_ +#define ModelAPI_Document_H_ #include #include #include #include +#include class ModelAPI_Feature; class ModelAPI_Object; @@ -27,50 +28,24 @@ class ModelAPI_Data; class ModelAPI_Document { public: - //! Loads the OCAF document from the file. - //! \param theFileName full name of the file to load - //! \param theStudyID identifier of the SALOME study to associate with loaded file - //! \returns true if file was loaded successfully - virtual bool load(const char* theFileName) = 0; - - //! Saves the OCAF document to the file. - //! \param theFileName full name of the file to store - //! \returns true if file was stored successfully - virtual bool save(const char* theFileName) = 0; + //! Returns the kind of the document: "PartSet", "Part", or something else. + //! This kind is used for feature buttons enable/disable depending on active document + //! (it uses workbench "document" identifier in XML configuration file for this) + virtual const std::string& kind() const = 0; //! Removes document data virtual void close() = 0; - //! Starts a new operation (opens a tansaction) - virtual void startOperation() = 0; - //! Finishes the previously started operation (closes the transaction) - virtual void finishOperation() = 0; - //! Aborts the operation - virtual void abortOperation() = 0; - //! Returns true if operation has been started, but not yet finished or aborted - virtual bool isOperation() = 0; - //! Returns true if document was modified (since creation/opening) - virtual bool isModified() = 0; - - //! Returns True if there are available Undos - virtual bool canUndo() = 0; - //! Undoes last operation - virtual void undo() = 0; - //! Returns True if there are available Redos - virtual bool canRedo() = 0; - //! Redoes last operation - virtual void redo() = 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; //! Removes the feature from the document - virtual void removeFeature(boost::shared_ptr theFeature) = 0; + virtual void removeFeature(boost::shared_ptr theFeature, + const bool theCheck = true) = 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 boost::shared_ptr subDocument(std::string theDocID) = 0; ///! Returns the id of the document virtual const std::string& id() const = 0; @@ -79,39 +54,41 @@ public: //! \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 boost::shared_ptr object(const std::string& theGroupID, + const int theIndex, + const bool theHidden = false) = 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; /// To virtually destroy the fields of successors - virtual ~ModelAPI_Document() {} + virtual ~ModelAPI_Document() + { + } /// Creates a construction cresults virtual boost::shared_ptr createConstruction( - const boost::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + const boost::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; + const boost::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; + const boost::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; + const boost::shared_ptr& theResult) = 0; protected: /// Only for SWIG wrapping it is here MODELAPI_EXPORT ModelAPI_Document() - {} + { + } }; - //! Pointer on document object typedef boost::shared_ptr DocumentPtr; - #endif