X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Document.h;h=8093123bd4ee523c3b2c9e5da27dd9150b952e91;hb=b900918cef83bb82217e7221c7ff0ad9d8a6dbe9;hp=378915c639ee65d153e5b4ea76235348def95b70;hpb=de0f49686ec6655ddc5816c8fa5383964662aec4;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index 378915c63..8093123bd 100644 --- a/src/ModelAPI/ModelAPI_Document.h +++ b/src/ModelAPI/ModelAPI_Document.h @@ -1,29 +1,30 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Document.cxx // 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 +#include class ModelAPI_Feature; -class ModelAPI_Iterator; - -/// Common groups identifiers -/// Group of parameters -static const std::string PARAMETERS_GROUP = "Parameters"; -/// Group of constructions -static const std::string CONSTRUCTIONS_GROUP = "Construction"; -/// Group of parts -static const std::string PARTS_GROUP = "Parts"; -/// Group of sketches -static const std::string SKETCHS_GROUP = "Sketchs"; - -/**\class Model_Document +class ModelAPI_Object; +class ModelAPI_Result; +class ModelAPI_ResultConstruction; +class ModelAPI_ResultBody; +class ModelAPI_ResultPart; +class ModelAPI_ResultGroup; +class ModelAPI_ResultParameter; +class ModelAPI_Data; + +/**\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. @@ -32,71 +33,90 @@ static const std::string SKETCHS_GROUP = "Sketchs"; 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 - MODELAPI_EXPORT 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 - MODELAPI_EXPORT 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 - MODELAPI_EXPORT virtual void close() = 0; - - //! Starts a new operation (opens a tansaction) - MODELAPI_EXPORT virtual void startOperation() = 0; - //! Finishes the previously started operation (closes the transaction) - MODELAPI_EXPORT virtual void finishOperation() = 0; - //! Aborts the operation - MODELAPI_EXPORT virtual void abortOperation() = 0; - //! Returns true if operation has been started, but not yet finished or aborted - MODELAPI_EXPORT virtual bool isOperation() = 0; - //! Returns true if document was modified (since creation/opening) - MODELAPI_EXPORT virtual bool isModified() = 0; - - //! Returns True if there are available Undos - MODELAPI_EXPORT virtual bool canUndo() = 0; - //! Undoes last operation - MODELAPI_EXPORT virtual void undo() = 0; - //! Returns True if there are available Redos - MODELAPI_EXPORT virtual bool canRedo() = 0; - //! Redoes last operation - MODELAPI_EXPORT virtual void redo() = 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 - MODELAPI_EXPORT virtual std::shared_ptr addFeature(std::string theID) = 0; - - ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist - MODELAPI_EXPORT virtual std::shared_ptr subDocument(std::string theDocID) = 0; - - ///! Creates an iterator of the features by the specific groups - MODELAPI_EXPORT virtual std::shared_ptr featuresIterator( - const std::string theGroup) = 0; + //! \param theID creates feature and puts it in the document (if it is not action) + virtual std::shared_ptr addFeature(std::string theID) = 0; - ///! Returns the id of hte document - MODELAPI_EXPORT virtual const std::string& id() const = 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; - //! Returns the feature in the group by the index (started from zero) - MODELAPI_EXPORT virtual std::shared_ptr - feature(const std::string& theGroupID, const int theIndex) = 0; + //! Removes the feature from the document + //! \param theFeature a feature to be removed + virtual void removeFeature(std::shared_ptr theFeature) = 0; - //! Returns the index of feature in the group (zero based) - MODELAPI_EXPORT virtual int featureIndex(std::shared_ptr theFeature) = 0; - - ///! Returns the vector of groups already added to the document - MODELAPI_EXPORT virtual const std::vector& getGroups() const = 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; + + ///! Returns the id of the document + virtual const std::string& id() const = 0; + + //! 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; + + //! 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; /// To virtually destroy the fields of successors - virtual ~ModelAPI_Document() {} + 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 + virtual std::shared_ptr createBody( + const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + /// Creates a part results + 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; + + 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; 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 addToHistory(const std::shared_ptr theObject) = 0; + + friend class ModelAPI_Object; // to add or remove from the history }; +//! Pointer on document object +typedef std::shared_ptr DocumentPtr; + #endif