src/BinLDrivers/BinLDrivers_DocumentRetrievalDriver.hxx

   1 // Created on: 2002-10-31
   2 // Created by: Michael SAZONOV
   3 // Copyright (c) 2002-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _BinLDrivers_DocumentRetrievalDriver_HeaderFile
  17 #define _BinLDrivers_DocumentRetrievalDriver_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Type.hxx>
  21
  22 #include <BinObjMgt_Persistent.hxx>
  23 #include <BinObjMgt_RRelocationTable.hxx>
  24 #include <TColStd_MapOfInteger.hxx>
  25 #include <BinLDrivers_VectorOfDocumentSection.hxx>
  26 #include <PCDM_RetrievalDriver.hxx>
  27 #include <Standard_Integer.hxx>
  28 #include <Standard_IStream.hxx>
  29 #include <Storage_Position.hxx>
  30 #include <Standard_Boolean.hxx>
  31 #include <Storage_Data.hxx>
  32
  33 class BinMDF_ADriverTable;
  34 class Message_Messenger;
  35 class TCollection_ExtendedString;
  36 class PCDM_Document;
  37 class CDM_Document;
  38 class CDM_Application;
  39 class TDF_Label;
  40 class TCollection_AsciiString;
  41 class Storage_HeaderData;
  42 class BinLDrivers_DocumentSection;
  43
  44
  45 class BinLDrivers_DocumentRetrievalDriver;
  46 DEFINE_STANDARD_HANDLE(BinLDrivers_DocumentRetrievalDriver, PCDM_RetrievalDriver)
  47
  48
  49 class BinLDrivers_DocumentRetrievalDriver : public PCDM_RetrievalDriver
  50 {
  51
  52 public:
  53
  54
  55   //! Constructor
  56   Standard_EXPORT BinLDrivers_DocumentRetrievalDriver();
  57
  58   //! retrieves the content of the file into a new Document.
  59   Standard_EXPORT virtual void Read (const TCollection_ExtendedString& theFileName,
  60                                      const Handle(CDM_Document)& theNewDocument,
  61                                      const Handle(CDM_Application)& theApplication,
  62                                      const Handle(PCDM_ReaderFilter)& theFilter = Handle(PCDM_ReaderFilter)(),
  63                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
  64
  65   Standard_EXPORT virtual void Read (Standard_IStream&               theIStream,
  66                                      const Handle(Storage_Data)&     theStorageData,
  67                                      const Handle(CDM_Document)&     theDoc,
  68                                      const Handle(CDM_Application)&  theApplication,
  69                                      const Handle(PCDM_ReaderFilter)& theFilter = Handle(PCDM_ReaderFilter)(),
  70                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
  71
  72   Standard_EXPORT virtual Handle(BinMDF_ADriverTable) AttributeDrivers (const Handle(Message_Messenger)& theMsgDriver);
  73
  74
  75
  76
  77   DEFINE_STANDARD_RTTIEXT(BinLDrivers_DocumentRetrievalDriver,PCDM_RetrievalDriver)
  78
  79 protected:
  80
  81
  82   //! Read the tree from the stream <theIS> to <theLabel>
  83   Standard_EXPORT virtual Standard_Integer ReadSubTree
  84     (Standard_IStream& theIS,
  85      const TDF_Label& theData,
  86      const Handle(PCDM_ReaderFilter)& theFilter,
  87      const Standard_Boolean& theQuickPart,
  88      const Message_ProgressRange& theRanges = Message_ProgressRange());
  89
  90
  91   //! define the procedure of reading a section to file.
  92   Standard_EXPORT virtual void ReadSection
  93     (BinLDrivers_DocumentSection& theSection,
  94      const Handle(CDM_Document)& theDoc,
  95      Standard_IStream& theIS);
  96
  97   //! define the procedure of reading a shapes section to file.
  98   Standard_EXPORT virtual void ReadShapeSection
  99    (BinLDrivers_DocumentSection& theSection,
 100     Standard_IStream& theIS,
 101     const Standard_Boolean isMess = Standard_False,
 102     const Message_ProgressRange& theRange = Message_ProgressRange());
 103
 104   //! checks the shapes section can be correctly retrieved.
 105   Standard_EXPORT virtual void CheckShapeSection (const Storage_Position& thePos, Standard_IStream& theIS);
 106
 107   //! clears the reading-cash data in drivers if any.
 108   Standard_EXPORT virtual void Clear();
 109
 110   //! Check a file version(in which file was written) with a current version.
 111   //! Redefining this method is a chance for application to read files
 112   //! written by newer applications.
 113   //! The default implementation: if the version of the file is greater than the
 114   //! current or lesser than 2, then return false, else true
 115   Standard_EXPORT virtual Standard_Boolean CheckDocumentVersion (const Standard_Integer theFileVersion, const Standard_Integer theCurVersion);
 116
 117   //! Return true if retrieved document allows to read parts quickly.
 118   static Standard_Boolean IsQuickPart (const Standard_Integer theFileVer);
 119
 120   //! Enables reading in the quick part access mode.
 121   Standard_EXPORT virtual void EnableQuickPartReading (const Handle(Message_Messenger)& /*theMessageDriver*/, Standard_Boolean /*theValue*/) {}
 122
 123   Handle(BinMDF_ADriverTable) myDrivers;
 124   BinObjMgt_RRelocationTable myRelocTable;
 125   Handle(Message_Messenger) myMsgDriver;
 126
 127 private:
 128
 129
 130   BinObjMgt_Persistent myPAtt;
 131   TColStd_MapOfInteger myMapUnsupported;
 132   BinLDrivers_VectorOfDocumentSection mySections;
 133
 134
 135 };
 136
 137
 138
 139
 140
 141
 142
 143 #endif // _BinLDrivers_DocumentRetrievalDriver_HeaderFile