src/DF/DF_Application.hxx

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 #ifndef DFAPPLICATION_HXX
  23 #define DFAPPLICATION_HXX
  24
  25 #include "DF_definitions.hxx"
  26 #include "DF_Document.hxx"
  27 #include <string>
  28 #include <map>
  29
  30 //Class DF_Application responsible for creation and manipulation of Documents
  31 class DF_Application {
  32 public:
  33   //Constructor
  34   Standard_EXPORT DF_Application();
  35
  36   Standard_EXPORT ~DF_Application();
  37
  38   //Creates a new document with given type, returns a smart pointer to
  39   //newly created document.
  40   Standard_EXPORT DF_Document* NewDocument(const std::string& theDocumentType);
  41
  42   //Closes and removes the given Document
  43   Standard_EXPORT void Close(const DF_Document* theDocument);
  44
  45   //Returns a Document by Document's ID
  46   Standard_EXPORT DF_Document* GetDocument(int theDocumentID);
  47
  48   //Returns a list of IDs of all currently opened documents
  49   Standard_EXPORT std::vector<int> GetDocumentIDs();
  50
  51   //Returns a number of existent documents
  52   Standard_EXPORT int NbDocuments();
  53
  54   //Virtual methods to be redefined if required by specific application
  55
  56   //Restores a Document from the given file, returns a smart
  57   //pointer to opened document.
  58   Standard_EXPORT virtual DF_Document* Open(const std::string& theFileName);
  59
  60   //Saves a Document in a given file with name theFileName
  61   Standard_EXPORT virtual void SaveAs(const DF_Document* theDocument, const std::string& theFileName);
  62
  63 private:
  64   int                           _currentID;
  65   std::map<int, DF_Document*> _documents;
  66
  67 };
  68 #endif