include/opencascade/BinObjMgt_RRelocationTable.hxx

0001 // Created on: 2002-10-29
0002 // Created by: Michael SAZONOV
0003 // Copyright (c) 2002-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _BinObjMgt_RRelocationTable_HeaderFile
0017 #define _BinObjMgt_RRelocationTable_HeaderFile
0018
0019 #include <Standard_Integer.hxx>
0020 #include <Standard_Transient.hxx>
0021 #include <NCollection_DataMap.hxx>
0022 #include <Storage_HeaderData.hxx>
0023
0024 //! Retrieval relocation table is modeled as a child class of
0025 //! NCollection_DataMap<int, occ::handle<Standard_Transient>> that stores a handle to the file
0026 //! header section. With that attribute drivers have access to the file header
0027 //! section.
0028 class BinObjMgt_RRelocationTable : public NCollection_DataMap<int, occ::handle<Standard_Transient>>
0029 {
0030 public:
0031   //! Returns a handle to the header data of the file that is begin read
0032   Standard_EXPORT const occ::handle<Storage_HeaderData>& GetHeaderData() const;
0033
0034   //! Sets the storage header data.
0035   //!
0036   //! @param theHeaderData header data of the file that is begin read
0037   Standard_EXPORT void SetHeaderData(const occ::handle<Storage_HeaderData>& theHeaderData);
0038
0039   Standard_EXPORT void Clear(const bool doReleaseMemory = true);
0040
0041 private:
0042   occ::handle<Storage_HeaderData> myHeaderData;
0043 };
0044
0045 #endif // _BinObjMgt_RRelocationTable_HeaderFile