X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Application.h;h=728c2a807a66771979f9f5f7a0b373ff8441970f;hb=42d8ecf39798c037945ca4bb9073d8dc31c53008;hp=aa25bcb4e161c9b6bfa1a389a12dff6942618463;hpb=2f89053146098946372bae4d1a3fe2e5272ab9e2;p=modules%2Fshaper.git diff --git a/src/Model/Model_Application.h b/src/Model/Model_Application.h index aa25bcb4e..728c2a807 100644 --- a/src/Model/Model_Application.h +++ b/src/Model/Model_Application.h @@ -18,28 +18,43 @@ DEFINE_STANDARD_HANDLE(Model_Application, TDocStd_Application) /**\class Model_Application * \ingroup DataModel * \brief Realization of Open CASCADE application abstraction. Class for internal use only. + * * Application supports the formats and document management. It is uses OCAF-lke * architecture and just implements specific features of the module. */ class Model_Application : public TDocStd_Application { - public: +public: // useful methods inside of the module // CASCADE RTTI - DEFINE_STANDARD_RTTI(Model_Application) - ; + /// Definition of "Handles" usage + /// \param Model_Application is the class name that is covered by the OCCT Handle + DEFINE_STANDARD_RTTI(Model_Application); //! Retuns the application: one per process MODEL_EXPORT static Handle_Model_Application getApplication(); - //! Returns the main document (on first call creates it) by the string identifier - MODEL_EXPORT const std::shared_ptr& getDocument(std::string theDocID); + //! Returns the document by the identifier + //! \returns false of document is not yet created/not loaded + MODEL_EXPORT std::shared_ptr document(const int theDocID); //! Returns true if document has been created - MODEL_EXPORT bool hasDocument(std::string theDocID); + MODEL_EXPORT bool hasDocument(const int theDocID); + //! Returns true if root document has been created + MODEL_EXPORT bool hasRoot(); + //! Returns root document, if created (or null otherwise) + MODEL_EXPORT std::shared_ptr rootDocument(); //! Deletes the document from the application - MODEL_EXPORT void deleteDocument(std::string theDocID); + MODEL_EXPORT void deleteDocument(const int theDocID); //! Deletes all documents existing in the application MODEL_EXPORT void deleteAllDocuments(); + //! Creates a new document an returns an id of this document + //! \param theDocID if it is zero, the root document is created + MODEL_EXPORT void createDocument(const int theDocID); + //! Loads document by the file name (if it is registered as load by demand) + //! \param theDocName name of the document file + //! \param theDocID the identifier of the loaded document (to be created) + //! \returns true if load is ok + MODEL_EXPORT bool loadDocument(const std::string theDocName, const int theDocID); //! Set path for the loaded by demand documents void setLoadPath(std::string thePath); @@ -49,6 +64,12 @@ class Model_Application : public TDocStd_Application void setLoadByDemand(std::string theID); //! Returns true if specified document must be loaded by demand bool isLoadByDemand(std::string theID); + //! Closes and removes the documents that are not loaded by demand and + //! not in the given list + void removeUselessDocuments(std::list > theUsedDocs); + + //! produces new unique identifier of the document + int generateDocumentId(); public: // Redefined OCAF methods @@ -63,8 +84,8 @@ class Model_Application : public TDocStd_Application Model_Application(); private: - /// Map from string identifiers to created documents of an application - std::map > myDocs; + /// Map from identifiers to created documents of an application + std::map > myDocs; /// Path for the loaded by demand documents std::string myPath; /// Path for the loaded by demand documents