OCC.Core.BinLDrivers module

BinLDrivers module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_binldrivers.html

class BinLDrivers_DocumentRetrievalDriver(*args)

Bases: OCC.Core.PCDM.PCDM_RetrievalDriver

• Constructor

  rtype

  None

AttributeDrivers()

Parameters

theMsgDriver –

type theMsgDriver

Message_Messenger

rtype

opencascade::handle<BinMDF_ADriverTable>

static DownCast(t)

Read()

• retrieves the content of the file into a new Document.

  param theFileName

  type theFileName

  TCollection_ExtendedString

  param theNewDocument

  type theNewDocument

  CDM_Document

  param theApplication

  type theApplication

  CDM_Application

  rtype

  void:param theIStream:

  type theIStream

  Standard_IStream

  param theStorageData

  type theStorageData

  Storage_Data

  param theDoc

  type theDoc

  CDM_Document

  param theApplication

  type theApplication

  CDM_Application

  rtype

  void

property thisown

The membership flag

class BinLDrivers_DocumentSection(*args)

Bases: object

• Empty constructor

  rtype

  None* Constructor

  param theName

  type theName

  TCollection_AsciiString

  param isPostRead

  type isPostRead

  bool

  rtype

  None

IsPostRead()

• Query the status: if the Section should be read after OCAF; False means that the Section is read before starting to read OCAF data.

  rtype

  bool

Length()

• Query the length of the section in the persistent file

  rtype

  uint64_t

Name()

• Query the name of the section.

  rtype

  TCollection_AsciiString

Offset()

• Query the offset of the section in the persistent file

  rtype

  uint64_t

static ReadTOC()

• Fill a DocumentSection instance from the data that are read from TOC.

  param theSection

  type theSection

  BinLDrivers_DocumentSection

  param theIS

  type theIS

  Standard_IStream

  param theDocFormatVersion

  type theDocFormatVersion

  int

  rtype

  void

SetLength()

• Set the length of the section in the persistent file

  param theLength

  type theLength

  uint64_t

  rtype

  None

SetOffset()

• Set the offset of the section in the persistent file

  param theOffset

  type theOffset

  uint64_t

  rtype

  None

Write()

• Save Offset and Length data into the Section entry in the Document TOC (list of sections)

  param theOS

  type theOS

  Standard_OStream

  param theOffset

  type theOffset

  uint64_t

  rtype

  None

WriteTOCToString(BinLDrivers_DocumentSection self) → std::string

property thisown

The membership flag

class BinLDrivers_DocumentStorageDriver(*args)

Bases: OCC.Core.PCDM.PCDM_StorageDriver

• Constructor

  rtype

  None

AddSection()

• Create a section that should be written after the OCAF data

  param theName

  type theName

  TCollection_AsciiString

  param isPostRead

  default value is Standard_True

  type isPostRead

  bool

  rtype

  None

AttributeDrivers()

Parameters

theMsgDriver –

type theMsgDriver

Message_Messenger

rtype

opencascade::handle<BinMDF_ADriverTable>

static DownCast(t)

Write()

• Write <theDocument> to the binary file <theFileName>

  param theDocument

  type theDocument

  CDM_Document

  param theFileName

  type theFileName

  TCollection_ExtendedString

  rtype

  void* Write <theDocument> to theOStream

  param theDocument

  type theDocument

  CDM_Document

  param theOStream

  type theOStream

  Standard_OStream

  rtype

  void

property thisown

The membership flag

class BinLDrivers_VectorOfDocumentSection(*args)

Bases: object

Append()

Appended()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

First()

IsEmpty()

Last()

Length()

Lower()

Set()

SetValue()

Size()

Upper()

Value()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class binldrivers

Bases: object

static AttributeDrivers()

• Creates a table of the supported drivers’ types

  param MsgDrv

  type MsgDrv

  Message_Messenger

  rtype

  opencascade::handle<BinMDF_ADriverTable>

static DefineFormat()

• Defines format ‘BinLOcaf’ and registers its read and write drivers in the specified application

  param theApp

  type theApp

  TDocStd_Application

  rtype

  void

static Factory()

Parameters

theGUID –

type theGUID

Standard_GUID

rtype

opencascade::handle<Standard_Transient>

static StorageVersion()

• returns last storage version

  rtype

  TCollection_AsciiString

property thisown

The membership flag