#include <Storage_Schema.hxx>
Inheritance diagram for Storage_Schema:
Public Member Functions | |
Standard_EXPORT | Storage_Schema () |
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 void | SetVersion (const TCollection_AsciiString &aVersion) |
returns version of the schema | |
Standard_EXPORT TCollection_AsciiString | Version () const |
returns the version of the schema | |
Standard_EXPORT void | SetName (const TCollection_AsciiString &aSchemaName) |
set the schema's name | |
Standard_EXPORT TCollection_AsciiString | Name () const |
returns the schema's name | |
Standard_EXPORT void | Write (Storage_BaseDriver &s, const Handle(Storage_Data)&aData) 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 Handle_Storage_Data | Read (Storage_BaseDriver &s) const |
Returns the data read from the container defined by the driver s. The retrieval operation is performed according to the data schema with which this algorithm is working. These data are aggregated in a Storage_Data object which may be browsed in order to extract the root objects from the container. . | |
Standard_EXPORT Handle_Storage_HeaderData | ReadHeaderSection (Storage_BaseDriver &s) const |
read the header part of the stream Arguments: s: driver to read | |
Standard_EXPORT Handle_Storage_TypeData | ReadTypeSection (Storage_BaseDriver &s) const |
fill the TypeData with the names of the type used in a stream Arguments: s: driver to read | |
Standard_EXPORT Handle_Storage_RootData | ReadRootSection (Storage_BaseDriver &s) const |
read root part of the file Arguments: s: driver to read | |
virtual Standard_EXPORT const TColStd_SequenceOfAsciiString & | SchemaKnownTypes () const |
returns the known types of a schema | |
Standard_EXPORT Standard_Boolean | HasUnknownType (Storage_BaseDriver &aDriver, TColStd_SequenceOfAsciiString &theUnknownTypes) const |
indicates whether the are types in the driver which are not known from the schema and for which no callbacks have been set. The unknown types can be read in <theunknowntypes>. | |
Standard_EXPORT Handle_TColStd_HSequenceOfAsciiString | GetAllSchemaKnownTypes () const |
returns the all known types of a schema and their nested schemes. | |
Standard_EXPORT void | SetNestedSchemas (const Handle(Storage_HArrayOfSchema)&theSchemas) |
Standard_EXPORT void | ClearNestedSchemas () |
Standard_EXPORT Handle_Storage_HArrayOfSchema | NestedSchemas () const |
Standard_EXPORT void | AddReadUnknownTypeCallBack (const TCollection_AsciiString &aTypeName, const Handle(Storage_CallBack)&aCallBack) |
add two functions to the callback list | |
Standard_EXPORT void | RemoveReadUnknownTypeCallBack (const TCollection_AsciiString &aTypeName) |
remove a callback for a type | |
Standard_EXPORT Handle_TColStd_HSequenceOfAsciiString | InstalledCallBackList () const |
returns a list of type name with installed callback. | |
Standard_EXPORT void | ClearCallBackList () |
clear all callback from schema instance. | |
Standard_EXPORT void | UseDefaultCallBack () |
install a callback for all unknown type. the objects with unknown types will be skipped. (look SkipObject method in BaseDriver) | |
Standard_EXPORT void | DontUseDefaultCallBack () |
tells schema to uninstall the default callback. | |
Standard_EXPORT Standard_Boolean | IsUsingDefaultCallBack () const |
ask if the schema is using the default callback. | |
Standard_EXPORT void | SetDefaultCallBack (const Handle(Storage_CallBack)&f) |
overload the default function for build.(use to set an error message or skip an object while reading an unknown type). | |
Standard_EXPORT void | ResetDefaultCallBack () |
reset the default function defined by Storage package. | |
Standard_EXPORT Handle_Storage_CallBack | DefaultCallBack () const |
returns the read function used when the UseDefaultCallBack() is set. | |
virtual Standard_EXPORT Handle_Storage_CallBack | CallBackSelection (const TCollection_AsciiString &tName) const |
virtual Standard_EXPORT Handle_Storage_CallBack | AddTypeSelection (const Handle(Standard_Persistent)&sp) const |
void | WritePersistentObjectHeader (const Handle(Standard_Persistent)&sp, Storage_BaseDriver &s) |
void | ReadPersistentObjectHeader (Storage_BaseDriver &s) |
void | WritePersistentReference (const Handle(Standard_Persistent)&sp, Storage_BaseDriver &s) |
Standard_EXPORT void | ReadPersistentReference (Handle(Standard_Persistent)&sp, Storage_BaseDriver &s) |
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 |
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const |
Static Public Member Functions | |
static Standard_EXPORT TCollection_AsciiString | ICreationDate () |
return a current date string //! 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 dosent know how to handle this type. | |
Protected Member Functions | |
Standard_EXPORT Standard_Boolean | IsNested () const |
Standard_EXPORT Handle_Storage_CallBack | ResolveUnknownType (const TCollection_AsciiString &aTypeName, const Handle(Standard_Persistent)&aPers, const Storage_SolveMode aMode) const |
Standard_Boolean | HasTypeBinding (const TCollection_AsciiString &aTypeName) const |
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 Member Functions | |
Standard_EXPORT Standard_Boolean | SetNested () |
Standard_EXPORT Standard_Boolean | UnsetNested () |
Standard_EXPORT void | Clear () const |
Standard_EXPORT Standard_Boolean | IReadHeaderSection (Storage_BaseDriver &s, const Handle(Storage_HeaderData)&iData) const |
Standard_EXPORT Standard_Boolean | IReadTypeSection (Storage_BaseDriver &s, const Handle(Storage_TypeData)&tData) const |
Standard_EXPORT Standard_Boolean | IReadRootSection (Storage_BaseDriver &s, const Handle(Storage_RootData)&rData) const |
Static Private Member Functions | |
static Standard_EXPORT void | ISetCurrentData (const Handle(Storage_Data)&dData) |
static Standard_EXPORT Handle_Storage_Data & | ICurrentData () |
Private Attributes | |
Storage_MapOfCallBack | myCallBack |
Standard_Boolean | myCallBackState |
Handle_Storage_CallBack | myDefaultCallBack |
TCollection_AsciiString | myName |
TCollection_AsciiString | myVersion |
Handle_Storage_HArrayOfSchema | myArrayOfSchema |
Standard_Boolean | myNestedState |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reimplemented from MMgt_TShared. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|