include/opencascade/XmlObjMgt_RRelocationTable.hxx

0001 // Created on: 2001-07-17
0002 // Created by: Julia DOROVSKIKH <jfa@hotdox.nnov.matra-dtv.fr>
0003 // Copyright (c) 2001-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 _XmlObjMgt_RRelocationTable_HeaderFile
0017 #define _XmlObjMgt_RRelocationTable_HeaderFile
0018
0019 #include <Standard_Integer.hxx>
0020 #include <Standard_Transient.hxx>
0021 #include <NCollection_DataMap.hxx>
0022
0023 #include <Storage_HeaderData.hxx>
0024
0025 //! Retrieval relocation table is modeled as a child class of
0026 //! NCollection_DataMap<int, occ::handle<Standard_Transient>> that stores a handle to the file
0027 //! header section. With that attribute drivers have access to the file header
0028 //! section.
0029 class XmlObjMgt_RRelocationTable : public NCollection_DataMap<int, occ::handle<Standard_Transient>>
0030 {
0031 public:
0032   //! Returns a handle to the header data of the file that is begin read
0033   Standard_EXPORT const occ::handle<Storage_HeaderData>& GetHeaderData() const;
0034
0035   //! Sets the storage header data.
0036   //!
0037   //! @param theHeaderData header data of the file that is begin read
0038   Standard_EXPORT void SetHeaderData(const occ::handle<Storage_HeaderData>& theHeaderData);
0039
0040   Standard_EXPORT void Clear(const bool doReleaseMemory = true);
0041
0042 private:
0043   occ::handle<Storage_HeaderData> myHeaderData;
0044 };
0045
0046 #endif // _XmlObjMgt_RRelocationTable_HeaderFile