OCC.Storage module¶

Storage package is used to write and read persistent objects.These objects are read and written by a retrieval or storagealgorithm (Storage_Schema object) in a container (disk, memory,network …). Drivers (FSD_File objects) assign a physicalcontainer for data to be stored or retrieved.The standard procedure for an application inreading a container is the following:- open the driver in reading mode,- call the Read function from the schema,setting the driver as a parameter. This function returnsan instance of the Storage_Data class which contains the data being read,- close the driver.The standard procedure for an application in writing a container is the following:- open the driver in writing mode,- create an instance of the Storage_Data class, thenadd the persistent data to write with the function AddRoot,- call the function Write from the schema,setting the driver and the Storage_Data instance as parameters,- close the driver.

class Handle_Storage_CallBack(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_Data(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_DataMapNodeOfMapOfCallBack(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_DataMapNodeOfMapOfPers(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_DefaultCallBack(*args)¶

Bases: OCC.Storage.Handle_Storage_CallBack

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_HArrayOfCallBack(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_HArrayOfSchema(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_HPArray(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_HSeqOfRoot(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_HeaderData(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_IndexedDataMapNodeOfPType(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_InternalData(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_Root(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_RootData(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_Schema(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_SequenceNodeOfSeqOfRoot(*args)¶

Bases: OCC.TCollection.Handle_TCollection_SeqNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_TypeData(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Storage_TypedCallBack(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Storage_ArrayOfCallBack(*args)¶

Bases: object

Parameters:	Low (int) – Up (int) – Item (Handle_Storage_CallBack &) – Low – Up –
Return type:	None
Return type:	None

Assign()¶

Parameters:	Other (Storage_ArrayOfCallBack &) –
Return type:	Storage_ArrayOfCallBack

ChangeValue()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_CallBack

Destroy()¶

Return type:	None

Init()¶

Parameters:	V (Handle_Storage_CallBack &) –
Return type:	None

IsAllocated()¶

Return type:	bool

Length()¶

Return type:	int

Lower()¶

Return type:	int

Set()¶

Parameters:	Other (Storage_ArrayOfCallBack &) –
Return type:	Storage_ArrayOfCallBack

SetValue()¶

Parameters:	Index (int) – Value (Handle_Storage_CallBack &) –
Return type:	None

Upper()¶

Return type:	int

Value()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_CallBack

thisown¶: The membership flag

class Storage_ArrayOfSchema(*args)¶

Bases: object

Parameters:	Low (int) – Up (int) – Item (Handle_Storage_Schema &) – Low – Up –
Return type:	None
Return type:	None

Assign()¶

Parameters:	Other (Storage_ArrayOfSchema &) –
Return type:	Storage_ArrayOfSchema

ChangeValue()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_Schema

Destroy()¶

Return type:	None

Init()¶

Parameters:	V (Handle_Storage_Schema &) –
Return type:	None

IsAllocated()¶

Return type:	bool

Length()¶

Return type:	int

Lower()¶

Return type:	int

Set()¶

Parameters:	Other (Storage_ArrayOfSchema &) –
Return type:	Storage_ArrayOfSchema

SetValue()¶

Parameters:	Index (int) – Value (Handle_Storage_Schema &) –
Return type:	None

Upper()¶

Return type:	int

Value()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_Schema

thisown¶: The membership flag

class Storage_BaseDriver(*args, **kwargs)¶

Bases: object

BeginReadCommentSection()¶

Return type:	Storage_Error

BeginReadDataSection()¶

Return type:	Storage_Error

BeginReadInfoSection()¶

Return type:	Storage_Error

BeginReadObjectData()¶

Return type:	void

BeginReadPersistentObjectData()¶

Return type:	void

BeginReadRefSection()¶

Return type:	Storage_Error

BeginReadRootSection()¶

Return type:	Storage_Error

BeginReadTypeSection()¶

Return type:	Storage_Error

BeginWriteCommentSection()¶

Return type:	Storage_Error

BeginWriteDataSection()¶

Return type:	Storage_Error

BeginWriteInfoSection()¶

Return type:	Storage_Error

BeginWriteObjectData()¶

Return type:	void

BeginWritePersistentObjectData()¶

Return type:	void

BeginWriteRefSection()¶

Return type:	Storage_Error

BeginWriteRootSection()¶

Return type:	Storage_Error

BeginWriteTypeSection()¶

Return type:	Storage_Error

Close()¶

Return type:	Storage_Error

Delete()¶

Return type:	None

EndReadCommentSection()¶

Return type:	Storage_Error

EndReadDataSection()¶

Return type:	Storage_Error

EndReadInfoSection()¶

Return type:	Storage_Error

EndReadObjectData()¶

Return type:	void

EndReadPersistentObjectData()¶

Return type:	void

EndReadRefSection()¶

Return type:	Storage_Error

EndReadRootSection()¶

Return type:	Storage_Error

EndReadTypeSection()¶

Return type:	Storage_Error

EndWriteCommentSection()¶

Return type:	Storage_Error

EndWriteDataSection()¶

Return type:	Storage_Error

EndWriteInfoSection()¶

Return type:	Storage_Error

EndWriteObjectData()¶

Return type:	void

EndWritePersistentObjectData()¶

Return type:	void

EndWriteRefSection()¶

Return type:	Storage_Error

EndWriteRootSection()¶

Return type:	Storage_Error

EndWriteTypeSection()¶

Return type:	Storage_Error

GetBoolean()¶

Parameters:	aValue (bool) –
Return type:	Storage_BaseDriver

GetCharacter()¶

Parameters:	aValue (Standard_Character &) –
Return type:	Storage_BaseDriver

GetExtCharacter()¶

Parameters:	aValue (Standard_ExtCharacter &) –
Return type:	Storage_BaseDriver

GetInteger()¶

Parameters:	aValue (int &) –
Return type:	Storage_BaseDriver

GetReal()¶

Parameters:	aValue (float &) –
Return type:	Storage_BaseDriver

GetReference()¶

Parameters:	aValue (int &) –
Return type:	Storage_BaseDriver

GetShortReal()¶

Parameters:	aValue (Standard_ShortReal &) –
Return type:	Storage_BaseDriver

IsEnd()¶

returns True if we are at end of the stream

Return type:	bool

Name()¶

Return type:	TCollection_AsciiString

Open()¶

Parameters:	aName (TCollection_AsciiString &) – aMode (Storage_OpenMode) –
Return type:	Storage_Error

OpenMode()¶

Return type:	Storage_OpenMode

PutBoolean()¶

Parameters:	aValue (bool) –
Return type:	Storage_BaseDriver

PutCharacter()¶

Parameters:	aValue (Standard_Character) –
Return type:	Storage_BaseDriver

PutExtCharacter()¶

Parameters:	aValue (Standard_ExtCharacter) –
Return type:	Storage_BaseDriver

PutInteger()¶

Parameters:	aValue (int) –
Return type:	Storage_BaseDriver

PutReal()¶

Parameters:	aValue (float) –
Return type:	Storage_BaseDriver

PutReference()¶

Parameters:	aValue (int) –
Return type:	Storage_BaseDriver

PutShortReal()¶

Parameters:	aValue (Standard_ShortReal) –
Return type:	Storage_BaseDriver

ReadComment()¶

Parameters:	userComments (TColStd_SequenceOfExtendedString &) –
Return type:	void

ReadInfo()¶

Parameters:

nbObj (int &) –
dbVersion (TCollection_AsciiString &) –
date (TCollection_AsciiString &) –
schemaName (TCollection_AsciiString &) –
schemaVersion (TCollection_AsciiString &) –
appName (TCollection_ExtendedString &) –
appVersion (TCollection_AsciiString &) –
objectType (TCollection_ExtendedString &) –
userInfo (TColStd_SequenceOfAsciiString &) –

Return type:

void

ReadPersistentObjectHeader()¶

Parameters:	aRef (int &) – aType (int &) –
Return type:	void

ReadReferenceType()¶

Parameters:	reference (int &) – typeNum (int &) –
Return type:	void

ReadRoot()¶

Parameters:	rootName (TCollection_AsciiString &) – aRef (int &) – aType (TCollection_AsciiString &) –
Return type:	void

ReadTypeInformations()¶

Parameters:	typeNum (int &) – typeName (TCollection_AsciiString &) –
Return type:	void

RefSectionSize()¶

Return type:	int

RootSectionSize()¶

Return type:	int

SetRefSectionSize()¶

Parameters:	aSize (int) –
Return type:	void

SetRootSectionSize()¶

Parameters:	aSize (int) –
Return type:	void

SetTypeSectionSize()¶

Parameters:	aSize (int) –
Return type:	void

SkipObject()¶

Return type:	void

Tell()¶

return position in the file. Return -1 upon error.

Return type:	Storage_Position

TypeSectionSize()¶

Return type:	int

WriteComment()¶

Parameters:	userComments (TColStd_SequenceOfExtendedString &) –
Return type:	void

WriteInfo()¶

Parameters:

nbObj (int) –
dbVersion (TCollection_AsciiString &) –
date (TCollection_AsciiString &) –
schemaName (TCollection_AsciiString &) –
schemaVersion (TCollection_AsciiString &) –
appName (TCollection_ExtendedString &) –
appVersion (TCollection_AsciiString &) –
objectType (TCollection_ExtendedString &) –
userInfo (TColStd_SequenceOfAsciiString &) –

Return type:

void

WritePersistentObjectHeader()¶

Parameters:	aRef (int) – aType (int) –
Return type:	void

WriteReferenceType()¶

Parameters:	reference (int) – typeNum (int) –
Return type:	void

WriteRoot()¶

Parameters:	rootName (TCollection_AsciiString &) – aRef (int) – aType (TCollection_AsciiString &) –
Return type:	void

WriteTypeInformations()¶

Parameters:	typeNum (int) – typeName (TCollection_AsciiString &) –
Return type:	void

thisown¶: The membership flag

class Storage_CallBack(*args, **kwargs)¶

Bases: OCC.MMgt.MMgt_TShared

Add()¶

Parameters:	aPers (Handle_Standard_Persistent &) – aSchema (Handle_Storage_Schema &) –
Return type:	void

GetHandle()¶

New()¶

Return type:	Handle_Standard_Persistent

Read()¶

Parameters:	aPers (Handle_Standard_Persistent &) – aDriver (Storage_BaseDriver &) – aSchema (Handle_Storage_Schema &) –
Return type:	void

Write()¶

Parameters:	aPers (Handle_Standard_Persistent &) – aDriver (Storage_BaseDriver &) – aSchema (Handle_Storage_Schema &) –
Return type:	void

thisown¶: The membership flag

class Storage_Data(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Creates an empty set of data. You explicitly create a Storage_Data object when preparing the set of objects to be stored together in a container (for example, in a file). Then use the function AddRoot to add persistent objects to the set of data. A Storage_Data object is also returned by the Read function of a Storage_Schema storage/retrieval algorithm. Use the functions NumberOfRoots and Roots to find the roots which were stored in the read container.

Return type:	None

AddRoot()¶

add a persistent root to write. the name of the root is a driver reference number.

Parameters:	anObject (Handle_Standard_Persistent &) –
Return type:	None

Adds the root anObject to this set of data. The name of the root is aName if given; if not, it will be a reference number assigned by the driver when writing the set of data into the container. When naming the roots, it is easier to retrieve objects by significant references rather than by references without any semantic values.

Parameters:	aName (TCollection_AsciiString &) – anObject (Handle_Standard_Persistent &) –
Return type:	None

AddToComments()¶

add <theUserInfo> to the user informations

Parameters:	aComment (TCollection_ExtendedString &) –
Return type:	None

AddToUserInfo()¶

add <theUserInfo> to the user informations

Parameters:	anInfo (TCollection_AsciiString &) –
Return type:	None

ApplicationName()¶

get the name of the application

Return type:	TCollection_ExtendedString

ApplicationVersion()¶

get the version of the application

Return type:	TCollection_AsciiString

ClearErrorStatus()¶

Clears the error status positioned either by: - the last storage operation performed with the Read function, or - the last retrieval operation performed with the Write function by a Storage_Schema algorithm, on this set of data. This error status may be read by the function ErrorStatus.

Return type:	None

Comments()¶

return the user informations

Return type:	TColStd_SequenceOfExtendedString

CreationDate()¶

return the creation date

Return type:	TCollection_AsciiString

DataType()¶

returns data type

Return type:	TCollection_ExtendedString

ErrorStatus()¶

Returns Storage_VSOk if - the last storage operation performed with the function Read, or - the last retrieval operation performed with the function Write by a Storage_Schema algorithm, on this set of data was successful. If the storage or retrieval operation was not performed, the returned error status indicates the reason why the operation failed. The algorithm stops its analysis at the first detected error

Return type:	Storage_Error

ErrorStatusExtension()¶

Return type:	TCollection_AsciiString

Find()¶

Gives the root object whose name is aName in this set of data. The returned object is a Storage_Root object, from which the object it encapsulates may be extracted. Warning A null handle is returned if there is no root object whose name is aName in this set of data.

Parameters:	aName (TCollection_AsciiString &) –
Return type:	Handle_Storage_Root

GetHandle()¶

IsRoot()¶

returns Standard_True if <self> contains a root named <aName>

Parameters:	aName (TCollection_AsciiString &) –
Return type:	bool

IsType()¶

Returns true if this set of data contains an object of type aName. Persistent objects from this set of data must have types which are recognized by the Storage_Schema algorithm used to store or retrieve them.

Parameters:	aName (TCollection_AsciiString &) –
Return type:	bool

NumberOfObjects()¶

the the number of persistent objects Return: the number of persistent objects readed

Return type:	int

NumberOfRoots()¶

Returns the number of root objects in this set of data. - When preparing a storage operation, the result is the number of roots inserted into this set of data with the function AddRoot. - When retrieving an object, the result is the number of roots stored in the read container. Use the Roots function to get these roots in a sequence.

Return type:	int

NumberOfTypes()¶

Returns the number of types of objects used in this set of data.

Return type:	int

RemoveRoot()¶

Removes from this set of data the root object named aName. Warning Nothing is done if there is no root object whose name is aName in this set of data.

Parameters:	aName (TCollection_AsciiString &) –
Return type:	None

Roots()¶

Returns the roots of this set of data in a sequence. - When preparing a storage operation, the sequence contains the roots inserted into this set of data with the function AddRoot. - When retrieving an object, the sequence contains the roots stored in the container read. - An empty sequence is returned if there is no root in this set of data.

Return type:	Handle_Storage_HSeqOfRoot

SchemaName()¶

get the schema’s name

Return type:	TCollection_AsciiString

SchemaVersion()¶

get the version of the schema

Return type:	TCollection_AsciiString

SetApplicationName()¶

set the name of the application

Parameters:	aName (TCollection_ExtendedString &) –
Return type:	None

SetApplicationVersion()¶

set the version of the application

Parameters:	aVersion (TCollection_AsciiString &) –
Return type:	None

SetDataType()¶

set the data type

Parameters:	aType (TCollection_ExtendedString &) –
Return type:	None

StorageVersion()¶

return the Storage package version

Return type:	TCollection_AsciiString

Types()¶

Gives the list of types of objects used in this set of data in a sequence.

Return type:	Handle_TColStd_HSequenceOfAsciiString

UserInfo()¶

return the user informations

Return type:	TColStd_SequenceOfAsciiString

thisown¶: The membership flag

class Storage_DataMapIteratorOfMapOfCallBack(*args)¶

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:	None
Parameters:	aMap (Storage_MapOfCallBack &) –
Return type:	None

Initialize()¶

Parameters:	aMap (Storage_MapOfCallBack &) –
Return type:	None

Key()¶

Return type:	TCollection_AsciiString

Value()¶

Return type:	Handle_Storage_TypedCallBack

thisown¶: The membership flag

class Storage_DataMapIteratorOfMapOfPers(*args)¶

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:	None
Parameters:	aMap (Storage_MapOfPers &) –
Return type:	None

Initialize()¶

Parameters:	aMap (Storage_MapOfPers &) –
Return type:	None

Key()¶

Return type:	TCollection_AsciiString

Value()¶

Return type:	Handle_Storage_Root

thisown¶: The membership flag

class Storage_DataMapNodeOfMapOfCallBack(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K (TCollection_AsciiString &) – I (Handle_Storage_TypedCallBack &) – n (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

Key()¶

Return type:	TCollection_AsciiString

Value()¶

Return type:	Handle_Storage_TypedCallBack

thisown¶: The membership flag

class Storage_DataMapNodeOfMapOfPers(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K (TCollection_AsciiString &) – I (Handle_Storage_Root &) – n (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

Key()¶

Return type:	TCollection_AsciiString

Value()¶

Return type:	Handle_Storage_Root

thisown¶: The membership flag

class Storage_DefaultCallBack(*args)¶

Bases: OCC.Storage.Storage_CallBack

Return type:	None

GetHandle()¶

thisown¶: The membership flag

class Storage_HArrayOfCallBack(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Parameters:	Low (int) – Up (int) – Low – Up – V (Handle_Storage_CallBack &) –
Return type:	None
Return type:	None

Array1()¶

Return type:	Storage_ArrayOfCallBack

ChangeArray1()¶

Return type:	Storage_ArrayOfCallBack

ChangeValue()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_CallBack

GetHandle()¶

Init()¶

Parameters:	V (Handle_Storage_CallBack &) –
Return type:	None

Length()¶

Return type:	int

Lower()¶

Return type:	int

SetValue()¶

Parameters:	Index (int) – Value (Handle_Storage_CallBack &) –
Return type:	None

Upper()¶

Return type:	int

Value()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_CallBack

thisown¶: The membership flag

class Storage_HArrayOfSchema(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Parameters:	Low (int) – Up (int) – Low – Up – V (Handle_Storage_Schema &) –
Return type:	None
Return type:	None

Array1()¶

Return type:	Storage_ArrayOfSchema

ChangeArray1()¶

Return type:	Storage_ArrayOfSchema

ChangeValue()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_Schema

GetHandle()¶

Init()¶

Parameters:	V (Handle_Storage_Schema &) –
Return type:	None

Length()¶

Return type:	int

Lower()¶

Return type:	int

SetValue()¶

Parameters:	Index (int) – Value (Handle_Storage_Schema &) –
Return type:	None

Upper()¶

Return type:	int

Value()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_Schema

thisown¶: The membership flag

class Storage_HPArray(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Parameters:	Low (int) – Up (int) – Low – Up – V (Handle_Standard_Persistent &) –
Return type:	None
Return type:	None

Array1()¶

Return type:	Storage_PArray

ChangeArray1()¶

Return type:	Storage_PArray

ChangeValue()¶

Parameters:	Index (int) –
Return type:	Handle_Standard_Persistent

GetHandle()¶

Init()¶

Parameters:	V (Handle_Standard_Persistent &) –
Return type:	None

Length()¶

Return type:	int

Lower()¶

Return type:	int

SetValue()¶

Parameters:	Index (int) – Value (Handle_Standard_Persistent &) –
Return type:	None

Upper()¶

Return type:	int

Value()¶

Parameters:	Index (int) –
Return type:	Handle_Standard_Persistent

thisown¶: The membership flag

class Storage_HSeqOfRoot(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Return type:	None

Append()¶

Parameters:	anItem (Handle_Storage_Root &) – aSequence (Handle_Storage_HSeqOfRoot &) –
Return type:	None
Return type:	None

ChangeSequence()¶

Return type:	Storage_SeqOfRoot

ChangeValue()¶

Parameters:	anIndex (int) –
Return type:	Handle_Storage_Root

Clear()¶

Return type:	None

Exchange()¶

Parameters:	anIndex (int) – anOtherIndex (int) –
Return type:	None

GetHandle()¶

InsertAfter()¶

Parameters:	anIndex (int) – anItem (Handle_Storage_Root &) – anIndex – aSequence (Handle_Storage_HSeqOfRoot &) –
Return type:	None
Return type:	None

InsertBefore()¶

Parameters:	anIndex (int) – anItem (Handle_Storage_Root &) – anIndex – aSequence (Handle_Storage_HSeqOfRoot &) –
Return type:	None
Return type:	None

IsEmpty()¶

Return type:	bool

Length()¶

Return type:	int

Prepend()¶

Parameters:	anItem (Handle_Storage_Root &) – aSequence (Handle_Storage_HSeqOfRoot &) –
Return type:	None
Return type:	None

Remove()¶

Parameters:	anIndex (int) – fromIndex (int) – toIndex (int) –
Return type:	None
Return type:	None

Reverse()¶

Return type:	None

Sequence()¶

Return type:	Storage_SeqOfRoot

SetValue()¶

Parameters:	anIndex (int) – anItem (Handle_Storage_Root &) –
Return type:	None

Split()¶

Parameters:	anIndex (int) –
Return type:	Handle_Storage_HSeqOfRoot

Value()¶

Parameters:	anIndex (int) –
Return type:	Handle_Storage_Root

thisown¶: The membership flag

class Storage_HeaderData(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Return type:	None

AddToComments()¶

add <theUserInfo> to the user informations

Parameters:	aComment (TCollection_ExtendedString &) –
Return type:	None

AddToUserInfo()¶

add <theUserInfo> to the user informations

Parameters:	theUserInfo (TCollection_AsciiString &) –
Return type:	None

ApplicationName()¶

get the name of the application

Return type:	TCollection_ExtendedString

ApplicationVersion()¶

get the version of the application

Return type:	TCollection_AsciiString

ClearErrorStatus()¶

Return type:	None

Comments()¶

return the user informations

Return type:	TColStd_SequenceOfExtendedString

CreationDate()¶

return the creation date

Return type:	TCollection_AsciiString

DataType()¶

returns data type

Return type:	TCollection_ExtendedString

ErrorStatus()¶

Return type:	Storage_Error

ErrorStatusExtension()¶

Return type:	TCollection_AsciiString

GetHandle()¶

NumberOfObjects()¶

the the number of persistent objects Return: the number of persistent objects readed

Return type:	int

SchemaName()¶

get the schema’s name

Return type:	TCollection_AsciiString

SchemaVersion()¶

get the version of the schema

Return type:	TCollection_AsciiString

SetApplicationName()¶

set the name of the application

Parameters:	aName (TCollection_ExtendedString &) –
Return type:	None

SetApplicationVersion()¶

set the version of the application

Parameters:	aVersion (TCollection_AsciiString &) –
Return type:	None

SetDataType()¶

set the data type

Parameters:	aType (TCollection_ExtendedString &) –
Return type:	None

StorageVersion()¶

return the Storage package version

Return type:	TCollection_AsciiString

UserInfo()¶

return the user informations

Return type:	TColStd_SequenceOfAsciiString

thisown¶: The membership flag

class Storage_IndexedDataMapNodeOfPType(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K1 (TCollection_AsciiString &) – K2 (int) – I (int &) – n1 (TCollection_MapNodePtr &) – n2 (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

GetKey2()¶: Storage_IndexedDataMapNodeOfPType_GetKey2(Storage_IndexedDataMapNodeOfPType self) -> Standard_Integer

GetValue()¶: Storage_IndexedDataMapNodeOfPType_GetValue(Storage_IndexedDataMapNodeOfPType self) -> Standard_Integer

Key1()¶

Return type:	TCollection_AsciiString

Next2()¶

Return type:	TCollection_MapNodePtr

SetKey2()¶: Storage_IndexedDataMapNodeOfPType_SetKey2(Storage_IndexedDataMapNodeOfPType self, Standard_Integer value)

SetValue()¶: Storage_IndexedDataMapNodeOfPType_SetValue(Storage_IndexedDataMapNodeOfPType self, Standard_Integer value)

thisown¶: The membership flag

class Storage_InternalData(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Return type:	None

Clear()¶

Return type:	None

GetHandle()¶

thisown¶: The membership flag

class Storage_MapOfCallBack(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

Assign()¶

Parameters:	Other (Storage_MapOfCallBack &) –
Return type:	Storage_MapOfCallBack

Bind()¶

Parameters:	K (TCollection_AsciiString &) – I (Handle_Storage_TypedCallBack &) –
Return type:	bool

ChangeFind()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Handle_Storage_TypedCallBack

ChangeFind1()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Standard_Address

Clear()¶

Return type:	None

Find()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Handle_Storage_TypedCallBack

Find1()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Standard_Address

IsBound()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	bool

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

Set()¶

Parameters:	Other (Storage_MapOfCallBack &) –
Return type:	Storage_MapOfCallBack

UnBind()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	bool

thisown¶: The membership flag

class Storage_MapOfPers(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

Assign()¶

Parameters:	Other (Storage_MapOfPers &) –
Return type:	Storage_MapOfPers

Bind()¶

Parameters:	K (TCollection_AsciiString &) – I (Handle_Storage_Root &) –
Return type:	bool

ChangeFind()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Handle_Storage_Root

ChangeFind1()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Standard_Address

Clear()¶

Return type:	None

Find()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Handle_Storage_Root

Find1()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Standard_Address

IsBound()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	bool

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

Set()¶

Parameters:	Other (Storage_MapOfPers &) –
Return type:	Storage_MapOfPers

UnBind()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	bool

thisown¶: The membership flag

class Storage_PArray(*args)¶

Bases: object

Parameters:	Low (int) – Up (int) – Item (Handle_Standard_Persistent &) – Low – Up –
Return type:	None
Return type:	None

Assign()¶

Parameters:	Other (Storage_PArray &) –
Return type:	Storage_PArray

ChangeValue()¶

Parameters:	Index (int) –
Return type:	Handle_Standard_Persistent

Destroy()¶

Return type:	None

Init()¶

Parameters:	V (Handle_Standard_Persistent &) –
Return type:	None

IsAllocated()¶

Return type:	bool

Length()¶

Return type:	int

Lower()¶

Return type:	int

Set()¶

Parameters:	Other (Storage_PArray &) –
Return type:	Storage_PArray

SetValue()¶

Parameters:	Index (int) – Value (Handle_Standard_Persistent &) –
Return type:	None

Upper()¶

Return type:	int

Value()¶

Parameters:	Index (int) –
Return type:	Handle_Standard_Persistent

thisown¶: The membership flag

class Storage_PType(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

Add()¶

Parameters:	K (TCollection_AsciiString &) – I (int &) –
Return type:	int

Assign()¶

Parameters:	Other (Storage_PType &) –
Return type:	Storage_PType

ChangeFromIndex()¶

Parameters:	I (int) –
Return type:	int

ChangeFromKey()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	int

ChangeFromKey1()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Standard_Address

Clear()¶

Return type:	None

Contains()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	bool

FindFromIndex()¶

Parameters:	I (int) –
Return type:	int

FindFromKey()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	int

FindFromKey1()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	Standard_Address

FindIndex()¶

Parameters:	K (TCollection_AsciiString &) –
Return type:	int

FindKey()¶

Parameters:	I (int) –
Return type:	TCollection_AsciiString

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

RemoveLast()¶

Return type:	None

Set()¶

Parameters:	Other (Storage_PType &) –
Return type:	Storage_PType

Substitute()¶

Parameters:	I (int) – K (TCollection_AsciiString &) – T (int &) –
Return type:	None

thisown¶: The membership flag

class Storage_Root(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Return type:	None
Parameters:	aName (TCollection_AsciiString &) – anObject (Handle_Standard_Persistent &) –
Return type:	None

GetHandle()¶

Name()¶

Returns the name of this root object. The name may have been given explicitly when the root was inserted into the Storage_Data object. If not, the name is a reference number which was assigned automatically by the driver when writing the set of data into the container. When naming the roots, it is easier to retrieve objects by significant references rather than by references without any semantic values. Warning The returned string will be empty if you call this function before having named this root object, either explicitly, or when writing the set of data into the container.

Return type:	TCollection_AsciiString

Object()¶

Returns the persistent object encapsulated by this root.

Return type:	Handle_Standard_Persistent

SetName()¶

Parameters:	aName (TCollection_AsciiString &) –
Return type:	None

SetObject()¶

Parameters:	anObject (Handle_Standard_Persistent &) –
Return type:	None

Type()¶

Returns the name of this root type.

Return type:	TCollection_AsciiString

thisown¶: The membership flag

class Storage_RootData(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Return type:	None

AddRoot()¶

add a root to <self>. If a root with same name is present, it will be replaced by <aRoot>.

Parameters:	aRoot (Handle_Storage_Root &) –
Return type:	None

ClearErrorStatus()¶

Return type:	None

ErrorStatus()¶

Return type:	Storage_Error

ErrorStatusExtension()¶

Return type:	TCollection_AsciiString

Find()¶

find a root with name <aName>.

Parameters:	aName (TCollection_AsciiString &) –
Return type:	Handle_Storage_Root

GetHandle()¶

IsRoot()¶

returns Standard_True if <self> contains a root named <aName>

Parameters:	aName (TCollection_AsciiString &) –
Return type:	bool

NumberOfRoots()¶

returns the number of roots.

Return type:	int

RemoveRoot()¶

remove the root named <aName>.

Parameters:	aName (TCollection_AsciiString &) –
Return type:	None

Roots()¶

Return type:	Handle_Storage_HSeqOfRoot

thisown¶: The membership flag

class Storage_Schema(*args)¶

Bases: OCC.MMgt.MMgt_TShared

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 – ————————————————————– ——– –

Return type:	None

AddPersistent()¶

Parameters:	sp (Handle_Standard_Persistent &) – tName (char *) –
Return type:	bool

AddReadUnknownTypeCallBack()¶

add two functions to the callback list

Parameters:	aTypeName (TCollection_AsciiString &) – aCallBack (Handle_Storage_CallBack &) –
Return type:	None

AddTypeSelection()¶

Parameters:	sp (Handle_Standard_Persistent &) –
Return type:	Handle_Storage_CallBack

CallBackSelection()¶

Parameters:	tName (TCollection_AsciiString &) –
Return type:	Handle_Storage_CallBack

static CheckTypeMigration()¶

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 dosent know how to handle this type.

Parameters:	theTypeName (TCollection_AsciiString &) – theNewName (TCollection_AsciiString &) –
Return type:	bool

ClearCallBackList()¶

clear all callback from schema instance.

Return type:	None

ClearNestedSchemas()¶

Return type:	None

DefaultCallBack()¶

returns the read function used when the UseDefaultCallBack() is set.

Return type:	Handle_Storage_CallBack

DontUseDefaultCallBack()¶

tells schema to uninstall the default callback.

Return type:	None

GetAllSchemaKnownTypes()¶

returns the all known types of a schema and their nested schemes.

Return type:	Handle_TColStd_HSequenceOfAsciiString

GetHandle()¶

HasUnknownType()¶

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>.

Parameters:	aDriver (Storage_BaseDriver &) – theUnknownTypes (TColStd_SequenceOfAsciiString &) –
Return type:	bool

static ICreationDate()¶

return a current date string

Return type:	TCollection_AsciiString

InstalledCallBackList()¶

returns a list of type name with installed callback.

Return type:	Handle_TColStd_HSequenceOfAsciiString

IsUsingDefaultCallBack()¶

ask if the schema is using the default callback.

Return type:	bool

Name()¶

returns the schema’s name

Return type:	TCollection_AsciiString

NestedSchemas()¶

Return type:	Handle_Storage_HArrayOfSchema

PersistentToAdd()¶

Parameters:	sp (Handle_Standard_Persistent &) –
Return type:	bool

Read()¶

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.

Parameters:	s (Storage_BaseDriver &) –
Return type:	Handle_Storage_Data

ReadHeaderSection()¶

read the header part of the stream Arguments: s: driver to read

Parameters:	s (Storage_BaseDriver &) –
Return type:	Handle_Storage_HeaderData

ReadPersistentObjectHeader()¶

Parameters:	s (Storage_BaseDriver &) –
Return type:	None

ReadPersistentReference()¶

Parameters:	sp (Handle_Standard_Persistent &) – s (Storage_BaseDriver &) –
Return type:	None

ReadRootSection()¶

read root part of the file Arguments: s: driver to read

Parameters:	s (Storage_BaseDriver &) –
Return type:	Handle_Storage_RootData

ReadTypeSection()¶

fill the TypeData with the names of the type used in a stream Arguments: s: driver to read

Parameters:	s (Storage_BaseDriver &) –
Return type:	Handle_Storage_TypeData

RemoveReadUnknownTypeCallBack()¶

remove a callback for a type

Parameters:	aTypeName (TCollection_AsciiString &) –
Return type:	None

ResetDefaultCallBack()¶

reset the default function defined by Storage package.

Return type:	None

SchemaKnownTypes()¶

returns the known types of a schema

Return type:	TColStd_SequenceOfAsciiString

SetDefaultCallBack()¶

overload the default function for build.(use to set an error message or skip an object while reading an unknown type).

Parameters:	f (Handle_Storage_CallBack &) –
Return type:	None

SetName()¶

set the schema’s name

Parameters:	aSchemaName (TCollection_AsciiString &) –
Return type:	None

SetNestedSchemas()¶

Parameters:	theSchemas (Handle_Storage_HArrayOfSchema &) –
Return type:	None

SetVersion()¶

returns version of the schema

Parameters:	aVersion (TCollection_AsciiString &) –
Return type:	None

UseDefaultCallBack()¶

install a callback for all unknown type. the objects with unknown types will be skipped. (look SkipObject method in BaseDriver)

Return type:	None

Version()¶

returns the version of the schema

Return type:	TCollection_AsciiString

Write()¶

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.

Parameters:	s (Storage_BaseDriver &) – aData (Handle_Storage_Data &) –
Return type:	None

WritePersistentObjectHeader()¶

Parameters:	sp (Handle_Standard_Persistent &) – s (Storage_BaseDriver &) –
Return type:	None

WritePersistentReference()¶

Parameters:	sp (Handle_Standard_Persistent &) – s (Storage_BaseDriver &) –
Return type:	None

thisown¶: The membership flag

Storage_Schema_CheckTypeMigration()¶

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 dosent know how to handle this type.

Parameters:	theTypeName (TCollection_AsciiString &) – theNewName (TCollection_AsciiString &) –
Return type:	bool

Storage_Schema_ICreationDate()¶

return a current date string

Return type:	TCollection_AsciiString

class Storage_SeqOfRoot(*args)¶

Bases: OCC.TCollection.TCollection_BaseSequence

Return type:	None
Parameters:	Other (Storage_SeqOfRoot &) –
Return type:	None

Append()¶

Parameters:	T (Handle_Storage_Root &) – S (Storage_SeqOfRoot &) –
Return type:	None
Return type:	None

Assign()¶

Parameters:	Other (Storage_SeqOfRoot &) –
Return type:	Storage_SeqOfRoot

ChangeValue()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_Root

Clear()¶

Return type:	None

First()¶

Return type:	Handle_Storage_Root

InsertAfter()¶

Parameters:	Index (int) – T (Handle_Storage_Root &) – Index – S (Storage_SeqOfRoot &) –
Return type:	None
Return type:	None

InsertBefore()¶

Parameters:	Index (int) – T (Handle_Storage_Root &) – Index – S (Storage_SeqOfRoot &) –
Return type:	None
Return type:	None

Last()¶

Return type:	Handle_Storage_Root

Prepend()¶

Parameters:	T (Handle_Storage_Root &) – S (Storage_SeqOfRoot &) –
Return type:	None
Return type:	None

Remove()¶

Parameters:	Index (int) – FromIndex (int) – ToIndex (int) –
Return type:	None
Return type:	None

Set()¶

Parameters:	Other (Storage_SeqOfRoot &) –
Return type:	Storage_SeqOfRoot

SetValue()¶

Parameters:	Index (int) – I (Handle_Storage_Root &) –
Return type:	None

Split()¶

Parameters:	Index (int) – Sub (Storage_SeqOfRoot &) –
Return type:	None

Value()¶

Parameters:	Index (int) –
Return type:	Handle_Storage_Root

thisown¶: The membership flag

class Storage_SequenceNodeOfSeqOfRoot(*args)¶

Bases: OCC.TCollection.TCollection_SeqNode

Parameters:	I (Handle_Storage_Root &) – n (TCollection_SeqNodePtr &) – p (TCollection_SeqNodePtr &) –
Return type:	None

GetHandle()¶

Value()¶

Return type:	Handle_Storage_Root

thisown¶: The membership flag

class Storage_TypeData(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Return type:	None

Clear()¶

Return type:	None

ClearErrorStatus()¶

Return type:	None

ErrorStatus()¶

Return type:	Storage_Error

ErrorStatusExtension()¶

Return type:	TCollection_AsciiString

GetHandle()¶

IsType()¶

Parameters:	aName (TCollection_AsciiString &) –
Return type:	bool

NumberOfTypes()¶

Return type:	int

Types()¶

Return type:	Handle_TColStd_HSequenceOfAsciiString

thisown¶: The membership flag

class Storage_TypedCallBack(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Return type:	None
Parameters:	aTypeName (TCollection_AsciiString &) – aCallBack (Handle_Storage_CallBack &) –
Return type:	None

CallBack()¶

Return type:	Handle_Storage_CallBack

GetHandle()¶

Index()¶

Return type:	int

SetCallBack()¶

Parameters:	aCallBack (Handle_Storage_CallBack &) –
Return type:	None

SetIndex()¶

Parameters:	anIndex (int) –
Return type:	None

SetType()¶

Parameters:	aType (TCollection_AsciiString &) –
Return type:	None

Type()¶

Return type:	TCollection_AsciiString

thisown¶: The membership flag

class Storage_stCONSTclCOM(*args, **kwargs)¶

Bases: object

thisown¶: The membership flag

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

thisown¶: The membership flag

value()¶

new_instancemethod(func, inst, cls)¶

register_handle(handle, base_object)¶: Inserts the handle into the base object to prevent memory corruption in certain cases

class storage¶

Bases: object

static Version()¶

returns the version of Storage’s read/write routines

Return type:	TCollection_AsciiString

thisown¶: The membership flag

storage_Version()¶

returns the version of Storage’s read/write routines

Return type:	TCollection_AsciiString