OCC.Core.PCDM module

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

class PCDM_ReadWriter(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

static FileFormat()

• tries to get a format in the file. returns an empty string if the file could not be read or does not have a FileFormat information.

  param aFileName

  type aFileName

  TCollection_ExtendedString

  rtype

  TCollection_ExtendedString* tries to get a format from the stream. returns an empty string if the file could not be read or does not have a FileFormat information.

  param theIStream

  type theIStream

  Standard_IStream

  param theData

  type theData

  Storage_Data

  rtype

  TCollection_ExtendedString

static Open()

Parameters

aDriver –

type aDriver

Storage_BaseDriver

param aFileName

type aFileName

TCollection_ExtendedString

param anOpenMode

type anOpenMode

Storage_OpenMode

rtype

void

ReadDocumentVersion()

Parameters

aFileName –

type aFileName

TCollection_ExtendedString

param theMsgDriver

type theMsgDriver

Message_Messenger

rtype

int

ReadExtensions()

Parameters

aFileName –

type aFileName

TCollection_ExtendedString

param theExtensions

type theExtensions

TColStd_SequenceOfExtendedString

param theMsgDriver

type theMsgDriver

Message_Messenger

rtype

void

ReadReferenceCounter()

Parameters

theFileName –

type theFileName

TCollection_ExtendedString

param theMsgDriver

type theMsgDriver

Message_Messenger

rtype

int

ReadReferences()

Parameters

aFileName –

type aFileName

TCollection_ExtendedString

param theReferences

type theReferences

PCDM_SequenceOfReference

param theMsgDriver

type theMsgDriver

Message_Messenger

rtype

void

static Reader()

• returns the convenient Reader for a File.

  param aFileName

  type aFileName

  TCollection_ExtendedString

  rtype

  opencascade::handle<PCDM_ReadWriter>

Version()

• returns PCDM_ReadWriter_1.

  rtype

  TCollection_AsciiString

WriteExtensions()

Parameters

aData –

type aData

Storage_Data

param aDocument

type aDocument

CDM_Document

rtype

void

static WriteFileFormat()

Parameters

aData –

type aData

Storage_Data

param aDocument

type aDocument

CDM_Document

rtype

void

WriteReferenceCounter()

Parameters

aData –

type aData

Storage_Data

param aDocument

type aDocument

CDM_Document

rtype

void

WriteReferences()

Parameters

aData –

type aData

Storage_Data

param aDocument

type aDocument

CDM_Document

param theReferencerFileName

type theReferencerFileName

TCollection_ExtendedString

rtype

void

WriteVersion()

Parameters

aData –

type aData

Storage_Data

param aDocument

type aDocument

CDM_Document

rtype

void

static Writer()

Return type

opencascade::handle<PCDM_ReadWriter>

property thisown

The membership flag

class PCDM_ReadWriter_1(*args)

Bases: OCC.Core.PCDM.PCDM_ReadWriter

Return type

None

static DownCast(t)

property thisown

The membership flag

class PCDM_Reader(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

CreateDocument()

• this method is called by the framework before the read method.

  rtype

  opencascade::handle<CDM_Document>

static DownCast(t)

GetStatus()

Return type

PCDM_ReaderStatus

Read()

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

  param aFileName

  type aFileName

  TCollection_ExtendedString

  param aNewDocument

  type aNewDocument

  CDM_Document

  param anApplication

  type anApplication

  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 PCDM_Reference(*args)

Bases: object

Return type

None:param aReferenceIdentifier: :type aReferenceIdentifier: int :param aFileName: :type aFileName: TCollection_ExtendedString :param aDocumentVersion: :type aDocumentVersion: int :rtype: None

DocumentVersion()

Return type

int

FileName()

Return type

TCollection_ExtendedString

ReferenceIdentifier()

Return type

int

property thisown

The membership flag

class PCDM_ReferenceIterator(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Warning! The constructor does not initialization.

  param theMessageDriver

  type theMessageDriver

  Message_Messenger

  rtype

  None

static DownCast(t)

Init()

Parameters

aMetaData –

type aMetaData

CDM_MetaData

rtype

void

LoadReferences()

Parameters

aDocument –

type aDocument

CDM_Document

param aMetaData

type aMetaData

CDM_MetaData

param anApplication

type anApplication

CDM_Application

param UseStorageConfiguration

type UseStorageConfiguration

bool

rtype

None

property thisown

The membership flag

class PCDM_RetrievalDriver(*args, **kwargs)

Bases: OCC.Core.PCDM.PCDM_Reader

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DocumentVersion()

Parameters

theFileName –

type theFileName

TCollection_ExtendedString

param theMsgDriver

type theMsgDriver

Message_Messenger

rtype

int

static DownCast(t)

GetFormat()

Return type

TCollection_ExtendedString

static ReferenceCounter()

Parameters

theFileName –

type theFileName

TCollection_ExtendedString

param theMsgDriver

type theMsgDriver

Message_Messenger

rtype

int

SetFormat()

Parameters

aformat –

type aformat

TCollection_ExtendedString

rtype

None

property thisown

The membership flag

class PCDM_SequenceOfDocument(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class PCDM_SequenceOfReference(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class PCDM_StorageDriver

Bases: OCC.Core.PCDM.PCDM_Writer

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

GetFormat()

Return type

TCollection_ExtendedString

GetStoreStatus()

Return type

PCDM_StoreStatus

IsError()

Return type

bool

Make()

• raises NotImplemented.

  param aDocument

  type aDocument

  CDM_Document

  rtype

  opencascade::handle<PCDM_Document>* By default, puts in the Sequence the document returns by the previous Make method.

  param aDocument

  type aDocument

  CDM_Document

  param Documents

  type Documents

  PCDM_SequenceOfDocument

  rtype

  void

SetFormat()

Parameters

aformat –

type aformat

TCollection_ExtendedString

rtype

None

SetIsError()

Parameters

theIsError –

type theIsError

bool

rtype

None

SetStoreStatus()

Parameters

theStoreStatus –

type theStoreStatus

PCDM_StoreStatus

rtype

None

Write()

• Warning! raises DriverError if an error occurs during inside the Make method. stores the content of the Document into a new file. //! by default Write will use Make method to build a persistent document and the Schema method to write the persistent document.

  param aDocument

  type aDocument

  CDM_Document

  param aFileName

  type aFileName

  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 PCDM_Writer(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

Write()

Parameters

aDocument –

type aDocument

CDM_Document

param aFileName

type aFileName

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 SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class pcdm

Bases: object

static FileDriverType()

Parameters

aFileName –

type aFileName

TCollection_AsciiString

param aBaseDriver

type aBaseDriver

PCDM_BaseDriverPointer

rtype

PCDM_TypeOfFileDriver:param theIStream:

type theIStream

Standard_IStream

param theBaseDriver

type theBaseDriver

PCDM_BaseDriverPointer

rtype

PCDM_TypeOfFileDriver

property thisown

The membership flag