EIC code displayed by LXR master/​include/​opencascade/​Storage_Schema.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:05:17

 // Created on: 1996-12-03
 // Created by: Christophe LEYNADIER
 // Copyright (c) 1996-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _Storage_Schema_HeaderFile
 #define _Storage_Schema_HeaderFile
 
 #include <Storage_BaseDriver.hxx>
 #include <Storage_InternalData.hxx>
 #include <Storage_MapOfCallBack.hxx>
 #include <TCollection_AsciiString.hxx>
 #include <TColStd_HSequenceOfAsciiString.hxx>
 
 class Storage_CallBack;
 
 
 class Storage_Schema;
 DEFINE_STANDARD_HANDLE(Storage_Schema, Standard_Transient)
 
 
 //! Root class for basic storage/retrieval algorithms.
 //! A Storage_Schema object processes:
 //! -   writing of a set of persistent data into a
 //! container (store mechanism),
 //! -   reading of a container to extract all the
 //! contained persistent data (retrieve mechanism).
 //! A Storage_Schema object is based on the data
 //! schema for the persistent data of the application, i.e.:
 //! -   the list of all persistent objects which may be
 //! known by the application,
 //! -   the organization of their data; a data schema
 //! knows how to browse each persistent object it contains.
 //! During the store or retrieve operation, only
 //! persistent objects known from the data schema
 //! can be processed; they are then stored or
 //! retrieved according to their description in the schema.
 //! A data schema is specific to the object classes to
 //! be read or written. Tools dedicated to the
 //! environment in use allow a description of the
 //! application persistent data structure.
 //! Storage_Schema algorithms are called basic
 //! because they do not support external references
 //! between containers.
 class Storage_Schema : public Standard_Transient
 {
 
 public:
 
   
   //! Builds a storage/retrieval algorithm based on a
   //! given data schema.
   //! Example
   //! For example, if ShapeSchema is the class
   //! inheriting from Storage_Schema and containing
   //! the description of your application data schema,
   //! you create a storage/retrieval algorithm as follows:
   //! Handle(ShapeSchema) s = new
   //! ShapeSchema;
   //! -------- --
   //! USER API -- --------------------------------------------------------------
   //! -------- --
   Standard_EXPORT Storage_Schema();
   
   //! returns version of the schema
   Standard_EXPORT void SetVersion (const TCollection_AsciiString& aVersion);
   
   //! returns the version of the schema
   Standard_EXPORT TCollection_AsciiString Version() const;
   
   //! set the schema's name
   Standard_EXPORT void SetName (const TCollection_AsciiString& aSchemaName);
   
   //! returns the schema's name
   Standard_EXPORT TCollection_AsciiString Name() const;
   
   //! Writes the data aggregated in aData into the
   //! container defined by the driver s. The storage
   //! operation is performed according to the data
   //! schema with which this algorithm is working.
   //! Note: aData may aggregate several root objects
   //! to be stored together.
   Standard_EXPORT void Write (const Handle(Storage_BaseDriver)& s, const Handle(Storage_Data)& aData) const;
   
   //! return a current date string
   Standard_EXPORT static TCollection_AsciiString ICreationDate();
   
   //! returns True if theType migration is identified
   //! the callback support provides a way to read a file
   //! with a incomplete schema.
   //! ex. : A file contains 3 types a, b, and c.
   //! The  application's  schema  contains  only 2
   //! type a and b. If you try to read the file in
   //! the application, you  will  have an error.To
   //! bypass this  problem  you  can  give to your
   //! application's schema  a  callback  used when
   //! the schema doesn't know  how  to handle this
   //! type.
   Standard_EXPORT static Standard_Boolean CheckTypeMigration (const TCollection_AsciiString& theTypeName, TCollection_AsciiString& theNewName);
   
   //! add two functions to the callback list
   Standard_EXPORT void AddReadUnknownTypeCallBack (const TCollection_AsciiString& aTypeName, const Handle(Storage_CallBack)& aCallBack);
   
   //! remove a callback for a type
   Standard_EXPORT void RemoveReadUnknownTypeCallBack (const TCollection_AsciiString& aTypeName);
   
   //! returns  a  list  of   type  name  with  installed
   //! callback.
   Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) InstalledCallBackList() const;
   
   //! clear all callback from schema instance.
   Standard_EXPORT void ClearCallBackList();
   
   //! install  a  callback  for  all  unknown  type. the
   //! objects with unknown types  will be skipped. (look
   //! SkipObject method in BaseDriver)
   Standard_EXPORT void UseDefaultCallBack();
   
   //! tells schema to uninstall the default callback.
   Standard_EXPORT void DontUseDefaultCallBack();
   
   //! ask if the schema is using the default callback.
   Standard_EXPORT Standard_Boolean IsUsingDefaultCallBack() const;
   
   //! overload the  default  function  for build.(use to
   //! set an  error  message  or  skip  an  object while
   //! reading an unknown type).
   Standard_EXPORT void SetDefaultCallBack (const Handle(Storage_CallBack)& f);
   
   //! reset  the  default  function  defined  by Storage
   //! package.
   Standard_EXPORT void ResetDefaultCallBack();
   
   //! returns   the   read   function   used   when  the
   //! UseDefaultCallBack() is set.
   Standard_EXPORT Handle(Storage_CallBack) DefaultCallBack() const;
   
   void WritePersistentObjectHeader(const Handle(Standard_Persistent)& sp, const Handle(Storage_BaseDriver)& theDriver)
   {
     theDriver->WritePersistentObjectHeader(sp->_refnum, sp->_typenum);
   }
 
   void WritePersistentReference(const Handle(Standard_Persistent)& sp, const Handle(Storage_BaseDriver)& theDriver)
   {
     theDriver->PutReference(sp.IsNull() ? 0 : sp->_refnum);
   }
   
   Standard_EXPORT Standard_Boolean AddPersistent (const Handle(Standard_Persistent)& sp, const Standard_CString tName) const;
   
   Standard_EXPORT Standard_Boolean PersistentToAdd (const Handle(Standard_Persistent)& sp) const;
 
   DEFINE_STANDARD_RTTIEXT(Storage_Schema,Standard_Transient)
 
 protected:
   
   Standard_Boolean HasTypeBinding(const TCollection_AsciiString& aTypeName) const
   {
     return Storage_Schema::ICurrentData()->InternalData()->myTypeBinding.IsBound(aTypeName);
   }
   
   Standard_EXPORT void BindType (const TCollection_AsciiString& aTypeName, const Handle(Storage_CallBack)& aCallBack) const;
   
   Standard_EXPORT Handle(Storage_CallBack) TypeBinding (const TCollection_AsciiString& aTypeName) const;
 
 
 
 private:
 
   Standard_EXPORT void Clear() const;
   
   Standard_EXPORT static void ISetCurrentData (const Handle(Storage_Data)& dData);
   
   Standard_EXPORT static Handle(Storage_Data)& ICurrentData();
 
   Storage_MapOfCallBack myCallBack;
   Standard_Boolean myCallBackState;
   Handle(Storage_CallBack) myDefaultCallBack;
   TCollection_AsciiString myName;
   TCollection_AsciiString myVersion;
 };
 
 #endif // _Storage_Schema_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team