include/opencascade/Storage.hxx

0001 // Created on: 1996-04-30
0002 // Created by: cle
0003 // Copyright (c) 1996-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Storage_HeaderFile
0018 #define _Storage_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 class TCollection_AsciiString;
0025
0026
0027 //! Storage package is used to write and read persistent objects.
0028 //! These objects are read and written by a retrieval or storage
0029 //! algorithm (Storage_Schema object) in a container (disk, memory,
0030 //! network ...). Drivers (FSD_File objects) assign a physical
0031 //! container for data to be stored or retrieved.
0032 //! The standard procedure for an application in
0033 //! reading a container is the following:
0034 //! -   open the driver in reading mode,
0035 //! -   call the Read function from the schema,
0036 //! setting the driver as a parameter. This   function returns
0037 //! an instance of the   Storage_Data class which contains the   data being read,
0038 //! -   close the driver.
0039 //! The standard procedure for an application in writing a container is the following:
0040 //! -   open the driver in writing mode,
0041 //! -   create an instance of the Storage_Data   class, then
0042 //! add the persistent data to write   with the function AddRoot,
0043 //! -   call the function Write from the schema,
0044 //! setting the driver and the Storage_Data   instance as parameters,
0045 //! -      close the driver.
0046 class Storage
0047 {
0048 public:
0049
0050   DEFINE_STANDARD_ALLOC
0051
0052
0053   //! returns the version of Storage's read/write routines
0054   Standard_EXPORT static TCollection_AsciiString Version();
0055
0056 };
0057
0058 #endif // _Storage_HeaderFile