X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Application.h;h=cecb87db3f78244a9c2c39528dcd024117f9f078;hb=8f43b985d2f7170b8dfa06abd3edc7d6cb0c2e1f;hp=b5a2af8e026ccc1adab9b76a03289f23f49e0cbf;hpb=7b95df2653284e65f416373ff010af49ee8c68ef;p=modules%2Fshaper.git diff --git a/src/Model/Model_Application.h b/src/Model/Model_Application.h index b5a2af8e0..cecb87db3 100644 --- a/src/Model/Model_Application.h +++ b/src/Model/Model_Application.h @@ -1,18 +1,30 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: Model_Application.hxx -// Created: 28 Dec 2011 -// Author: Mikhail PONIKAROV -// Copyright: CEA 2011 +// Copyright (C) 2014-2020 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef Model_Application_H_ #define Model_Application_H_ -#include +#include #include #include -// Define handle class +// Define handle class DEFINE_STANDARD_HANDLE(Model_Application, TDocStd_Application) /**\class Model_Application @@ -30,30 +42,43 @@ public: // CASCADE RTTI /// Definition of "Handles" usage /// \param Model_Application is the class name that is covered by the OCCT Handle - DEFINE_STANDARD_RTTI(Model_Application); + DEFINE_STANDARD_RTTIEXT(Model_Application, TDocStd_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); + //! Retuns the application: one per process + MODEL_EXPORT static Handle(Model_Application) getApplication(); + //! 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); //! Returns the path for the loaded by demand documents const std::string& loadPath() const; //! Defines that specified document must be loaded by demand - void setLoadByDemand(std::string theID); + void setLoadByDemand(std::string theID, const int theDocID); //! 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); + bool isLoadByDemand(std::string theID, const int theDocIndex); + + //! produces new unique identifier of the document + int generateDocumentId(); public: // Redefined OCAF methods @@ -63,17 +88,17 @@ public: //! \param theFormats sequence of allowed formats for input/output virtual void Formats(TColStd_SequenceOfExtendedString& theFormats); //! Constructor - //! Use method GetInstance() method to obtain + //! Use method GetInstance() method to obtain //! the static instance of the object (or derive your own 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 - std::set myLoadedByDemand; + /// Path for the loaded by demand documents (and the persistent ID as the value) + std::map myLoadedByDemand; }; #endif