OCC.CDM module

class CDM_Application(*args, **kwargs)

Bases: OCC.Standard.Standard_Transient

BeginOfUpdate()
  • this method is called before the update of a document. By default, writes in MessageDriver().
Parameters:aDocument (Handle_CDM_Document &) –
Return type:void
EndOfUpdate()
  • this method is called affter the update of a document. By default, writes in MessageDriver().
Parameters:
  • aDocument (Handle_CDM_Document &) –
  • Status (bool) –
  • ErrorString (TCollection_ExtendedString &) –
Return type:

void

GetHandle()
MessageDriver()
  • By default returns a NullMessageDriver;
Return type:Handle_CDM_MessageDriver
Resources()
  • the manager returned by this virtual method will be used to search for Format`.Retrieval resource items.
Return type:Handle_Resource_Manager
Write()
  • writes the string in the application MessagerDriver.
Parameters:aString (Standard_ExtString) –
Return type:None
thisown

The membership flag

class CDM_COutMessageDriver(*args, **kwargs)

Bases: OCC.CDM.CDM_MessageDriver

GetHandle()
thisown

The membership flag

class CDM_DataMapIteratorOfMetaDataLookUpTable(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (CDM_MetaDataLookUpTable &) –
Return type:None
Initialize()
Parameters:aMap (CDM_MetaDataLookUpTable &) –
Return type:None
Key()
Return type:TCollection_ExtendedString
Value()
Return type:Handle_CDM_MetaData
thisown

The membership flag

class CDM_DataMapIteratorOfPresentationDirectory(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (CDM_PresentationDirectory &) –
Return type:None
Initialize()
Parameters:aMap (CDM_PresentationDirectory &) –
Return type:None
Key()
Return type:TCollection_ExtendedString
Value()
Return type:Handle_CDM_Document
thisown

The membership flag

class CDM_DataMapNodeOfMetaDataLookUpTable(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (TCollection_ExtendedString &) –
  • I (Handle_CDM_MetaData &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:TCollection_ExtendedString
Value()
Return type:Handle_CDM_MetaData
thisown

The membership flag

class CDM_DataMapNodeOfPresentationDirectory(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (TCollection_ExtendedString &) –
  • I (Handle_CDM_Document &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:TCollection_ExtendedString
Value()
Return type:Handle_CDM_Document
thisown

The membership flag

class CDM_Document(*args, **kwargs)

Bases: OCC.Standard.Standard_Transient

AddComment()
  • appends a comment into comments of this document.
Parameters:aComment (TCollection_ExtendedString &) –
Return type:None
Application()
Return type:Handle_CDM_Application
CanClose()
Return type:CDM_CanCloseStatus
CanCloseReference()
  • A referenced document may indicate through this virtual method that it does not allow the closing of aDocument which it references through the reference aReferenceIdentifier. By default returns Standard_True;;
Parameters:
  • aDocument (Handle_CDM_Document &) –
  • aReferenceIdentifier (int) –
Return type:

bool

Close()
Return type:None
CloseReference()
  • A referenced document may update its internal data structure when {aDocument} which it references through the reference {aReferenceIdentifier} is being closed. By default this method does nothing.
Parameters:
  • aDocument (Handle_CDM_Document &) –
  • aReferenceIdentifier (int) –
Return type:

void

Comment()
  • returns the first of associated comments. By defaut the comment is an empty string.
Return type:Standard_ExtString
Comments()
  • returns the associated comments through <aComments>. Returns empty sequence if no comments are associated.
Parameters:aComments (TColStd_SequenceOfExtendedString &) –
Return type:None
CopyReference()
  • Copies a reference to this document. This method avoid retrieval of referenced document. The arguments are the original document and a valid reference identifier Returns the local identifier.
Parameters:
  • aFromDocument (Handle_CDM_Document &) –
  • aReferenceIdentifier (int) –
Return type:

int

CreateReference()
  • Creates a reference from this document to {anOtherDocument}. Returns a reference identifier. This reference identifier is unique in the document and will not be used for the next references, even after the storing of the document. If there is already a reference between the two documents, the reference is not created, but its reference identifier is returned.
Parameters:
  • anOtherDocument (Handle_CDM_Document &) –
  • aMetaData (Handle_CDM_MetaData &) –
  • aReferenceIdentifier (int) –
  • anApplication (Handle_CDM_Application &) –
  • aToDocumentVersion (int) –
  • UseStorageConfiguration (bool) –
  • aMetaData
  • anApplication
  • aDocumentVersion (int) –
  • UseStorageConfiguration
Return type:

int

Return type:

None

Return type:

int

DataType()
  • this datatype will be used if the DBMS deals with this concept gets the FileFormat.DataType resource. concept.
Return type:TCollection_ExtendedString
DeepReferences()
  • returns True is this document references aDocument;
Parameters:aDocument (Handle_CDM_Document &) –
Return type:bool
Description()
  • gets the FileFormat.Description resource.
Return type:TCollection_ExtendedString
Document()
  • Returns the To Document of the reference identified by aReferenceIdentifier. If the ToDocument is stored and has not yet been retrieved, this method will retrieve it.
Parameters:aReferenceIdentifier (int) –
Return type:Handle_CDM_Document
Domain()
  • gets the FileFormat.Domain resource.
Return type:TCollection_ExtendedString
Extensions()
  • by default empties the extensions.
Parameters:Extensions (TColStd_SequenceOfExtendedString &) –
Return type:void
FileExtension()
  • gets the Desktop.Domain.Application.`FileFormat`.FileExtension resource.
Return type:TCollection_ExtendedString
FindDataType()
Return type:bool
FindDescription()
Return type:bool
FindDomain()
Return type:bool
FindFileExtension()
Return type:bool
static FindFromPresentation(*args) → OCC.CDM.Handle_CDM_Document
  • returns the document having the given alphanumeric presentation.
Parameters:aPresentation (TCollection_ExtendedString &) –
Return type:Handle_CDM_Document
static FindPresentation()
  • indicates whether a document having the given presentation does exist.
Parameters:aPresentation (TCollection_ExtendedString &) –
Return type:bool
FindStoragePlugin()
Return type:bool
FindVersionDataType()
Return type:bool
Folder()
Return type:TCollection_ExtendedString
FromReferencesNumber()
  • returns the number of references having this document as To Document.
Return type:int
GetAlternativeDocument()
  • This method can be redefined to extract another document in a different format. For example, to extract a MDTV-Shape from an applicative document.
Parameters:
  • aFormat (TCollection_ExtendedString &) –
  • anAlternativeDocument (Handle_CDM_Document &) –
Return type:

bool

GetHandle()
HasRequestedFolder()
Return type:bool
HasRequestedPreviousVersion()
Return type:bool
IsInSession()
  • returns True if the To Document of the reference identified by aReferenceIdentifier is in session, False if it corresponds to a not yet retrieved document.
Parameters:aReferenceIdentifier (int) –
Return type:bool
IsModified()
  • returns true if the version is greater than the storage version
Return type:bool
IsOpened()
Return type:bool
  • returns true if the document corresponding to the given reference has been retrieved and opened. Otherwise returns false. This method does not retrieve the referenced document
Parameters:aReferenceIdentifier (int) –
Return type:bool
IsReadOnly()
  • indicates that this document cannot be modified.
Return type:bool
  • indicates that the referenced document cannot be modified,
Parameters:aReferenceIdentifier (int) –
Return type:bool
IsStored()
  • returns True if the To Document of the reference identified by aReferenceIdentifier has already been stored, False otherwise.
Parameters:aReferenceIdentifier (int) –
Return type:bool
Return type:bool
IsUpToDate()
  • returns true if the modification counter found in the given reference is equal to the actual modification counter of the To Document. This method is able to deal with a reference to a not retrieved document.
Parameters:aReferenceIdentifier (int) –
Return type:bool
LoadResources()
  • read (or rereads) the following resource.
Return type:None
MetaData()
Return type:Handle_CDM_MetaData
Modifications()
  • returns the current modification counter.
Return type:int
Modify()
  • Indicates that this document has been modified. This method increments the modification counter.
Return type:None
Name()
  • returns the name of the metadata of the To Document of the reference identified by aReferenceIdentifier.
Parameters:aReferenceIdentifier (int) –
Return type:TCollection_ExtendedString
Open()
Parameters:anApplication (Handle_CDM_Application &) –
Return type:None
Presentation()
  • Returns an alphanumeric string identifying this document in a unique manner in the current process. The presentation may change when the document is stored. Tries to get the ‘FileFormat`.Presentation resource This item is used to give a default presentation to the document.
Return type:Standard_ExtString
PrintToString()

CDM_Document_PrintToString(CDM_Document self) -> std::string

ReferenceCounter()
Return type:int
RemoveAllReferences()
  • Removes all references having this document for From Document.
Return type:None
RemoveReference()
  • Removes the reference between the From Document and the To Document identified by a reference identifier.
Parameters:aReferenceIdentifier (int) –
Return type:None
RequestedComment()
Return type:TCollection_ExtendedString
RequestedFolder()
Return type:TCollection_ExtendedString
RequestedName()
  • determines under which the document is going to be store. By default the name of the document wil be – used. If the document has no name its presentation will be used.
Return type:TCollection_ExtendedString
RequestedPreviousVersion()
Return type:TCollection_ExtendedString
SetComment()
  • associates a comment with this document.
Parameters:aComment (TCollection_ExtendedString &) –
Return type:None
SetComments()
  • associates a comments with this document.
Parameters:aComments (TColStd_SequenceOfExtendedString &) –
Return type:None
SetIsReadOnly()
Return type:None
SetIsUpToDate()
  • Resets the modification counter in the given reference to the actual modification counter of its To Document. This method should be called after the application has updated this document.
Parameters:aReferenceIdentifier (int) –
Return type:None
SetMetaData()
  • associates database information to a document which has been stored. The name of the document is now the name which has beenused to store the data.
Parameters:aMetaData (Handle_CDM_MetaData &) –
Return type:None
SetRequestedComment()
  • defines the Comment with which the object should be stored.
Parameters:aComment (TCollection_ExtendedString &) –
Return type:None
SetRequestedFolder()
  • defines the folder in which the object should be stored.
Parameters:aFolder (TCollection_ExtendedString &) –
Return type:None
SetRequestedName()
  • defines the name under which the object should be stored.
Parameters:aName (TCollection_ExtendedString &) –
Return type:None
SetRequestedPreviousVersion()
Parameters:aPreviousVersion (TCollection_ExtendedString &) –
Return type:None
ShallowReferences()
  • returns True is this document references aDocument;
Parameters:aDocument (Handle_CDM_Document &) –
Return type:bool
StorageFormat()
  • The Storage Format is the key which is used to determine in the application resources the storage driver plugin, the file extension and other data used to store the document.
Return type:TCollection_ExtendedString
StoragePlugin()
Return type:Standard_GUID
StorageVersion()
  • returns the value of the modification counter at the time of storage. By default returns 0.
Return type:int
ToReferencesNumber()
  • returns the number of references having this document as From Document.
Return type:int
UnModify()
Return type:None
UnsetIsReadOnly()
Return type:None
UnsetIsStored()
Return type:None
UnsetRequestedPreviousVersion()
Return type:None
Update()
  • The Update method will be called once for each reference, but it should not perform any computation, to avoid multiple computation of a same document.
Parameters:
  • aToDocument (Handle_CDM_Document &) –
  • aReferenceIdentifier (int) –
  • aModifContext (Standard_Address) –
Return type:

void

  • This method Update will be called to signal the end of the modified references list. The document should be recomputed and UpdateFromDocuments should be called. Update should returns True in case of success, false otherwise. In case of Failure, additional information can be given in ErrorString.
Parameters:ErrorString (TCollection_ExtendedString &) –
Return type:bool
  • the following method should be used instead: //! Update(me:mutable; ErrorString: out ExtendedString from TCollection) returns Boolean from Standard
Return type:void
UpdateFromDocuments()
  • call virtual method Update on all referencing documents. This method keeps the list of the – documents to process.It may be the starting of an update – cycle. If not, the reentrant calls made by Update method (without argument) will append the referencing documents to the list and call the Update method (with arguments). Only the first call to UpdateFromDocuments generate call to Update().
Parameters:aModifContext (Standard_Address) –
Return type:None
VersionDataType()
  • this datatype will be used if the DBMS deals with this concept gets the FileFormat.VersionDataType resource.
Return type:TCollection_ExtendedString
thisown

The membership flag

class CDM_DocumentHasher

Bases: object

static HashCode()
Parameters:
  • K (Handle_CDM_Document &) –
  • Upper (int) –
Return type:

int

static IsEqual()
Parameters:
  • K1 (Handle_CDM_Document &) –
  • K2 (Handle_CDM_Document &) –
Return type:

bool

thisown

The membership flag

CDM_DocumentHasher_HashCode()
Parameters:
  • K (Handle_CDM_Document &) –
  • Upper (int) –
Return type:

int

CDM_DocumentHasher_IsEqual()
Parameters:
  • K1 (Handle_CDM_Document &) –
  • K2 (Handle_CDM_Document &) –
Return type:

bool

CDM_Document_FindFromPresentation(*args) → OCC.CDM.Handle_CDM_Document
  • returns the document having the given alphanumeric presentation.
Parameters:aPresentation (TCollection_ExtendedString &) –
Return type:Handle_CDM_Document
CDM_Document_FindPresentation()
  • indicates whether a document having the given presentation does exist.
Parameters:aPresentation (TCollection_ExtendedString &) –
Return type:bool
class CDM_ListIteratorOfListOfDocument(*args)

Bases: object

Return type:None
Parameters:L (CDM_ListOfDocument &) –
Return type:None
Initialize()
Parameters:L (CDM_ListOfDocument &) –
Return type:None
More()
Return type:bool
Next()
Return type:None
Value()
Return type:Handle_CDM_Document
thisown

The membership flag

class CDM_ListIteratorOfListOfReferences(*args)

Bases: object

Return type:None
Parameters:L (CDM_ListOfReferences &) –
Return type:None
Initialize()
Parameters:L (CDM_ListOfReferences &) –
Return type:None
More()
Return type:bool
Next()
Return type:None
Value()
Return type:Handle_CDM_Reference
thisown

The membership flag

class CDM_ListNodeOfListOfDocument(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • I (Handle_CDM_Document &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Value()
Return type:Handle_CDM_Document
thisown

The membership flag

class CDM_ListNodeOfListOfReferences(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • I (Handle_CDM_Reference &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Value()
Return type:Handle_CDM_Reference
thisown

The membership flag

class CDM_ListOfDocument(*args)

Bases: object

Return type:None
Parameters:Other (CDM_ListOfDocument &) –
Return type:None
Append()
Parameters:
  • I (Handle_CDM_Document &) –
  • I
  • theIt (CDM_ListIteratorOfListOfDocument &) –
  • Other (CDM_ListOfDocument &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (CDM_ListOfDocument &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Handle_CDM_Document
InsertAfter()
Parameters:
  • I (Handle_CDM_Document &) –
  • It (CDM_ListIteratorOfListOfDocument &) –
  • Other (CDM_ListOfDocument &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Handle_CDM_Document &) –
  • It (CDM_ListIteratorOfListOfDocument &) –
  • Other (CDM_ListOfDocument &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Handle_CDM_Document
Prepend()
Parameters:
  • I (Handle_CDM_Document &) –
  • I
  • theIt (CDM_ListIteratorOfListOfDocument &) –
  • Other (CDM_ListOfDocument &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (CDM_ListIteratorOfListOfDocument &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (CDM_ListOfDocument &) –
Return type:None
thisown

The membership flag

class CDM_ListOfReferences(*args)

Bases: object

Return type:None
Parameters:Other (CDM_ListOfReferences &) –
Return type:None
Append()
Parameters:
  • I (Handle_CDM_Reference &) –
  • I
  • theIt (CDM_ListIteratorOfListOfReferences &) –
  • Other (CDM_ListOfReferences &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (CDM_ListOfReferences &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Handle_CDM_Reference
InsertAfter()
Parameters:
  • I (Handle_CDM_Reference &) –
  • It (CDM_ListIteratorOfListOfReferences &) –
  • Other (CDM_ListOfReferences &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Handle_CDM_Reference &) –
  • It (CDM_ListIteratorOfListOfReferences &) –
  • Other (CDM_ListOfReferences &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Handle_CDM_Reference
Prepend()
Parameters:
  • I (Handle_CDM_Reference &) –
  • I
  • theIt (CDM_ListIteratorOfListOfReferences &) –
  • Other (CDM_ListOfReferences &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (CDM_ListIteratorOfListOfReferences &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (CDM_ListOfReferences &) –
Return type:None
thisown

The membership flag

class CDM_MapIteratorOfMapOfDocument(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (CDM_MapOfDocument &) –
Return type:None
Initialize()
Parameters:aMap (CDM_MapOfDocument &) –
Return type:None
Key()
Return type:Handle_CDM_Document
thisown

The membership flag

class CDM_MapOfDocument(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:
  • NbBuckets (int) – default value is 1
  • Other (CDM_MapOfDocument &) –
Return type:

None

Return type:

None

Add()
Parameters:aKey (Handle_CDM_Document &) –
Return type:bool
Assign()
Parameters:Other (CDM_MapOfDocument &) –
Return type:CDM_MapOfDocument
Clear()
Return type:None
Contains()
Parameters:aKey (Handle_CDM_Document &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Remove()
Parameters:aKey (Handle_CDM_Document &) –
Return type:bool
Set()
Parameters:Other (CDM_MapOfDocument &) –
Return type:CDM_MapOfDocument
thisown

The membership flag

class CDM_MessageDriver(*args, **kwargs)

Bases: OCC.Standard.Standard_Transient

GetHandle()
Write()
Parameters:aString (Standard_ExtString) –
Return type:void
thisown

The membership flag

class CDM_MetaData(*args, **kwargs)

Bases: OCC.Standard.Standard_Transient

Document()
Return type:Handle_CDM_Document
FileName()
Return type:TCollection_ExtendedString
Folder()
  • returns the folder in which the meta-data has to be created or has to be found.
Return type:TCollection_ExtendedString
GetHandle()
HasVersion()
  • indicates that the version has to be taken into account when searching the corresponding meta-data.
Return type:bool
IsReadOnly()
Return type:bool
IsRetrieved()
Return type:bool
static LookUp(*args) → OCC.CDM.Handle_CDM_MetaData
Parameters:
  • aFolder (TCollection_ExtendedString &) –
  • aName (TCollection_ExtendedString &) –
  • aPath (TCollection_ExtendedString &) –
  • aFileName (TCollection_ExtendedString &) –
  • ReadOnly (bool) –
  • aFolder
  • aName
  • aPath
  • aVersion (TCollection_ExtendedString &) –
  • aFileName
  • ReadOnly
Return type:

Handle_CDM_MetaData

Return type:

Handle_CDM_MetaData

Name()
  • returns the name under which the meta-data has to be created or has to be found.
Return type:TCollection_ExtendedString
Path()
Return type:TCollection_ExtendedString
PrintToString()

CDM_MetaData_PrintToString(CDM_MetaData self) -> std::string

SetIsReadOnly()
Return type:None
UnsetDocument()
Return type:None
UnsetIsReadOnly()
Return type:None
Version()
  • returns the version under which the meta-data has to be found. Warning: raises NoSuchObject from Standard if no Version has been defined
Return type:TCollection_ExtendedString
thisown

The membership flag

class CDM_MetaDataLookUpTable(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (CDM_MetaDataLookUpTable &) –
Return type:CDM_MetaDataLookUpTable
Bind()
Parameters:
  • K (TCollection_ExtendedString &) –
  • I (Handle_CDM_MetaData &) –
Return type:

bool

ChangeFind()
Parameters:K (TCollection_ExtendedString &) –
Return type:Handle_CDM_MetaData
ChangeFind1()
Parameters:K (TCollection_ExtendedString &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (TCollection_ExtendedString &) –
Return type:Handle_CDM_MetaData
Find1()
Parameters:K (TCollection_ExtendedString &) –
Return type:Standard_Address
IsBound()
Parameters:K (TCollection_ExtendedString &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (CDM_MetaDataLookUpTable &) –
Return type:CDM_MetaDataLookUpTable
UnBind()
Parameters:K (TCollection_ExtendedString &) –
Return type:bool
thisown

The membership flag

CDM_MetaData_LookUp(*args) → OCC.CDM.Handle_CDM_MetaData
Parameters:
  • aFolder (TCollection_ExtendedString &) –
  • aName (TCollection_ExtendedString &) –
  • aPath (TCollection_ExtendedString &) –
  • aFileName (TCollection_ExtendedString &) –
  • ReadOnly (bool) –
  • aFolder
  • aName
  • aPath
  • aVersion (TCollection_ExtendedString &) –
  • aFileName
  • ReadOnly
Return type:

Handle_CDM_MetaData

Return type:

Handle_CDM_MetaData

class CDM_NullMessageDriver(*args)

Bases: OCC.CDM.CDM_MessageDriver

Return type:None
GetHandle()
thisown

The membership flag

class CDM_PresentationDirectory(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (CDM_PresentationDirectory &) –
Return type:CDM_PresentationDirectory
Bind()
Parameters:
  • K (TCollection_ExtendedString &) –
  • I (Handle_CDM_Document &) –
Return type:

bool

ChangeFind()
Parameters:K (TCollection_ExtendedString &) –
Return type:Handle_CDM_Document
ChangeFind1()
Parameters:K (TCollection_ExtendedString &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (TCollection_ExtendedString &) –
Return type:Handle_CDM_Document
Find1()
Parameters:K (TCollection_ExtendedString &) –
Return type:Standard_Address
IsBound()
Parameters:K (TCollection_ExtendedString &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (CDM_PresentationDirectory &) –
Return type:CDM_PresentationDirectory
UnBind()
Parameters:K (TCollection_ExtendedString &) –
Return type:bool
thisown

The membership flag

class CDM_Reference(*args, **kwargs)

Bases: OCC.Standard.Standard_Transient

DocumentVersion()
Return type:int
FromDocument()
Return type:Handle_CDM_Document
GetHandle()
IsReadOnly()
Return type:bool
ReferenceIdentifier()
Return type:int
ToDocument()
Return type:Handle_CDM_Document
thisown

The membership flag

class CDM_ReferenceIterator(*args)

Bases: object

Parameters:aDocument (Handle_CDM_Document &) –
Return type:None
Document()
Return type:Handle_CDM_Document
DocumentVersion()
  • returns the Document Version in the reference.
Return type:int
More()
Return type:bool
Next()
Return type:None
ReferenceIdentifier()
Return type:int
thisown

The membership flag

class CDM_StdMapNodeOfMapOfDocument(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (Handle_CDM_Document &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:Handle_CDM_Document
thisown

The membership flag

class Handle_CDM_Application(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_COutMessageDriver(*args)

Bases: OCC.CDM.Handle_CDM_MessageDriver

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_DataMapNodeOfMetaDataLookUpTable(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_DataMapNodeOfPresentationDirectory(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_Document(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_ListNodeOfListOfDocument(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_ListNodeOfListOfReferences(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_MessageDriver(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_MetaData(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_NullMessageDriver(*args)

Bases: OCC.CDM.Handle_CDM_MessageDriver

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_Reference(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_CDM_StdMapNodeOfMapOfDocument(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
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