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 <Message_ProgressIndicator.hxx>
  30
  31 class CDM_Reference;
  32 class CDM_MetaData;
  33 class CDM_Document;
  34 class Resource_Manager;
  35 class Message_Messenger;
  36
  37 class CDM_Application;
  38 DEFINE_STANDARD_HANDLE(CDM_Application, Standard_Transient)
  39
  40
  41 class CDM_Application : public Standard_Transient
  42 {
  43
  44 public:
  45
  46
  47   //! The manager returned by  this virtual  method will be
  48   //! used to search for Format.Retrieval  resource items.
  49   Standard_EXPORT virtual Handle(Resource_Manager) Resources() = 0;
  50
  51   //! Returns default messenger;
  52   Standard_EXPORT virtual Handle(Message_Messenger) MessageDriver();
  53
  54   //! this method is called before the update of a document.
  55   //! By default, writes in MessageDriver().
  56   Standard_EXPORT virtual void BeginOfUpdate (const Handle(CDM_Document)& aDocument);
  57
  58   //! this method is called affter the update of a document.
  59   //! By default, writes in MessageDriver().
  60   Standard_EXPORT virtual void EndOfUpdate (const Handle(CDM_Document)& aDocument, const Standard_Boolean theStatus, const TCollection_ExtendedString& ErrorString);
  61
  62   //! writes the string in the application MessagerDriver.
  63   Standard_EXPORT void Write (const Standard_ExtString aString);
  64
  65   //! Returns the application name.
  66   Standard_EXPORT virtual TCollection_ExtendedString Name() const;
  67
  68   //! Returns the application version.
  69   Standard_EXPORT virtual TCollection_AsciiString Version() const;
  70
  71   //! Dumps the content of me into the stream
  72   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
  73
  74 friend class CDM_Reference;
  75 friend class CDM_MetaData;
  76
  77
  78   DEFINE_STANDARD_RTTIEXT(CDM_Application,Standard_Transient)
  79
  80 protected:
  81
  82
  83   Standard_EXPORT void SetDocumentVersion (const Handle(CDM_Document)& aDocument, const Handle(CDM_MetaData)& aMetaData) const;
  84
  85   Standard_EXPORT void SetReferenceCounter (const Handle(CDM_Document)& aDocument, const Standard_Integer aReferenceCounter);
  86
  87
  88
  89 private:
  90
  91
  92   Standard_EXPORT virtual Handle(CDM_Document) Retrieve
  93         (const Handle(CDM_MetaData)& aMetaData,
  94          const Standard_Boolean UseStorageConfiguration,
  95          const Handle(Message_ProgressIndicator)& theProgress = NULL) = 0;
  96
  97   //! returns -1 if the metadata has no modification counter.
  98   Standard_EXPORT virtual Standard_Integer DocumentVersion (const Handle(CDM_MetaData)& aMetaData) = 0;
  99
 100
 101
 102 };
 103
 104
 105
 106
 107
 108
 109
 110 #endif // _CDM_Application_HeaderFile