src/CDM/CDM_Application.hxx

   1 // Created on: 1997-10-22
   2 // Created by: Jean-Louis Frenkel
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _CDM_Application_HeaderFile
  18 #define _CDM_Application_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Transient.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_ExtString.hxx>
  27 #include <TCollection_AsciiString.hxx>
  28 #include <TCollection_ExtendedString.hxx>
  29 #include <CDM_MetaDataLookUpTable.hxx>
  30 #include <Message_ProgressRange.hxx>
  31
  32 class CDM_Reference;
  33 class CDM_MetaData;
  34 class CDM_Document;
  35 class Resource_Manager;
  36 class Message_Messenger;
  37
  38 class CDM_Application;
  39 DEFINE_STANDARD_HANDLE(CDM_Application, Standard_Transient)
  40
  41
  42 class CDM_Application : public Standard_Transient
  43 {
  44
  45 public:
  46
  47
  48   //! The manager returned by  this virtual  method will be
  49   //! used to search for Format.Retrieval  resource items.
  50   Standard_EXPORT virtual Handle(Resource_Manager) Resources() = 0;
  51
  52   //! Returns default messenger;
  53   Standard_EXPORT virtual Handle(Message_Messenger) MessageDriver();
  54
  55   //! this method is called before the update of a document.
  56   //! By default, writes in MessageDriver().
  57   Standard_EXPORT virtual void BeginOfUpdate (const Handle(CDM_Document)& aDocument);
  58
  59   //! this method is called affter the update of a document.
  60   //! By default, writes in MessageDriver().
  61   Standard_EXPORT virtual void EndOfUpdate (const Handle(CDM_Document)& aDocument, const Standard_Boolean theStatus, const TCollection_ExtendedString& ErrorString);
  62
  63   //! writes the string in the application MessagerDriver.
  64   Standard_EXPORT void Write (const Standard_ExtString aString);
  65
  66   //! Returns the application name.
  67   Standard_EXPORT virtual TCollection_ExtendedString Name() const;
  68
  69   //! Returns the application version.
  70   Standard_EXPORT virtual TCollection_AsciiString Version() const;
  71
  72   //! Returns MetaData LookUpTable
  73   Standard_EXPORT virtual  CDM_MetaDataLookUpTable* MetaDataLookUpTable();
  74
  75   //! Dumps the content of me into the stream
  76   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
  77
  78 friend class CDM_Reference;
  79 friend class CDM_MetaData;
  80
  81
  82   DEFINE_STANDARD_RTTIEXT(CDM_Application,Standard_Transient)
  83
  84 protected:
  85
  86   Standard_EXPORT CDM_Application();
  87
  88   Standard_EXPORT void SetDocumentVersion (const Handle(CDM_Document)& aDocument, const Handle(CDM_MetaData)& aMetaData) const;
  89
  90   Standard_EXPORT void SetReferenceCounter (const Handle(CDM_Document)& aDocument, const Standard_Integer aReferenceCounter);
  91
  92 private:
  93
  94
  95   Standard_EXPORT virtual Handle(CDM_Document) Retrieve
  96         (const Handle(CDM_MetaData)& aMetaData,
  97          const Standard_Boolean UseStorageConfiguration,
  98          const Message_ProgressRange& theRange = Message_ProgressRange()) = 0;
  99
 100   //! returns -1 if the metadata has no modification counter.
 101   Standard_EXPORT virtual Standard_Integer DocumentVersion (const Handle(CDM_MetaData)& aMetaData) = 0;
 102
 103   Handle(Message_Messenger) myMessenger;
 104   CDM_MetaDataLookUpTable myMetaDataLookUpTable;
 105
 106 };
 107
 108
 109
 110
 111
 112
 113
 114 #endif // _CDM_Application_HeaderFile