OCC.PCDM module¶
-
class
Handle_PCDM_Document
(*args)¶ Bases:
object
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_ReadWriter
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_ReadWriter_1
(*args)¶ Bases:
OCC.PCDM.Handle_PCDM_ReadWriter
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_Reader
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_ReferenceIterator
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_RetrievalDriver
(*args)¶ Bases:
OCC.PCDM.Handle_PCDM_Reader
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_SequenceNodeOfSequenceOfDocument
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_SeqNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_SequenceNodeOfSequenceOfReference
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_SeqNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_StorageDriver
(*args)¶ Bases:
OCC.PCDM.Handle_PCDM_Writer
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_PCDM_Writer
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
PCDM_Document
(*args)¶ Bases:
object
Parameters: a (Storage_stCONSTclCOM &) – Return type: None Return type: None -
GetHandle
()¶
-
thisown
¶ The membership flag
-
-
class
PCDM_ReadWriter
(*args, **kwargs)¶ Bases:
OCC.Standard.Standard_Transient
-
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.
Parameters: aFileName (TCollection_ExtendedString &) – Return type: TCollection_ExtendedString
-
GetHandle
()¶
-
static
Open
()¶ Parameters: - aDriver (Storage_BaseDriver &) –
- aFileName (TCollection_ExtendedString &) –
- anOpenMode (Storage_OpenMode) –
Return type: void
-
ReadDocumentVersion
()¶ Parameters: - aFileName (TCollection_ExtendedString &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type:
-
ReadExtensions
()¶ Parameters: - aFileName (TCollection_ExtendedString &) –
- theExtensions (TColStd_SequenceOfExtendedString &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type: void
-
ReadReferenceCounter
()¶ Parameters: - theFileName (TCollection_ExtendedString &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type:
-
ReadReferences
()¶ Parameters: - aFileName (TCollection_ExtendedString &) –
- theReferences (PCDM_SequenceOfReference &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type: void
-
static
Reader
(*args) → OCC.PCDM.Handle_PCDM_ReadWriter¶ - returns the convenient Reader for a File.
Parameters: aFileName (TCollection_ExtendedString &) – Return type: Handle_PCDM_ReadWriter
-
Version
()¶ - returns PCDM_ReadWriter_1.
Return type: TCollection_AsciiString
-
WriteExtensions
()¶ Parameters: - aData (Handle_Storage_Data &) –
- aDocument (Handle_CDM_Document &) –
Return type: void
-
static
WriteFileFormat
()¶ Parameters: - aData (Handle_Storage_Data &) –
- aDocument (Handle_CDM_Document &) –
Return type: void
-
WriteReferenceCounter
()¶ Parameters: - aData (Handle_Storage_Data &) –
- aDocument (Handle_CDM_Document &) –
Return type: void
-
WriteReferences
()¶ Parameters: - aData (Handle_Storage_Data &) –
- aDocument (Handle_CDM_Document &) –
- theReferencerFileName (TCollection_ExtendedString &) –
Return type: void
-
WriteVersion
()¶ Parameters: - aData (Handle_Storage_Data &) –
- aDocument (Handle_CDM_Document &) –
Return type: void
-
static
Writer
(*args) → OCC.PCDM.Handle_PCDM_ReadWriter¶ Return type: Handle_PCDM_ReadWriter
-
thisown
¶ The membership flag
-
static
-
class
PCDM_ReadWriter_1
(*args)¶ Bases:
OCC.PCDM.PCDM_ReadWriter
Return type: None -
GetHandle
()¶
-
thisown
¶ The membership flag
-
-
PCDM_ReadWriter_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.
Parameters: aFileName (TCollection_ExtendedString &) – Return type: TCollection_ExtendedString
-
PCDM_ReadWriter_Open
()¶ Parameters: - aDriver (Storage_BaseDriver &) –
- aFileName (TCollection_ExtendedString &) –
- anOpenMode (Storage_OpenMode) –
Return type: void
-
PCDM_ReadWriter_Reader
(*args) → OCC.PCDM.Handle_PCDM_ReadWriter¶ - returns the convenient Reader for a File.
Parameters: aFileName (TCollection_ExtendedString &) – Return type: Handle_PCDM_ReadWriter
-
PCDM_ReadWriter_WriteFileFormat
()¶ Parameters: - aData (Handle_Storage_Data &) –
- aDocument (Handle_CDM_Document &) –
Return type: void
-
PCDM_ReadWriter_Writer
(*args) → OCC.PCDM.Handle_PCDM_ReadWriter¶ Return type: Handle_PCDM_ReadWriter
-
class
PCDM_Reader
(*args, **kwargs)¶ Bases:
OCC.Standard.Standard_Transient
-
CreateDocument
()¶ - this method is called by the framework before the read method.
Return type: Handle_CDM_Document
-
GetHandle
()¶
-
GetStatus
()¶ Return type: PCDM_ReaderStatus
-
Read
()¶ - retrieves the content of the file into a new Document.
Parameters: - aFileName (TCollection_ExtendedString &) –
- aNewDocument (Handle_CDM_Document &) –
- anApplication (Handle_CDM_Application &) –
Return type: void
-
thisown
¶ The membership flag
-
-
class
PCDM_Reference
(*args)¶ Bases:
object
Return type: Parameters: Return type: -
FileName
()¶ Return type: TCollection_ExtendedString
-
thisown
¶ The membership flag
-
-
class
PCDM_ReferenceIterator
(*args)¶ Bases:
OCC.Standard.Standard_Transient
- Warning! The constructor does not initialization.
Parameters: theMessageDriver (Handle_CDM_MessageDriver &) – Return type: None -
GetHandle
()¶
-
Init
()¶ Parameters: aMetaData (Handle_CDM_MetaData &) – Return type: void
-
LoadReferences
()¶ Parameters: - aDocument (Handle_CDM_Document &) –
- aMetaData (Handle_CDM_MetaData &) –
- anApplication (Handle_CDM_Application &) –
- UseStorageConfiguration (bool) –
Return type:
-
thisown
¶ The membership flag
-
class
PCDM_RetrievalDriver
(*args, **kwargs)¶ Bases:
OCC.PCDM.PCDM_Reader
-
static
DocumentVersion
()¶ Parameters: - aFileName (TCollection_ExtendedString &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type:
-
GetFormat
()¶ Return type: TCollection_ExtendedString
-
GetHandle
()¶
-
LoadExtensions
()¶ Parameters: - aSchema (Handle_Storage_Schema &) –
- Extensions (TColStd_SequenceOfExtendedString &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type: void
-
Make
()¶ Parameters: - aPCDM (Handle_PCDM_Document &) –
- aNewDocument (Handle_CDM_Document &) –
Return type: void
-
static
RaiseIfUnknownTypes
()¶ Parameters: - aSchema (Handle_Storage_Schema &) –
- aFileName (TCollection_ExtendedString &) –
Return type: void
-
static
ReferenceCounter
()¶ Parameters: - aFileName (TCollection_ExtendedString &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type:
-
SchemaName
()¶ Return type: TCollection_ExtendedString
-
thisown
¶ The membership flag
-
static
-
PCDM_RetrievalDriver_DocumentVersion
()¶ Parameters: - aFileName (TCollection_ExtendedString &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type:
-
PCDM_RetrievalDriver_RaiseIfUnknownTypes
()¶ Parameters: - aSchema (Handle_Storage_Schema &) –
- aFileName (TCollection_ExtendedString &) –
Return type: void
-
PCDM_RetrievalDriver_ReferenceCounter
()¶ Parameters: - aFileName (TCollection_ExtendedString &) –
- theMsgDriver (Handle_CDM_MessageDriver &) –
Return type:
-
class
PCDM_SequenceNodeOfSequenceOfDocument
(*args)¶ Bases:
OCC.TCollection.TCollection_SeqNode
Parameters: - I (Handle_PCDM_Document &) –
- n (TCollection_SeqNodePtr &) –
- p (TCollection_SeqNodePtr &) –
Return type: -
GetHandle
()¶
-
Value
()¶ Return type: Handle_PCDM_Document
-
thisown
¶ The membership flag
-
class
PCDM_SequenceNodeOfSequenceOfReference
(*args)¶ Bases:
OCC.TCollection.TCollection_SeqNode
Parameters: - I (PCDM_Reference &) –
- n (TCollection_SeqNodePtr &) –
- p (TCollection_SeqNodePtr &) –
Return type: -
GetHandle
()¶
-
Value
()¶ Return type: PCDM_Reference
-
thisown
¶ The membership flag
-
class
PCDM_SequenceOfDocument
(*args)¶ Bases:
OCC.TCollection.TCollection_BaseSequence
Return type: None Parameters: Other (PCDM_SequenceOfDocument &) – Return type: None -
Append
()¶ Parameters: - T (Handle_PCDM_Document &) –
- S (PCDM_SequenceOfDocument &) –
Return type: Return type:
-
Assign
()¶ Parameters: Other (PCDM_SequenceOfDocument &) – Return type: PCDM_SequenceOfDocument
-
ChangeValue
()¶ Parameters: Index (int) – Return type: Handle_PCDM_Document
-
First
()¶ Return type: Handle_PCDM_Document
-
InsertAfter
()¶ Parameters: - Index (int) –
- T (Handle_PCDM_Document &) –
- Index –
- S (PCDM_SequenceOfDocument &) –
Return type: Return type:
-
InsertBefore
()¶ Parameters: - Index (int) –
- T (Handle_PCDM_Document &) –
- Index –
- S (PCDM_SequenceOfDocument &) –
Return type: Return type:
-
Last
()¶ Return type: Handle_PCDM_Document
-
Prepend
()¶ Parameters: - T (Handle_PCDM_Document &) –
- S (PCDM_SequenceOfDocument &) –
Return type: Return type:
-
Remove
()¶ Parameters: Return type: Return type:
-
Set
()¶ Parameters: Other (PCDM_SequenceOfDocument &) – Return type: PCDM_SequenceOfDocument
-
Value
()¶ Parameters: Index (int) – Return type: Handle_PCDM_Document
-
thisown
¶ The membership flag
-
-
class
PCDM_SequenceOfReference
(*args)¶ Bases:
OCC.TCollection.TCollection_BaseSequence
Return type: None Parameters: Other (PCDM_SequenceOfReference &) – Return type: None -
Append
()¶ Parameters: - T (PCDM_Reference &) –
- S (PCDM_SequenceOfReference &) –
Return type: Return type:
-
Assign
()¶ Parameters: Other (PCDM_SequenceOfReference &) – Return type: PCDM_SequenceOfReference
-
ChangeValue
()¶ Parameters: Index (int) – Return type: PCDM_Reference
-
First
()¶ Return type: PCDM_Reference
-
InsertAfter
()¶ Parameters: - Index (int) –
- T (PCDM_Reference &) –
- Index –
- S (PCDM_SequenceOfReference &) –
Return type: Return type:
-
InsertBefore
()¶ Parameters: - Index (int) –
- T (PCDM_Reference &) –
- Index –
- S (PCDM_SequenceOfReference &) –
Return type: Return type:
-
Last
()¶ Return type: PCDM_Reference
-
Prepend
()¶ Parameters: - T (PCDM_Reference &) –
- S (PCDM_SequenceOfReference &) –
Return type: Return type:
-
Remove
()¶ Parameters: Return type: Return type:
-
Set
()¶ Parameters: Other (PCDM_SequenceOfReference &) – Return type: PCDM_SequenceOfReference
-
Value
()¶ Parameters: Index (int) – Return type: PCDM_Reference
-
thisown
¶ The membership flag
-
-
class
PCDM_StorageDriver
(*args, **kwargs)¶ Bases:
OCC.PCDM.PCDM_Writer
-
GetFormat
()¶ Return type: TCollection_ExtendedString
-
GetHandle
()¶
-
GetStoreStatus
()¶ Return type: PCDM_StoreStatus
-
LoadExtensions
()¶ Parameters: - aSchema (Handle_Storage_Schema &) –
- Extensions (TColStd_SequenceOfExtendedString &) –
Return type: void
-
Make
()¶ - raises NotImplemented.
Parameters: aDocument (Handle_CDM_Document &) – Return type: Handle_PCDM_Document - By default, puts in the Sequence the document returns by the previous Make method.
Parameters: - aDocument (Handle_CDM_Document &) –
- Documents (PCDM_SequenceOfDocument &) –
Return type: void
-
SchemaName
()¶ Return type: TCollection_ExtendedString
-
thisown
¶ The membership flag
-
-
class
PCDM_Writer
(*args, **kwargs)¶ Bases:
OCC.Standard.Standard_Transient
-
GetHandle
()¶
-
Write
()¶ Parameters: - aDocument (Handle_CDM_Document &) –
- aFileName (TCollection_ExtendedString &) –
Return type: void
-
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)¶
-
class
pcdm
¶ Bases:
object
-
static
Schema
()¶ - returns a schema to be used during a Store or Retrieve operation. Schema will plug the schema defined by the SchemaName method.
Parameters: - aSchemaName (TCollection_ExtendedString &) –
- anApplication (Handle_CDM_Application &) –
Return type:
-
static
StorageDriver
(*args) → OCC.PCDM.Handle_PCDM_StorageDriver¶ - gets in the EuclidDesktop resource the plugin identifier of the driver plugs the driver.
Parameters: aDocument (Handle_CDM_Document &) – Return type: Handle_PCDM_StorageDriver
-
thisown
¶ The membership flag
-
static
-
pcdm_Schema
()¶ - returns a schema to be used during a Store or Retrieve operation. Schema will plug the schema defined by the SchemaName method.
Parameters: - aSchemaName (TCollection_ExtendedString &) –
- anApplication (Handle_CDM_Application &) –
Return type:
-
pcdm_StorageDriver
(*args) → OCC.PCDM.Handle_PCDM_StorageDriver¶ - gets in the EuclidDesktop resource the plugin identifier of the driver plugs the driver.
Parameters: aDocument (Handle_CDM_Document &) – Return type: Handle_PCDM_StorageDriver
-
register_handle
(handle, base_object)¶ Inserts the handle into the base object to prevent memory corruption in certain cases