X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Document.h;h=5f344ea085160b4f18000328183db249ea526a73;hb=23d55c9a069dc7bde8c49f67edd900992aea2dcc;hp=911aca0680be06183f0093859ee21bebed285c9a;hpb=e1f8fb3cfc1ee565db16fbbd9fe6f65121c4577c;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index 911aca068..5f344ea08 100644 --- a/src/ModelAPI/ModelAPI_Document.h +++ b/src/ModelAPI/ModelAPI_Document.h @@ -1,66 +1,144 @@ -// File: Model_Document.hxx -// Created: 28 Dec 2011 +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + +// File: ModelAPI_Document.cxx +// Created: 28 Feb 2014 // Author: Mikhail PONIKAROV -// Copyright: CEA 2011 -#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_Object; +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. Corresponds to the SALOME study. - * Document contains all data of te SALOME Study specific to this module - * that must be written into the HDF file. + * \brief Document for internal data structure of any object storage. + * Document contains all data that must be stored/retrived in the file. * Also it provides acces to this data: open/save, transactions management etc. - * to provide access to all stored data. */ - class ModelAPI_Document { public: + //! 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; - //! 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; + //! Removes document data + //! \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; - //! 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; + //! Adds to the document the new feature of the given feature id + //! \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; - //! 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; + //! 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 + //! \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; + + ///! 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 + 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 + 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 + 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 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 std::shared_ptr DocumentPtr; + #endif