OCC.TDF module

class Handle_TDF_Attribute(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_TDF_AttributeDelta(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_TDF_Data(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_TDF_DataMapNodeOfAttributeDataMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_DataMapNodeOfLabelDataMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_DataMapNodeOfLabelIntegerMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_DataSet(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_TDF_DefaultDeltaOnModification(*args)

Bases: OCC.TDF.Handle_TDF_DeltaOnModification

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

The membership flag

class Handle_TDF_DefaultDeltaOnRemoval(*args)

Bases: OCC.TDF.Handle_TDF_DeltaOnRemoval

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

The membership flag

class Handle_TDF_Delta(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_TDF_DeltaOnAddition(*args)

Bases: OCC.TDF.Handle_TDF_AttributeDelta

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

The membership flag

class Handle_TDF_DeltaOnForget(*args)

Bases: OCC.TDF.Handle_TDF_AttributeDelta

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

The membership flag

class Handle_TDF_DeltaOnModification(*args)

Bases: OCC.TDF.Handle_TDF_AttributeDelta

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

The membership flag

class Handle_TDF_DeltaOnRemoval(*args)

Bases: OCC.TDF.Handle_TDF_AttributeDelta

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

The membership flag

class Handle_TDF_DeltaOnResume(*args)

Bases: OCC.TDF.Handle_TDF_AttributeDelta

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

The membership flag

class Handle_TDF_DoubleMapNodeOfAttributeDoubleMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_DoubleMapNodeOfGUIDProgIDMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_DoubleMapNodeOfLabelDoubleMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_HAttributeArray1(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_TDF_IndexedMapNodeOfAttributeIndexedMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_IndexedMapNodeOfLabelIndexedMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_ListNodeOfAttributeDeltaList(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_ListNodeOfAttributeList(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_ListNodeOfDeltaList(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_ListNodeOfIDList(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_ListNodeOfLabelList(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_Reference(*args)

Bases: OCC.TDF.Handle_TDF_Attribute

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

The membership flag

class Handle_TDF_RelocationTable(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_TDF_SequenceNodeOfAttributeSequence(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class Handle_TDF_SequenceNodeOfLabelSequence(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class Handle_TDF_StdMapNodeOfAttributeMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_StdMapNodeOfIDMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_StdMapNodeOfLabelMap(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class Handle_TDF_TagSource(*args)

Bases: OCC.TDF.Handle_TDF_Attribute

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

Bases: OCC.MMgt.MMgt_TShared

AddAttribute()
  • Adds an Attribute <other> to the label of <self>.Raises if there is already one of the same GUID fhan <other>.
Parameters:other (Handle_TDF_Attribute &) –
Return type:None
AfterAddition()
  • Something to do after adding an Attribute to a label.
Return type:void
AfterResume()
  • Something to do after resuming an Attribute from a label.
Return type:void
AfterRetrieval()
  • Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
Parameters:forceIt (bool) – default value is Standard_False
Return type:bool
AfterUndo()
  • Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
Parameters:
  • anAttDelta (Handle_TDF_AttributeDelta &) –
  • forceIt (bool) – default value is Standard_False
Return type:

bool

Backup()
  • Backups the attribute. The backuped attribute is flagged ‘Backuped’ and not ‘Valid’. //! The method does nothing: //! 1) If the attribute transaction number is equal to the current transaction number (the attribute has already been backuped). //! 2) If the attribute is not attached to a label.
Return type:None
BackupCopy()
  • Copies the attribute contents into a new other attribute. It is used by Backup().
Return type:Handle_TDF_Attribute
BeforeCommitTransaction()
  • A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.
Return type:void
BeforeForget()
  • Something to do before forgetting an Attribute to a label.
Return type:void
BeforeRemoval()
  • Something to do before removing an Attribute from a label.
Return type:void
BeforeUndo()
  • Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
Parameters:
  • anAttDelta (Handle_TDF_AttributeDelta &) –
  • forceIt (bool) – default value is Standard_False
Return type:

bool

DeltaOnAddition()
  • Makes an AttributeDelta because <self> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).
Return type:Handle_TDF_DeltaOnAddition
DeltaOnForget()
  • Makes an AttributeDelta because <self> has been forgotten.
Return type:Handle_TDF_DeltaOnForget
DeltaOnModification()
  • Makes a DeltaOnModification between <self> and <anOldAttribute.
Parameters:anOldAttribute (Handle_TDF_Attribute &) –
Return type:Handle_TDF_DeltaOnModification
  • Applies a DeltaOnModification to <self>.
Parameters:aDelta (Handle_TDF_DeltaOnModification &) –
Return type:void
DeltaOnRemoval()
  • Makes a DeltaOnRemoval on <self> because <self> has disappeared from the DS.
Return type:Handle_TDF_DeltaOnRemoval
DeltaOnResume()
  • Makes an AttributeDelta because <self> has been resumed.
Return type:Handle_TDF_DeltaOnResume
DumpToString()

TDF_Attribute_DumpToString(TDF_Attribute self) -> std::string

ExtendedDump()
  • Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.
Parameters:
  • anOS (Standard_OStream &) –
  • aFilter (TDF_IDFilter &) –
  • aMap (TDF_AttributeIndexedMap &) –
Return type:

void

FindAttribute()
  • Finds an associated attribute of <self>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.
Parameters:
  • anID (Standard_GUID &) –
  • anAttribute (Handle_TDF_Attribute &) –
Return type:

bool

Forget()
  • Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not ‘Valid’. //! A forgotten attribute is invisible. Set also the ‘Valid’ status to False. Obvioulsy, DF cannot empty an attribute (this has a semantic signification), but can remove it from the structure. So, a forgotten attribute is NOT an empty one, but a soon DEAD one. //! Should be private.
Parameters:aTransaction (int) –
Return type:None
ForgetAllAttributes()
  • Forgets all the attributes attached to the label of <self>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mecanisms. Be carefull that if <self> will have a null label after this call
Parameters:clearChildren (bool) – default value is Standard_True
Return type:None
ForgetAttribute()
  • Forgets the Attribute of GUID <aguid> associated to the label of <self>. Be carefull that if <self> is the attribute of <guid>, <self> will have a null label after this call. If the attribute doesn’t exist returns False. Otherwise returns True.
Parameters:aguid (Standard_GUID &) –
Return type:bool
GetHandle()
ID()
  • Returns the ID of the attribute.
Return type:Standard_GUID
IsAttribute()
  • Returns true if it exists an associated attribute of <self> with <anID> as ID.
Parameters:anID (Standard_GUID &) –
Return type:bool
IsBackuped()
  • Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
Return type:bool
IsForgotten()
  • Returns true if the attribute forgotten status is set. //! ShortCut Methods concerning associated attributes =================================================
Return type:bool
IsNew()
  • Returns true if the attribute has no backup
Return type:bool
IsValid()
  • Returns true if the attribute is valid; i.e. not a backuped or removed one.
Return type:bool
Label()
  • Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.
Return type:TDF_Label
NewEmpty()
  • Returns an new empty attribute from the good end type. It is used by the copy algorithm.
Return type:Handle_TDF_Attribute
Paste()
  • This method is different from the ‘Copy’ one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <self> into <intoAttribute>. //! The given pasted attribute can be full or empty of its contents. But don’t make a NEW! Just set the contents! //! It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.
Parameters:
  • intoAttribute (Handle_TDF_Attribute &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
Return type:

void

References()
  • Adds the first level referenced attributes and labels to <aDataSet>. //! For this, use the AddLabel or AddAttribute of DataSet. //! If there is none, do not implement the method.
Parameters:aDataSet (Handle_TDF_DataSet &) –
Return type:void
Restore()
  • Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.
Parameters:anAttribute (Handle_TDF_Attribute &) –
Return type:void
Transaction()
  • Returns the transaction index in which the attribute has been created or modified.
Return type:int
UntilTransaction()
  • Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.
Return type:int
thisown

The membership flag

class TDF_AttributeArray1(*args)

Bases: object

Parameters:
  • Low (int) –
  • Up (int) –
  • Item (Handle_TDF_Attribute &) –
  • Low
  • Up
Return type:

None

Return type:

None

Assign()
Parameters:Other (TDF_AttributeArray1 &) –
Return type:TDF_AttributeArray1
ChangeValue()
Parameters:Index (int) –
Return type:Handle_TDF_Attribute
Destroy()
Return type:None
Init()
Parameters:V (Handle_TDF_Attribute &) –
Return type:None
IsAllocated()
Return type:bool
Length()
Return type:int
Lower()
Return type:int
Set()
Parameters:Other (TDF_AttributeArray1 &) –
Return type:TDF_AttributeArray1
SetValue()
Parameters:
  • Index (int) –
  • Value (Handle_TDF_Attribute &) –
Return type:

None

Upper()
Return type:int
Value()
Parameters:Index (int) –
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_AttributeDataMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

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

bool

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

The membership flag

class TDF_AttributeDelta(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

Apply()
  • Applies the delta to the attribute.
Return type:void
Attribute()
  • Returns the reference attribute.
Return type:Handle_TDF_Attribute
DumpToString()

TDF_AttributeDelta_DumpToString(TDF_AttributeDelta self) -> std::string

GetHandle()
ID()
  • Returns the ID of the attribute concerned by <self>.
Return type:Standard_GUID
Label()
  • Returns the label concerned by <self>.
Return type:TDF_Label
thisown

The membership flag

class TDF_AttributeDeltaList(*args)

Bases: object

Return type:None
Parameters:Other (TDF_AttributeDeltaList &) –
Return type:None
Append()
Parameters:
  • I (Handle_TDF_AttributeDelta &) –
  • I
  • theIt (TDF_ListIteratorOfAttributeDeltaList &) –
  • Other (TDF_AttributeDeltaList &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (TDF_AttributeDeltaList &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Handle_TDF_AttributeDelta
InsertAfter()
Parameters:
  • I (Handle_TDF_AttributeDelta &) –
  • It (TDF_ListIteratorOfAttributeDeltaList &) –
  • Other (TDF_AttributeDeltaList &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Handle_TDF_AttributeDelta &) –
  • It (TDF_ListIteratorOfAttributeDeltaList &) –
  • Other (TDF_AttributeDeltaList &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Handle_TDF_AttributeDelta
Prepend()
Parameters:
  • I (Handle_TDF_AttributeDelta &) –
  • I
  • theIt (TDF_ListIteratorOfAttributeDeltaList &) –
  • Other (TDF_AttributeDeltaList &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (TDF_ListIteratorOfAttributeDeltaList &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (TDF_AttributeDeltaList &) –
Return type:None
thisown

The membership flag

class TDF_AttributeDoubleMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
AreBound()
Parameters:
  • K1 (Handle_TDF_Attribute &) –
  • K2 (Handle_TDF_Attribute &) –
Return type:

bool

Assign()
Parameters:Other (TDF_AttributeDoubleMap &) –
Return type:TDF_AttributeDoubleMap
Bind()
Parameters:
  • K1 (Handle_TDF_Attribute &) –
  • K2 (Handle_TDF_Attribute &) –
Return type:

None

Clear()
Return type:None
Find1()
Parameters:K (Handle_TDF_Attribute &) –
Return type:Handle_TDF_Attribute
Find2()
Parameters:K (Handle_TDF_Attribute &) –
Return type:Handle_TDF_Attribute
IsBound1()
Parameters:K (Handle_TDF_Attribute &) –
Return type:bool
IsBound2()
Parameters:K (Handle_TDF_Attribute &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (TDF_AttributeDoubleMap &) –
Return type:TDF_AttributeDoubleMap
UnBind1()
Parameters:K (Handle_TDF_Attribute &) –
Return type:bool
UnBind2()
Parameters:K (Handle_TDF_Attribute &) –
Return type:bool
thisown

The membership flag

class TDF_AttributeIndexedMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

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

None

Return type:

None

Add()
Parameters:K (Handle_TDF_Attribute &) –
Return type:int
Assign()
Parameters:Other (TDF_AttributeIndexedMap &) –
Return type:TDF_AttributeIndexedMap
Clear()
Return type:None
Contains()
Parameters:K (Handle_TDF_Attribute &) –
Return type:bool
FindIndex()
Parameters:K (Handle_TDF_Attribute &) –
Return type:int
FindKey()
Parameters:I (int) –
Return type:Handle_TDF_Attribute
ReSize()
Parameters:NbBuckets (int) –
Return type:None
RemoveLast()
Return type:None
Set()
Parameters:Other (TDF_AttributeIndexedMap &) –
Return type:TDF_AttributeIndexedMap
Substitute()
Parameters:
  • I (int) –
  • K (Handle_TDF_Attribute &) –
Return type:

None

thisown

The membership flag

class TDF_AttributeIterator(*args)

Bases: object

Return type:

None

Parameters:
  • aLabel (TDF_Label &) –
  • withoutForgotten (bool) – default value is Standard_True
  • aLabelNode (TDF_LabelNodePtr) –
  • withoutForgotten – default value is Standard_True
Return type:

None

Return type:

None

Initialize()
Parameters:
  • aLabel (TDF_Label &) –
  • withoutForgotten (bool) – default value is Standard_True
Return type:

None

More()
Return type:inline bool
Next()
Return type:None
Value()
Return type:inline TDF_Attribute *
thisown

The membership flag

class TDF_AttributeList(*args)

Bases: object

Return type:None
Parameters:Other (TDF_AttributeList &) –
Return type:None
Append()
Parameters:
  • I (Handle_TDF_Attribute &) –
  • I
  • theIt (TDF_ListIteratorOfAttributeList &) –
  • Other (TDF_AttributeList &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (TDF_AttributeList &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Handle_TDF_Attribute
InsertAfter()
Parameters:
  • I (Handle_TDF_Attribute &) –
  • It (TDF_ListIteratorOfAttributeList &) –
  • Other (TDF_AttributeList &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Handle_TDF_Attribute &) –
  • It (TDF_ListIteratorOfAttributeList &) –
  • Other (TDF_AttributeList &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Handle_TDF_Attribute
Prepend()
Parameters:
  • I (Handle_TDF_Attribute &) –
  • I
  • theIt (TDF_ListIteratorOfAttributeList &) –
  • Other (TDF_AttributeList &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (TDF_ListIteratorOfAttributeList &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (TDF_AttributeList &) –
Return type:None
thisown

The membership flag

class TDF_AttributeMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

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

None

Return type:

None

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

The membership flag

class TDF_AttributeSequence(*args)

Bases: OCC.TCollection.TCollection_BaseSequence

Return type:None
Parameters:Other (TDF_AttributeSequence &) –
Return type:None
Append()
Parameters:
  • T (Handle_TDF_Attribute &) –
  • S (TDF_AttributeSequence &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (TDF_AttributeSequence &) –
Return type:TDF_AttributeSequence
ChangeValue()
Parameters:Index (int) –
Return type:Handle_TDF_Attribute
Clear()
Return type:None
First()
Return type:Handle_TDF_Attribute
InsertAfter()
Parameters:
  • Index (int) –
  • T (Handle_TDF_Attribute &) –
  • Index
  • S (TDF_AttributeSequence &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (int) –
  • T (Handle_TDF_Attribute &) –
  • Index
  • S (TDF_AttributeSequence &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_TDF_Attribute
Prepend()
Parameters:
  • T (Handle_TDF_Attribute &) –
  • S (TDF_AttributeSequence &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (int) –
  • FromIndex (int) –
  • ToIndex (int) –
Return type:

None

Return type:

None

Set()
Parameters:Other (TDF_AttributeSequence &) –
Return type:TDF_AttributeSequence
SetValue()
Parameters:
  • Index (int) –
  • I (Handle_TDF_Attribute &) –
Return type:

None

Split()
Parameters:
  • Index (int) –
  • Sub (TDF_AttributeSequence &) –
Return type:

None

Value()
Parameters:Index (int) –
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_ChildIDIterator(*args)

Bases: object

  • Creates an empty iterator.
Return type:None
  • Iterates on the children of the given label. If <allLevels> option is set to true, it explores not only the first, but all the sub label levels.
Parameters:
  • aLabel (TDF_Label &) –
  • anID (Standard_GUID &) –
  • allLevels (bool) – default value is Standard_False
Return type:

None

Initialize()
  • Initializes the iteration on the children of the given label. If <allLevels> option is set to true, it explores not only the first, but all the sub label levels.
Parameters:
  • aLabel (TDF_Label &) –
  • anID (Standard_GUID &) –
  • allLevels (bool) – default value is Standard_False
Return type:

None

More()
  • Returns True if there is a current Item in the iteration.
Return type:bool
Next()
  • Move to the next Item
Return type:None
NextBrother()
  • Move to the next Brother. If there is none, go up etc. This method is interesting only with ‘allLevels’ behavior, because it avoids to explore the current label children.
Return type:None
Value()
  • Returns the current item; a null handle if there is none.
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_ChildIterator(*args)

Bases: object

  • Creates an empty iterator object to explore the children of a label.
Return type:None
  • Constructs the iterator object defined by the label aLabel. Iterates on the children of the given label. If <allLevels> option is set to true, it explores not only the first, but all the sub label levels.
Parameters:
  • aLabel (TDF_Label &) –
  • allLevels (bool) – default value is Standard_False
Return type:

None

Initialize()
  • Initializes the iteration on the children of the given label. If <allLevels> option is set to true, it explores not only the first, but all the sub label levels. If allLevels is false, only the first level of child labels is explored. In the example below, the label is iterated using Initialize, More and Next and its child labels dumped using TDF_Tool::Entry. Example void DumpChildren(const TDF_Label& aLabel) { TDF_ChildIterator it; TCollection_AsciiString es; for (it.Initialize(aLabel,Standard_True); it.More(); it.Next()){ TDF_Tool::Entry(it.Value(),es); cout << as.ToCString() << endl; } }
Parameters:
  • aLabel (TDF_Label &) –
  • allLevels (bool) – default value is Standard_False
Return type:

None

More()
  • Returns true if a current label is found in the iteration process.
Return type:bool
Next()
  • Move the current iteration to the next Item.
Return type:None
NextBrother()
  • Moves this iteration to the next brother label. A brother label is one with the same father as an initial label. Use this function when the non-empty constructor or Initialize has allLevels set to true. The result is that the iteration does not explore the children of the current label. This method is interesting only with ‘allLevels’ behavior, because it avoids to explore the current label children.
Return type:None
Value()
  • Returns the current label; or, if there is none, a null label.
Return type:TDF_Label
thisown

The membership flag

class TDF_ClosureMode(*args)

Bases: object

  • Creates an objet with all modes set to <aMode>.
Parameters:aMode (bool) – default value is Standard_True
Return type:None
Descendants()
  • Sets the mode ‘Descendants’ to <aStatus>. //! ‘Descendants’ mode means we add to the data set the children labels of each USER GIVEN label. We do not do that with the labels found applying UpToFirstLevel option.
Parameters:aStatus (bool) –
Return type:None
  • Returns true if the mode ‘Descendants’ is set.
Return type:bool
References()
  • Sets the mode ‘References’ to <aStatus>. //! ‘References’ mode means we add to the data set the descendants of an attribute, by calling the attribute method Descendants().
Parameters:aStatus (bool) –
Return type:None
  • Returns true if the mode ‘References’ is set.
Return type:bool
thisown

The membership flag

class TDF_ClosureTool

Bases: object

static Closure(*args)
  • Builds the transitive closure of label and attribute sets into <aDataSet>.
Parameters:aDataSet (Handle_TDF_DataSet &) –
Return type:void
  • Builds the transitive closure of label and attribute sets into <aDataSet>. Uses <aFilter> to determine if an attribute has to be taken in account or not. Uses <aMode> for various way of closing.
Parameters:
  • aDataSet (Handle_TDF_DataSet &) –
  • aFilter (TDF_IDFilter &) –
  • aMode (TDF_ClosureMode &) –
Return type:

void

  • Builds the transitive closure of <aLabel>.
Parameters:
  • aLabel (TDF_Label &) –
  • aLabMap (TDF_LabelMap &) –
  • anAttMap (TDF_AttributeMap &) –
  • aFilter (TDF_IDFilter &) –
  • aMode (TDF_ClosureMode &) –
Return type:

void

thisown

The membership flag

TDF_ClosureTool_Closure(*args)
  • Builds the transitive closure of label and attribute sets into <aDataSet>.
Parameters:aDataSet (Handle_TDF_DataSet &) –
Return type:void
  • Builds the transitive closure of label and attribute sets into <aDataSet>. Uses <aFilter> to determine if an attribute has to be taken in account or not. Uses <aMode> for various way of closing.
Parameters:
  • aDataSet (Handle_TDF_DataSet &) –
  • aFilter (TDF_IDFilter &) –
  • aMode (TDF_ClosureMode &) –
Return type:

void

  • Builds the transitive closure of <aLabel>.
Parameters:
  • aLabel (TDF_Label &) –
  • aLabMap (TDF_LabelMap &) –
  • anAttMap (TDF_AttributeMap &) –
  • aFilter (TDF_IDFilter &) –
  • aMode (TDF_ClosureMode &) –
Return type:

void

class TDF_ComparisonTool

Bases: object

static Compare(*args)
  • Compares <aSourceDataSet> with <aTargetDataSet>, updating <aRelocationTable> with labels and attributes found in both sets.
Parameters:
  • aSourceDataSet (Handle_TDF_DataSet &) –
  • aTargetDataSet (Handle_TDF_DataSet &) –
  • aFilter (TDF_IDFilter &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
Return type:

void

static Cut(*args)
  • Removes attributes from <aDataSet>.
Parameters:aDataSet (Handle_TDF_DataSet &) –
Return type:void
static IsSelfContained(*args)
  • Returns true if all the labels of <aDataSet> are descendant of <aLabel>.
Parameters:
  • aLabel (TDF_Label &) –
  • aDataSet (Handle_TDF_DataSet &) –
Return type:

bool

static SourceUnbound(*args)
  • Finds from <aRefDataSet> all the keys not bound into <aRelocationTable> and put them into <aDiffDataSet>. Returns True if the difference contains at least one key. (A key is a source object). //! <anOption> may take the following values: 1 : labels treatment only; 2 : attributes treatment only (default value); 3 : both labels & attributes treatment.
Parameters:
  • aRefDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
  • aFilter (TDF_IDFilter &) –
  • aDiffDataSet (Handle_TDF_DataSet &) –
  • anOption (int) – default value is 2
Return type:

bool

static TargetUnbound(*args)
  • Substracts from <aRefDataSet> all the items bound into <aRelocationTable>. The result is put into <aDiffDataSet>. Returns True if the difference contains at least one item. (An item is a target object). //! <anOption> may take the following values: 1 : labels treatment only; 2 : attributes treatment only(default value); 3 : both labels & attributes treatment.
Parameters:
  • aRefDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
  • aFilter (TDF_IDFilter &) –
  • aDiffDataSet (Handle_TDF_DataSet &) –
  • anOption (int) – default value is 2
Return type:

bool

thisown

The membership flag

TDF_ComparisonTool_Compare(*args)
  • Compares <aSourceDataSet> with <aTargetDataSet>, updating <aRelocationTable> with labels and attributes found in both sets.
Parameters:
  • aSourceDataSet (Handle_TDF_DataSet &) –
  • aTargetDataSet (Handle_TDF_DataSet &) –
  • aFilter (TDF_IDFilter &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
Return type:

void

TDF_ComparisonTool_Cut(*args)
  • Removes attributes from <aDataSet>.
Parameters:aDataSet (Handle_TDF_DataSet &) –
Return type:void
TDF_ComparisonTool_IsSelfContained(*args)
  • Returns true if all the labels of <aDataSet> are descendant of <aLabel>.
Parameters:
  • aLabel (TDF_Label &) –
  • aDataSet (Handle_TDF_DataSet &) –
Return type:

bool

TDF_ComparisonTool_SourceUnbound(*args)
  • Finds from <aRefDataSet> all the keys not bound into <aRelocationTable> and put them into <aDiffDataSet>. Returns True if the difference contains at least one key. (A key is a source object). //! <anOption> may take the following values: 1 : labels treatment only; 2 : attributes treatment only (default value); 3 : both labels & attributes treatment.
Parameters:
  • aRefDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
  • aFilter (TDF_IDFilter &) –
  • aDiffDataSet (Handle_TDF_DataSet &) –
  • anOption (int) – default value is 2
Return type:

bool

TDF_ComparisonTool_TargetUnbound(*args)
  • Substracts from <aRefDataSet> all the items bound into <aRelocationTable>. The result is put into <aDiffDataSet>. Returns True if the difference contains at least one item. (An item is a target object). //! <anOption> may take the following values: 1 : labels treatment only; 2 : attributes treatment only(default value); 3 : both labels & attributes treatment.
Parameters:
  • aRefDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
  • aFilter (TDF_IDFilter &) –
  • aDiffDataSet (Handle_TDF_DataSet &) –
  • anOption (int) – default value is 2
Return type:

bool

class TDF_CopyLabel(*args)

Bases: object

  • Empty constructor
Return type:None
  • CopyTool
Parameters:
  • aSource (TDF_Label &) –
  • aTarget (TDF_Label &) –
Return type:

None

static ExternalReferences(*args)
  • Check external references and if exist fills the aExternals Map
Parameters:
  • Lab (TDF_Label &) –
  • aExternals (TDF_AttributeMap &) –
  • aFilter (TDF_IDFilter &) –
Return type:

bool

  • Check external references and if exist fills the aExternals Map
Parameters:
  • aRefLab (TDF_Label &) –
  • Lab (TDF_Label &) –
  • aExternals (TDF_AttributeMap &) –
  • aFilter (TDF_IDFilter &) –
  • aDataSet (Handle_TDF_DataSet &) –
Return type:

void

IsDone()
Return type:bool
Load()
  • Loads src and tgt labels
Parameters:
  • aSource (TDF_Label &) –
  • aTarget (TDF_Label &) –
Return type:

None

Perform()
  • performs algorithm of selfcontained copy
Return type:None
RelocationTable()
  • returns relocation table
Return type:Handle_TDF_RelocationTable
UseFilter()
  • Sets filter
Parameters:aFilter (TDF_IDFilter &) –
Return type:None
thisown

The membership flag

TDF_CopyLabel_ExternalReferences(*args)
  • Check external references and if exist fills the aExternals Map
Parameters:
  • Lab (TDF_Label &) –
  • aExternals (TDF_AttributeMap &) –
  • aFilter (TDF_IDFilter &) –
Return type:

bool

  • Check external references and if exist fills the aExternals Map
Parameters:
  • aRefLab (TDF_Label &) –
  • Lab (TDF_Label &) –
  • aExternals (TDF_AttributeMap &) –
  • aFilter (TDF_IDFilter &) –
  • aDataSet (Handle_TDF_DataSet &) –
Return type:

void

class TDF_CopyTool

Bases: object

static Copy(*args)
  • Copy <aSourceDataSet> with using and updating <aRelocationTable>. This method ignores target attributes privilege over source ones.
Parameters:
  • aSourceDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
Return type:

void

  • Copy <aSourceDataSet> using and updating <aRelocationTable>. Use <aPrivilegeFilter> to give a list of IDs for which the target attribute prevails over the source one.
Parameters:
  • aSourceDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
  • aPrivilegeFilter (TDF_IDFilter &) –
Return type:

void

  • Copy <aSourceDataSet> using and updating <aRelocationTable>. Use <aPrivilegeFilter> to give a list of IDs for which the target attribute prevails over the source one. If <setSelfContained> is set to true, every TDF_Reference will be replaced by the referenced structure according to <aRefFilter>. //! NB: <aRefFilter> is used only if <setSelfContained> is true. Internal root label copy recursive method.
Parameters:
  • aSourceDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
  • aPrivilegeFilter (TDF_IDFilter &) –
  • aRefFilter (TDF_IDFilter &) –
  • setSelfContained (bool) –
Return type:

void

thisown

The membership flag

TDF_CopyTool_Copy(*args)
  • Copy <aSourceDataSet> with using and updating <aRelocationTable>. This method ignores target attributes privilege over source ones.
Parameters:
  • aSourceDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
Return type:

void

  • Copy <aSourceDataSet> using and updating <aRelocationTable>. Use <aPrivilegeFilter> to give a list of IDs for which the target attribute prevails over the source one.
Parameters:
  • aSourceDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
  • aPrivilegeFilter (TDF_IDFilter &) –
Return type:

void

  • Copy <aSourceDataSet> using and updating <aRelocationTable>. Use <aPrivilegeFilter> to give a list of IDs for which the target attribute prevails over the source one. If <setSelfContained> is set to true, every TDF_Reference will be replaced by the referenced structure according to <aRefFilter>. //! NB: <aRefFilter> is used only if <setSelfContained> is true. Internal root label copy recursive method.
Parameters:
  • aSourceDataSet (Handle_TDF_DataSet &) –
  • aRelocationTable (Handle_TDF_RelocationTable &) –
  • aPrivilegeFilter (TDF_IDFilter &) –
  • aRefFilter (TDF_IDFilter &) –
  • setSelfContained (bool) –
Return type:

void

class TDF_Data(*args)

Bases: OCC.MMgt.MMgt_TShared

  • A new and empty Data structure.
Return type:None
AllowModification()
  • Sets modification mode.
Parameters:isAllowed (bool) –
Return type:None
Destroy()
Return type:None
DumpToString()

TDF_Data_DumpToString(TDF_Data self) -> std::string

GetHandle()
IsApplicable()
  • Returns true if <aDelta> is applicable HERE and NOW.
Parameters:aDelta (Handle_TDF_Delta &) –
Return type:bool
IsModificationAllowed()
  • returns modification mode.
Return type:bool
LabelNodeAllocator()
  • Returns TDF_HAllocator, which is an incremental allocator used by TDF_LabelNode. This allocator is used to manage TDF_LabelNode objects, but it can also be used for allocating memory to application-specific data (be careful because this allocator does not release the memory). The benefits of this allocation scheme are noticeable when dealing with large OCAF documents, due to: 1. Very quick allocation of objects (memory heap is not used, the algorithm that replaces it is very simple). 2. Very quick destruction of objects (memory is released not by destructors of TDF_LabelNode, but rather by the destructor of TDF_Data). 3. TDF_LabelNode objects do not fragmentize the memory; they are kept compactly in a number of arrays of 16K each. 4. Swapping is reduced on large data, because each document now occupies a smaller number of memory pages.
Return type:TDF_HAllocator
NotUndoMode()
  • Returns the undo mode status.
Return type:bool
Root()
  • Returns the root label of the Data structure.
Return type:TDF_Label
Time()
  • Returns the current tick. It is incremented each Commit.
Return type:int
Transaction()
  • Returns the current transaction number.
Return type:int
Undo()
  • Apply <aDelta> to undo a set of attribute modifications. //! Optionnal <withDelta> set to True indiquates a Delta Set must be generated. (See above)
Parameters:
  • aDelta (Handle_TDF_Delta &) –
  • withDelta (bool) – default value is Standard_False
Return type:

Handle_TDF_Delta

thisown

The membership flag

class TDF_DataMapIteratorOfAttributeDataMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_AttributeDataMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_AttributeDataMap &) –
Return type:None
Key()
Return type:Handle_TDF_Attribute
Value()
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_DataMapIteratorOfLabelDataMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_LabelDataMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_LabelDataMap &) –
Return type:None
Key()
Return type:TDF_Label
Value()
Return type:TDF_Label
thisown

The membership flag

class TDF_DataMapIteratorOfLabelIntegerMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_LabelIntegerMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_LabelIntegerMap &) –
Return type:None
Key()
Return type:TDF_Label
Value()
Return type:int
thisown

The membership flag

class TDF_DataMapNodeOfAttributeDataMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Key()
Return type:Handle_TDF_Attribute
Value()
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_DataMapNodeOfLabelDataMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Key()
Return type:TDF_Label
Value()
Return type:TDF_Label
thisown

The membership flag

class TDF_DataMapNodeOfLabelIntegerMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (TDF_Label &) –
  • I (int &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
GetValue()

TDF_DataMapNodeOfLabelIntegerMap_GetValue(TDF_DataMapNodeOfLabelIntegerMap self) -> Standard_Integer

Key()
Return type:TDF_Label
SetValue()

TDF_DataMapNodeOfLabelIntegerMap_SetValue(TDF_DataMapNodeOfLabelIntegerMap self, Standard_Integer value)

thisown

The membership flag

class TDF_DataSet(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates an empty DataSet object.
Return type:None
AddAttribute()
  • Adds <anAttribute> into the current data set.
Parameters:anAttribute (Handle_TDF_Attribute &) –
Return type:None
AddLabel()
  • Adds <aLabel> in the current data set.
Parameters:aLabel (TDF_Label &) –
Return type:None
AddRoot()
  • Adds a root label to <myRootLabels>.
Parameters:aLabel (TDF_Label &) –
Return type:None
Attributes()
  • Returns the map of attributes in the current data set. This map can be used directly, or updated.
Return type:TDF_AttributeMap
Clear()
  • Clears all information.
Return type:None
ContainsAttribute()
  • Returns true if <anAttribute> is in the data set.
Parameters:anAttribute (Handle_TDF_Attribute &) –
Return type:bool
ContainsLabel()
  • Returns true if the label <alabel> is in the data set.
Parameters:aLabel (TDF_Label &) –
Return type:bool
DumpToString()

TDF_DataSet_DumpToString(TDF_DataSet self) -> std::string

GetHandle()
IsEmpty()
  • Returns true if there is at least one label or one attribute.
Return type:bool
Labels()
  • Returns the map of labels in this data set. This map can be used directly, or updated.
Return type:TDF_LabelMap
Roots()
  • Returns <myRootLabels> to be used or updated.
Return type:TDF_LabelList
thisown

The membership flag

class TDF_DefaultDeltaOnModification(*args)

Bases: OCC.TDF.TDF_DeltaOnModification

  • Creates a TDF_DefaultDeltaOnModification. <anAttribute> must be the backup copy.
Parameters:anAttribute (Handle_TDF_Attribute &) –
Return type:None
GetHandle()
thisown

The membership flag

class TDF_DefaultDeltaOnRemoval(*args)

Bases: OCC.TDF.TDF_DeltaOnRemoval

  • Creates a TDF_DefaultDeltaOnRemoval.
Parameters:anAttribute (Handle_TDF_Attribute &) –
Return type:None
GetHandle()
thisown

The membership flag

class TDF_Delta(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates a delta.
Return type:None
AttributeDeltas()
  • Returns the field <myAttDeltaList>.
Return type:TDF_AttributeDeltaList
BeginTime()
  • Returns the field <myBeginTime>.
Return type:int
DumpToString()

TDF_Delta_DumpToString(TDF_Delta self) -> std::string

EndTime()
  • Returns the field <myEndTime>.
Return type:int
GetHandle()
IsApplicable()
  • Returns true if the Undo action of <self> is applicable at <aCurrentTime>.
Parameters:aCurrentTime (int) –
Return type:bool
IsEmpty()
  • Returns true if there is nothing to undo.
Return type:bool
Labels()
  • Adds in <aLabelList> the labels of the attribute deltas. Caution: <aLabelList> is not cleared before use.
Parameters:aLabelList (TDF_LabelList &) –
Return type:None
Name()
  • Returns a name associated with this delta.
Return type:TCollection_ExtendedString
SetName()
  • Associates a name <theName> with this delta
Parameters:theName (TCollection_ExtendedString &) –
Return type:None
thisown

The membership flag

class TDF_DeltaList(*args)

Bases: object

Return type:None
Parameters:Other (TDF_DeltaList &) –
Return type:None
Append()
Parameters:
  • I (Handle_TDF_Delta &) –
  • I
  • theIt (TDF_ListIteratorOfDeltaList &) –
  • Other (TDF_DeltaList &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (TDF_DeltaList &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Handle_TDF_Delta
InsertAfter()
Parameters:
  • I (Handle_TDF_Delta &) –
  • It (TDF_ListIteratorOfDeltaList &) –
  • Other (TDF_DeltaList &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Handle_TDF_Delta &) –
  • It (TDF_ListIteratorOfDeltaList &) –
  • Other (TDF_DeltaList &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Handle_TDF_Delta
Prepend()
Parameters:
  • I (Handle_TDF_Delta &) –
  • I
  • theIt (TDF_ListIteratorOfDeltaList &) –
  • Other (TDF_DeltaList &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (TDF_ListIteratorOfDeltaList &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (TDF_DeltaList &) –
Return type:None
thisown

The membership flag

class TDF_DeltaOnAddition(*args)

Bases: OCC.TDF.TDF_AttributeDelta

  • Creates a TDF_DeltaOnAddition.
Parameters:anAtt (Handle_TDF_Attribute &) –
Return type:None
GetHandle()
thisown

The membership flag

class TDF_DeltaOnForget(*args)

Bases: OCC.TDF.TDF_AttributeDelta

  • Creates a TDF_DeltaOnForget.
Parameters:anAtt (Handle_TDF_Attribute &) –
Return type:None
GetHandle()
thisown

The membership flag

class TDF_DeltaOnModification(*args, **kwargs)

Bases: OCC.TDF.TDF_AttributeDelta

GetHandle()
thisown

The membership flag

class TDF_DeltaOnRemoval(*args, **kwargs)

Bases: OCC.TDF.TDF_AttributeDelta

GetHandle()
thisown

The membership flag

class TDF_DeltaOnResume(*args)

Bases: OCC.TDF.TDF_AttributeDelta

  • Creates a TDF_DeltaOnResume.
Parameters:anAtt (Handle_TDF_Attribute &) –
Return type:None
GetHandle()
thisown

The membership flag

class TDF_DoubleMapIteratorOfAttributeDoubleMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_AttributeDoubleMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_AttributeDoubleMap &) –
Return type:None
Key1()
Return type:Handle_TDF_Attribute
Key2()
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_DoubleMapIteratorOfGUIDProgIDMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_GUIDProgIDMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_GUIDProgIDMap &) –
Return type:None
Key1()
Return type:Standard_GUID
Key2()
Return type:TCollection_ExtendedString
thisown

The membership flag

class TDF_DoubleMapIteratorOfLabelDoubleMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_LabelDoubleMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_LabelDoubleMap &) –
Return type:None
Key1()
Return type:TDF_Label
Key2()
Return type:TDF_Label
thisown

The membership flag

class TDF_DoubleMapNodeOfAttributeDoubleMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K1 (Handle_TDF_Attribute &) –
  • K2 (Handle_TDF_Attribute &) –
  • n1 (TCollection_MapNodePtr &) –
  • n2 (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key1()
Return type:Handle_TDF_Attribute
Key2()
Return type:Handle_TDF_Attribute
Next2()
Return type:TCollection_MapNodePtr
thisown

The membership flag

class TDF_DoubleMapNodeOfGUIDProgIDMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K1 (Standard_GUID &) –
  • K2 (TCollection_ExtendedString &) –
  • n1 (TCollection_MapNodePtr &) –
  • n2 (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key1()
Return type:Standard_GUID
Key2()
Return type:TCollection_ExtendedString
Next2()
Return type:TCollection_MapNodePtr
thisown

The membership flag

class TDF_DoubleMapNodeOfLabelDoubleMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K1 (TDF_Label &) –
  • K2 (TDF_Label &) –
  • n1 (TCollection_MapNodePtr &) –
  • n2 (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key1()
Return type:TDF_Label
Key2()
Return type:TDF_Label
Next2()
Return type:TCollection_MapNodePtr
thisown

The membership flag

class TDF_GUIDProgIDMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
AreBound()
Parameters:
  • K1 (Standard_GUID &) –
  • K2 (TCollection_ExtendedString &) –
Return type:

bool

Assign()
Parameters:Other (TDF_GUIDProgIDMap &) –
Return type:TDF_GUIDProgIDMap
Bind()
Parameters:
  • K1 (Standard_GUID &) –
  • K2 (TCollection_ExtendedString &) –
Return type:

None

Clear()
Return type:None
Find1()
Parameters:K (Standard_GUID &) –
Return type:TCollection_ExtendedString
Find2()
Parameters:K (TCollection_ExtendedString &) –
Return type:Standard_GUID
IsBound1()
Parameters:K (Standard_GUID &) –
Return type:bool
IsBound2()
Parameters:K (TCollection_ExtendedString &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (TDF_GUIDProgIDMap &) –
Return type:TDF_GUIDProgIDMap
UnBind1()
Parameters:K (Standard_GUID &) –
Return type:bool
UnBind2()
Parameters:K (TCollection_ExtendedString &) –
Return type:bool
thisown

The membership flag

class TDF_HAttributeArray1(*args)

Bases: OCC.MMgt.MMgt_TShared

Parameters:
  • Low (int) –
  • Up (int) –
  • Low
  • Up
  • V (Handle_TDF_Attribute &) –
Return type:

None

Return type:

None

Array1()
Return type:TDF_AttributeArray1
ChangeArray1()
Return type:TDF_AttributeArray1
ChangeValue()
Parameters:Index (int) –
Return type:Handle_TDF_Attribute
GetHandle()
Init()
Parameters:V (Handle_TDF_Attribute &) –
Return type:None
Length()
Return type:int
Lower()
Return type:int
SetValue()
Parameters:
  • Index (int) –
  • Value (Handle_TDF_Attribute &) –
Return type:

None

Upper()
Return type:int
Value()
Parameters:Index (int) –
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_IDFilter(*args)

Bases: object

  • Creates an ID/attribute filter based on an ID list. The default mode is ‘ignore all but...’. //! This filter has 2 working mode: keep and ignore. //! Ignore/Exclusive mode: all IDs are ignored except these set to be kept, using Keep(). Of course, it is possible set an kept ID to be ignored using Ignore(). //! Keep/Inclusive mode: all IDs are kept except these set to be ignored, using Ignore(). Of course, it is possible set an ignored ID to be kept using Keep().
Parameters:ignoreMode (bool) – default value is Standard_True
Return type:None
Copy()
  • Copies into <self> the contents of <fromFilter>. <self> is cleared before copy.
Parameters:fromFilter (TDF_IDFilter &) –
Return type:None
DumpToString()

TDF_IDFilter_DumpToString(TDF_IDFilter self) -> std::string

IDList()
  • Copies the list of ID to be kept or ignored in <anIDList>. <anIDList> is cleared before use.
Parameters:anIDList (TDF_IDList &) –
Return type:None
Ignore()
  • An attribute with <anID> as ID is to be ignored and the filter will answer false to the question IsKept(<anID>).
Parameters:anID (Standard_GUID &) –
Return type:None
  • Attributes with ID owned by <anIDList> are to be ignored and the filter will answer false to the question IsKept(<anID>) with ID from <anIDList>.
Parameters:anIDList (TDF_IDList &) –
Return type:None
IgnoreAll()
  • The list of ID is cleared and the filter mode is set to ignore mode if <keep> is true; false otherwise.
Parameters:ignore (bool) –
Return type:None
  • Returns true is the mode is set to ‘ignore all but...’.
Return type:bool
IsIgnored()
  • Returns true if the ID is to be ignored.
Parameters:anID (Standard_GUID &) –
Return type:bool
  • Returns true if the attribute is to be ignored.
Parameters:anAtt (Handle_TDF_Attribute &) –
Return type:bool
IsKept()
  • Returns true if the ID is to be kept.
Parameters:anID (Standard_GUID &) –
Return type:bool
  • Returns true if the attribute is to be kept.
Parameters:anAtt (Handle_TDF_Attribute &) –
Return type:bool
Keep()
  • An attribute with <anID> as ID is to be kept and the filter will answer true to the question IsKept(<anID>).
Parameters:anID (Standard_GUID &) –
Return type:None
  • Attributes with ID owned by <anIDList> are to be kept and the filter will answer true to the question IsKept(<anID>) with ID from <anIDList>.
Parameters:anIDList (TDF_IDList &) –
Return type:None
thisown

The membership flag

class TDF_IDList(*args)

Bases: object

Return type:None
Parameters:Other (TDF_IDList &) –
Return type:None
Append()
Parameters:
  • I (Standard_GUID &) –
  • I
  • theIt (TDF_ListIteratorOfIDList &) –
  • Other (TDF_IDList &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (TDF_IDList &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Standard_GUID
InsertAfter()
Parameters:
  • I (Standard_GUID &) –
  • It (TDF_ListIteratorOfIDList &) –
  • Other (TDF_IDList &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Standard_GUID &) –
  • It (TDF_ListIteratorOfIDList &) –
  • Other (TDF_IDList &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Standard_GUID
Prepend()
Parameters:
  • I (Standard_GUID &) –
  • I
  • theIt (TDF_ListIteratorOfIDList &) –
  • Other (TDF_IDList &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (TDF_ListIteratorOfIDList &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (TDF_IDList &) –
Return type:None
thisown

The membership flag

class TDF_IDMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

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

None

Return type:

None

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

The membership flag

class TDF_IndexedMapNodeOfAttributeIndexedMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K1 (Handle_TDF_Attribute &) –
  • K2 (int) –
  • n1 (TCollection_MapNodePtr &) –
  • n2 (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
GetKey2()

TDF_IndexedMapNodeOfAttributeIndexedMap_GetKey2(TDF_IndexedMapNodeOfAttributeIndexedMap self) -> Standard_Integer

Key1()
Return type:Handle_TDF_Attribute
Next2()
Return type:TCollection_MapNodePtr
SetKey2()

TDF_IndexedMapNodeOfAttributeIndexedMap_SetKey2(TDF_IndexedMapNodeOfAttributeIndexedMap self, Standard_Integer value)

thisown

The membership flag

class TDF_IndexedMapNodeOfLabelIndexedMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K1 (TDF_Label &) –
  • K2 (int) –
  • n1 (TCollection_MapNodePtr &) –
  • n2 (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
GetKey2()

TDF_IndexedMapNodeOfLabelIndexedMap_GetKey2(TDF_IndexedMapNodeOfLabelIndexedMap self) -> Standard_Integer

Key1()
Return type:TDF_Label
Next2()
Return type:TCollection_MapNodePtr
SetKey2()

TDF_IndexedMapNodeOfLabelIndexedMap_SetKey2(TDF_IndexedMapNodeOfLabelIndexedMap self, Standard_Integer value)

thisown

The membership flag

class TDF_Label(*args)

Bases: object

  • Constructs an empty label object.
Return type:None
AddAttribute()
  • Adds an Attribute to the current label. Raises if there is already one.
Parameters:anAttribute (Handle_TDF_Attribute &) –
Return type:None
AttributesModified()
  • Returns true if <self> owns attributes not yet available in transaction 0. It means at least one attribute is new, modified or deleted.
Return type:bool
Data()
  • Returns the Data owning <self>.
Return type:Handle_TDF_Data
Depth()
  • Returns the depth of the label in the data framework. This corresponds to the number of fathers which this label has, and is used in determining whether a label is root, null or equivalent to another label. Exceptions: Standard_NullObject if this label is null. This is because a null object can have no depth.
Return type:int
DumpToString()

TDF_Label_DumpToString(TDF_Label self) -> std::string

EntryDumpToString()

TDF_Label_EntryDumpToString(TDF_Label self) -> std::string

ExtendedDump()
  • Dumps the label on <aStream> and its attributes rank in <aMap> if their IDs are kept by <IDFilter>.
Parameters:
  • anOS (Standard_OStream &) –
  • aFilter (TDF_IDFilter &) –
  • aMap (TDF_AttributeIndexedMap &) –
Return type:

None

Father()
  • Returns the label father. This label may be null if the label is root.
Return type:TDF_Label
FindAttribute()
  • Finds an attribute of the current label, according to <anID>. If anAttribute is not a valid one, false is returned. //! The method returns True if found, False otherwise. //! A removed attribute cannot be found.
Parameters:
  • anID (Standard_GUID &) –
  • anAttribute (Handle_TDF_Attribute &) –
Return type:

bool

  • Finds an attribute of the current label, according to <anID> and <aTransaction>. This attribute has/had to be a valid one for the given transaction index . So, this attribute is not necessary a valid one. //! The method returns True if found, False otherwise. //! A removed attribute cannot be found nor a backuped attribute of a removed one.
Parameters:
  • anID (Standard_GUID &) –
  • aTransaction (int) –
  • anAttribute (Handle_TDF_Attribute &) –
Return type:

bool

FindChild()
  • Finds a child label having <aTag> as tag. Creates The tag aTag identifies the label which will be the parent. If create is true and no child label is found, a new one is created. Example: //creating a label with tag 10 at Root TDF_Label lab1 = aDF->Root().FindChild(10); //creating labels 7 and 2 on label 10 TDF_Label lab2 = lab1.FindChild(7); TDF_Label lab3 = lab1.FindChild(2);
Parameters:
  • aTag (int) –
  • create (bool) – default value is Standard_True
Return type:

TDF_Label

ForgetAllAttributes()
  • Forgets all the attributes. Does it on also on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mecanisms.
Parameters:clearChildren (bool) – default value is Standard_True
Return type:None
ForgetAttribute()
  • Forgets an Attribute from the current label, setting its forgotten status true and its valid status false. Raises if the attribute is not in the structure.
Parameters:anAttribute (Handle_TDF_Attribute &) –
Return type:None
  • Forgets the Attribute of GUID <aguid> from the current label . If the attribute doesn’t exist returns False. Otherwise returns True.
Parameters:aguid (Standard_GUID &) –
Return type:bool
HasAttribute()
  • Returns true if this label has at least one attribute.
Return type:bool
HasChild()
  • Returns true if this label has at least one child.
Return type:bool
HasGreaterNode()
  • Returns true if node address of <self> is greater than <otherLabel> one. Used to quickly sort labels (not on entry criterion). //! -C++: inline
Parameters:otherLabel (TDF_Label &) –
Return type:bool
HasLowerNode()
  • Returns true if node address of <self> is lower than <otherLabel> one. Used to quickly sort labels (not on entry criterion). //! -C++: inline
Parameters:otherLabel (TDF_Label &) –
Return type:bool
Imported()
  • Sets or unsets <self> and all its descendants as imported label, according to <aStatus>.
Parameters:aStatus (bool) –
Return type:None
IsAttribute()
  • Returns true if <self> owns an attribute with <anID> as ID.
Parameters:anID (Standard_GUID &) –
Return type:bool
IsDescendant()
  • Returns True if <self> is a descendant of <aLabel>. Attention: every label is its own descendant.
Parameters:aLabel (TDF_Label &) –
Return type:bool
IsDifferent()
Parameters:aLabel (TDF_Label &) –
Return type:bool
IsEqual()
  • Returns True if the <aLabel> is equal to me (same LabelNode*).
Parameters:aLabel (TDF_Label &) –
Return type:bool
IsImported()
  • Returns True if the <aLabel> is imported.
Return type:bool
IsNull()
  • Returns True if the <aLabel> is null, i.e. it has not been included in the data framework.
Return type:bool
IsRoot()
Return type:bool
MayBeModified()
  • Returns true if <self> or a DESCENDANT of <self> owns attributes not yet available in transaction 0. It means at least one of their attributes is new, modified or deleted.
Return type:bool
NbAttributes()
  • Returns the number of attributes.
Return type:int
NbChildren()
  • Returns the number of children.
Return type:int
NewChild()
  • Create a new child label of me using autoamtic delivery tags provided by TagSource.
Return type:TDF_Label
Nullify()
  • Nullifies the label.
Return type:None
ResumeAttribute()
  • Undo Forget action, setting its forgotten status false and its valid status true. Raises if the attribute is not in the structure.
Parameters:anAttribute (Handle_TDF_Attribute &) –
Return type:None
Root()
  • Returns the root label Root of the data structure. This has a depth of 0. Exceptions: Standard_NullObject if this label is null. This is because a null object can have no depth.
Return type:TDF_Label
Tag()
  • Returns the tag of the label. This is the integer assigned randomly to a label in a data framework. This integer is used to identify this label in an entry.
Return type:int
Transaction()
  • Returns the current transaction index.
Return type:int
thisown

The membership flag

class TDF_LabelDataMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

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

bool

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

The membership flag

class TDF_LabelDoubleMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
AreBound()
Parameters:
  • K1 (TDF_Label &) –
  • K2 (TDF_Label &) –
Return type:

bool

Assign()
Parameters:Other (TDF_LabelDoubleMap &) –
Return type:TDF_LabelDoubleMap
Bind()
Parameters:
  • K1 (TDF_Label &) –
  • K2 (TDF_Label &) –
Return type:

None

Clear()
Return type:None
Find1()
Parameters:K (TDF_Label &) –
Return type:TDF_Label
Find2()
Parameters:K (TDF_Label &) –
Return type:TDF_Label
IsBound1()
Parameters:K (TDF_Label &) –
Return type:bool
IsBound2()
Parameters:K (TDF_Label &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (TDF_LabelDoubleMap &) –
Return type:TDF_LabelDoubleMap
UnBind1()
Parameters:K (TDF_Label &) –
Return type:bool
UnBind2()
Parameters:K (TDF_Label &) –
Return type:bool
thisown

The membership flag

class TDF_LabelIndexedMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

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

None

Return type:

None

Add()
Parameters:K (TDF_Label &) –
Return type:int
Assign()
Parameters:Other (TDF_LabelIndexedMap &) –
Return type:TDF_LabelIndexedMap
Clear()
Return type:None
Contains()
Parameters:K (TDF_Label &) –
Return type:bool
FindIndex()
Parameters:K (TDF_Label &) –
Return type:int
FindKey()
Parameters:I (int) –
Return type:TDF_Label
ReSize()
Parameters:NbBuckets (int) –
Return type:None
RemoveLast()
Return type:None
Set()
Parameters:Other (TDF_LabelIndexedMap &) –
Return type:TDF_LabelIndexedMap
Substitute()
Parameters:
  • I (int) –
  • K (TDF_Label &) –
Return type:

None

thisown

The membership flag

class TDF_LabelIntegerMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

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

bool

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

The membership flag

class TDF_LabelList(*args)

Bases: object

Return type:None
Parameters:Other (TDF_LabelList &) –
Return type:None
Append()
Parameters:
  • I (TDF_Label &) –
  • I
  • theIt (TDF_ListIteratorOfLabelList &) –
  • Other (TDF_LabelList &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (TDF_LabelList &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:TDF_Label
InsertAfter()
Parameters:
  • I (TDF_Label &) –
  • It (TDF_ListIteratorOfLabelList &) –
  • Other (TDF_LabelList &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (TDF_Label &) –
  • It (TDF_ListIteratorOfLabelList &) –
  • Other (TDF_LabelList &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:TDF_Label
Prepend()
Parameters:
  • I (TDF_Label &) –
  • I
  • theIt (TDF_ListIteratorOfLabelList &) –
  • Other (TDF_LabelList &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (TDF_ListIteratorOfLabelList &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (TDF_LabelList &) –
Return type:None
thisown

The membership flag

class TDF_LabelMap(*args)

Bases: OCC.TCollection.TCollection_BasicMap

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

None

Return type:

None

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

The membership flag

class TDF_LabelSequence(*args)

Bases: OCC.TCollection.TCollection_BaseSequence

Return type:None
Parameters:Other (TDF_LabelSequence &) –
Return type:None
Append()
Parameters:
  • T (TDF_Label &) –
  • S (TDF_LabelSequence &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (TDF_LabelSequence &) –
Return type:TDF_LabelSequence
ChangeValue()
Parameters:Index (int) –
Return type:TDF_Label
Clear()
Return type:None
First()
Return type:TDF_Label
InsertAfter()
Parameters:
  • Index (int) –
  • T (TDF_Label &) –
  • Index
  • S (TDF_LabelSequence &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (int) –
  • T (TDF_Label &) –
  • Index
  • S (TDF_LabelSequence &) –
Return type:

None

Return type:

None

Last()
Return type:TDF_Label
Prepend()
Parameters:
  • T (TDF_Label &) –
  • S (TDF_LabelSequence &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (int) –
  • FromIndex (int) –
  • ToIndex (int) –
Return type:

None

Return type:

None

Set()
Parameters:Other (TDF_LabelSequence &) –
Return type:TDF_LabelSequence
SetValue()
Parameters:
  • Index (int) –
  • I (TDF_Label &) –
Return type:

None

Split()
Parameters:
  • Index (int) –
  • Sub (TDF_LabelSequence &) –
Return type:

None

Value()
Parameters:Index (int) –
Return type:TDF_Label
thisown

The membership flag

class TDF_ListIteratorOfAttributeDeltaList(*args)

Bases: object

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

The membership flag

class TDF_ListIteratorOfAttributeList(*args)

Bases: object

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

The membership flag

class TDF_ListIteratorOfDeltaList(*args)

Bases: object

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

The membership flag

class TDF_ListIteratorOfIDList(*args)

Bases: object

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

The membership flag

class TDF_ListIteratorOfLabelList(*args)

Bases: object

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

The membership flag

class TDF_ListNodeOfAttributeDeltaList(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Value()
Return type:Handle_TDF_AttributeDelta
thisown

The membership flag

class TDF_ListNodeOfAttributeList(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Value()
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_ListNodeOfDeltaList(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Value()
Return type:Handle_TDF_Delta
thisown

The membership flag

class TDF_ListNodeOfIDList(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Value()
Return type:Standard_GUID
thisown

The membership flag

class TDF_ListNodeOfLabelList(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Value()
Return type:TDF_Label
thisown

The membership flag

class TDF_MapIteratorOfAttributeMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_AttributeMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_AttributeMap &) –
Return type:None
Key()
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_MapIteratorOfIDMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_IDMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_IDMap &) –
Return type:None
Key()
Return type:Standard_GUID
thisown

The membership flag

class TDF_MapIteratorOfLabelMap(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (TDF_LabelMap &) –
Return type:None
Initialize()
Parameters:aMap (TDF_LabelMap &) –
Return type:None
Key()
Return type:TDF_Label
thisown

The membership flag

class TDF_Reference(*args)

Bases: OCC.TDF.TDF_Attribute

Return type:None
DumpToString()

TDF_Reference_DumpToString(TDF_Reference self) -> std::string

Get()
Return type:TDF_Label
GetHandle()
static GetID(*args)
Return type:Standard_GUID
Set()
Parameters:
  • I (TDF_Label &) –
  • Origin (TDF_Label &) –
  • Origin
Return type:

Handle_TDF_Reference

Return type:

None

thisown

The membership flag

TDF_Reference_GetID(*args)
Return type:Standard_GUID
class TDF_RelocationTable(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates an relocation table. <selfRelocate> says if a value without explicit relocation is its own relocation.
Parameters:selfRelocate (bool) – default value is Standard_False
Return type:None
AfterRelocate()
Parameters:afterRelocate (bool) –
Return type:None
  • Returns <myAfterRelocate>.
Return type:bool
AttributeTable()
  • Returns <myAttributeTable> to be used or updated.
Return type:TDF_AttributeDataMap
Clear()
  • Clears the relocation dictionnary, but lets the self relocation flag to its current value.
Return type:None
Dump()
  • Dumps the relocation table.
Parameters:
  • dumpLabels (bool) –
  • dumpAttributes (bool) –
  • dumpTransients (bool) –
  • anOS (Standard_OStream &) –
Return type:

Standard_OStream

GetHandle()
HasRelocation()
  • Finds the relocation value of <aSourceLabel> and returns it into <aTargetLabel>. //! (See above SelfRelocate method for more explanation about the method behavior)
Parameters:
  • aSourceLabel (TDF_Label &) –
  • aTargetLabel (TDF_Label &) –
Return type:

bool

  • Finds the relocation value of <aSourceAttribute> and returns it into <aTargetAttribute>. //! (See above SelfRelocate method for more explanation about the method behavior)
Parameters:
  • aSourceAttribute (Handle_TDF_Attribute &) –
  • aTargetAttribute (Handle_TDF_Attribute &) –
Return type:

bool

HasTransientRelocation()
  • Finds the relocation value of <aSourceTransient> and returns it into <aTargetTransient>. //! (See above SelfRelocate method for more explanation about the method behavior)
Parameters:
  • aSourceTransient (Handle_Standard_Transient &) –
  • aTargetTransient (Handle_Standard_Transient &) –
Return type:

bool

LabelTable()
  • Returns <myLabelTable> to be used or updated.
Return type:TDF_LabelDataMap
SelfRelocate()
  • Sets <mySelfRelocate> to <selfRelocate>. //! This flag affects the HasRelocation method behavior like this: //! <mySelfRelocate> == False: //! If no relocation object is found in the map, a null object is returned //! <mySelfRelocate> == True: //! If no relocation object is found in the map, the method assumes the source object is relocation value; so the source object is returned as target object.
Parameters:selfRelocate (bool) –
Return type:None
  • Returns <mySelfRelocate>.
Return type:bool
SetRelocation()
  • Sets the relocation value of <aSourceLabel> to <aTargetLabel>.
Parameters:
  • aSourceLabel (TDF_Label &) –
  • aTargetLabel (TDF_Label &) –
Return type:

None

  • Sets the relocation value of <aSourceAttribute> to <aTargetAttribute>.
Parameters:
  • aSourceAttribute (Handle_TDF_Attribute &) –
  • aTargetAttribute (Handle_TDF_Attribute &) –
Return type:

None

SetTransientRelocation()
  • Sets the relocation value of <aSourceTransient> to <aTargetTransient>.
Parameters:
  • aSourceTransient (Handle_Standard_Transient &) –
  • aTargetTransient (Handle_Standard_Transient &) –
Return type:

None

TargetAttributeMap()
  • Fills <anAttributeMap> with target relocation attributes. <anAttributeMap> is not cleared before use.
Parameters:anAttributeMap (TDF_AttributeMap &) –
Return type:None
TargetLabelMap()
  • Fills <aLabelMap> with target relocation labels. <aLabelMap> is not cleared before use.
Parameters:aLabelMap (TDF_LabelMap &) –
Return type:None
TransientTable()
  • Returns <myTransientTable> to be used or updated.
Return type:TColStd_IndexedDataMapOfTransientTransient
thisown

The membership flag

class TDF_SequenceNodeOfAttributeSequence(*args)

Bases: OCC.TCollection.TCollection_SeqNode

Parameters:
  • I (Handle_TDF_Attribute &) –
  • n (TCollection_SeqNodePtr &) –
  • p (TCollection_SeqNodePtr &) –
Return type:

None

GetHandle()
Value()
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_SequenceNodeOfLabelSequence(*args)

Bases: OCC.TCollection.TCollection_SeqNode

Parameters:
  • I (TDF_Label &) –
  • n (TCollection_SeqNodePtr &) –
  • p (TCollection_SeqNodePtr &) –
Return type:

None

GetHandle()
Value()
Return type:TDF_Label
thisown

The membership flag

class TDF_StdMapNodeOfAttributeMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Key()
Return type:Handle_TDF_Attribute
thisown

The membership flag

class TDF_StdMapNodeOfIDMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Key()
Return type:Standard_GUID
thisown

The membership flag

class TDF_StdMapNodeOfLabelMap(*args)

Bases: OCC.TCollection.TCollection_MapNode

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

None

GetHandle()
Key()
Return type:TDF_Label
thisown

The membership flag

class TDF_TagSource(*args)

Bases: OCC.TDF.TDF_Attribute

Return type:None
Get()
Return type:int
GetHandle()
static GetID(*args)
  • class methods =============
Return type:Standard_GUID
NewChild()
  • Find (or create) a tagSource attribute located at <L> and make a new child label. TagSource methods =================
Parameters:L (TDF_Label &) –
Return type:TDF_Label
Return type:TDF_Label
NewTag()
Return type:int
Set()
  • Find, or create, a TagSource attribute. the TagSource attribute is returned.
Parameters:label (TDF_Label &) –
Return type:Handle_TDF_TagSource
  • TDF_Attribute methods =====================
Parameters:T (int) –
Return type:None
thisown

The membership flag

TDF_TagSource_GetID(*args)
  • class methods =============
Return type:Standard_GUID
class TDF_Tool

Bases: object

static CountLabels(*args)
  • Adds the labels of <aLabelList> to <aLabelMap> if they are unbound, or increases their reference counters. At the end of the process, <aLabelList> contains only the ADDED labels.
Parameters:
  • aLabelList (TDF_LabelList &) –
  • aLabelMap (TDF_LabelIntegerMap &) –
Return type:

void

static DeductLabels(*args)
  • Decreases the reference counters of the labels of <aLabelList> to <aLabelMap>, and removes labels with null counter. At the end of the process, <aLabelList> contains only the SUPPRESSED labels.
Parameters:
  • aLabelList (TDF_LabelList &) –
  • aLabelMap (TDF_LabelIntegerMap &) –
Return type:

void

static DeepDump(*args)
  • Dumps <aDF> and its labels and their attributes.
Parameters:
  • anOS (Standard_OStream &) –
  • aDF (Handle_TDF_Data &) –
Return type:

void

  • Dumps <aLabel>, its chilren and their attributes.
Parameters:
  • anOS (Standard_OStream &) –
  • aLabel (TDF_Label &) –
Return type:

void

static Entry(*args)
  • Returns the entry for the label aLabel in the form of the ASCII character string anEntry containing the tag list for aLabel.
Parameters:
  • aLabel (TDF_Label &) –
  • anEntry (TCollection_AsciiString &) –
Return type:

void

static ExtendedDeepDump(*args)
  • Dumps <aDF> and its labels and their attributes, if their IDs are kept by <aFilter>. Dumps also the attributes content.
Parameters:
  • anOS (Standard_OStream &) –
  • aDF (Handle_TDF_Data &) –
  • aFilter (TDF_IDFilter &) –
Return type:

void

  • Dumps <aLabel>, its chilren and their attributes, if their IDs are kept by <aFilter>. Dumps also the attributes content.
Parameters:
  • anOS (Standard_OStream &) –
  • aLabel (TDF_Label &) –
  • aFilter (TDF_IDFilter &) –
Return type:

void

static IsSelfContained(*args)
  • Returns true if <aLabel> and its descendants reference only attributes or labels attached to themselves.
Parameters:aLabel (TDF_Label &) –
Return type:bool
  • Returns true if <aLabel> and its descendants reference only attributes or labels attached to themselves and kept by <aFilter>.
Parameters:
  • aLabel (TDF_Label &) –
  • aFilter (TDF_IDFilter &) –
Return type:

bool

static Label(*args)
  • Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.
Parameters:
  • aDF (Handle_TDF_Data &) –
  • anEntry (TCollection_AsciiString &) –
  • aLabel (TDF_Label &) –
  • create (bool) – default value is Standard_False
Return type:

void

  • Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.
Parameters:
  • aDF (Handle_TDF_Data &) –
  • anEntry (char *) –
  • aLabel (TDF_Label &) –
  • create (bool) – default value is Standard_False
Return type:

void

  • Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.
Parameters:
  • aDF (Handle_TDF_Data &) –
  • aTagList (TColStd_ListOfInteger &) –
  • aLabel (TDF_Label &) –
  • create (bool) – default value is Standard_False
Return type:

void

static NbAttributes(*args)
  • Returns the total number of attributes attached to the labels dependent on the label aLabel. The attributes of aLabel are also included in this figure. This information is useful in setting the size of an array.
Parameters:aLabel (TDF_Label &) –
Return type:int
  • Returns the number of attributes of the tree, selected by a<Filter>, including those of <aLabel>.
Parameters:
  • aLabel (TDF_Label &) –
  • aFilter (TDF_IDFilter &) –
Return type:

int

static NbLabels(*args)
  • Returns the number of labels of the tree, including <aLabel>. aLabel is also included in this figure. This information is useful in setting the size of an array.
Parameters:aLabel (TDF_Label &) –
Return type:int
static OutReferences(*args)
  • Returns in <atts> the referenced attributes. Caution: <atts> is not cleared before use!
Parameters:
  • aLabel (TDF_Label &) –
  • atts (TDF_AttributeMap &) –
Return type:

void

  • Returns in <atts> the referenced attributes and kept by <aFilterForReferences>. It considers only the referers kept by <aFilterForReferers>. Caution: <atts> is not cleared before use!
Parameters:
  • aLabel (TDF_Label &) –
  • aFilterForReferers (TDF_IDFilter &) –
  • aFilterForReferences (TDF_IDFilter &) –
  • atts (TDF_AttributeMap &) –
Return type:

void

static OutReferers(*args)
  • Returns in <theAtts> the attributes having out references. //! Caution: <theAtts> is not cleared before use!
Parameters:
  • theLabel (TDF_Label &) –
  • theAtts (TDF_AttributeMap &) –
Return type:

void

  • Returns in <atts> the attributes having out references and kept by <aFilterForReferers>. It considers only the references kept by <aFilterForReferences>. Caution: <atts> is not cleared before use!
Parameters:
  • aLabel (TDF_Label &) –
  • aFilterForReferers (TDF_IDFilter &) –
  • aFilterForReferences (TDF_IDFilter &) –
  • atts (TDF_AttributeMap &) –
Return type:

void

static RelocateLabel(*args)
  • Returns the label having the same sub-entry as <aLabel> but located as descendant as <toRoot> instead of <fromRoot>. //! Exemple : //! aLabel = 0:3:24:7:2:7 fromRoot = 0:3:24 toRoot = 0:5 returned label = 0:5:7:2:7
Parameters:
  • aSourceLabel (TDF_Label &) –
  • fromRoot (TDF_Label &) –
  • toRoot (TDF_Label &) –
  • aTargetLabel (TDF_Label &) –
  • create (bool) – default value is Standard_False
Return type:

void

static TagList(*args)
  • Returns the entry of <aLabel> as list of integers in <aTagList>.
Parameters:
  • aLabel (TDF_Label &) –
  • aTagList (TColStd_ListOfInteger &) –
Return type:

void

  • Returns the entry expressed by <anEntry> as list of integers in <aTagList>.
Parameters:
  • anEntry (TCollection_AsciiString &) –
  • aTagList (TColStd_ListOfInteger &) –
Return type:

void

thisown

The membership flag

TDF_Tool_CountLabels(*args)
  • Adds the labels of <aLabelList> to <aLabelMap> if they are unbound, or increases their reference counters. At the end of the process, <aLabelList> contains only the ADDED labels.
Parameters:
  • aLabelList (TDF_LabelList &) –
  • aLabelMap (TDF_LabelIntegerMap &) –
Return type:

void

TDF_Tool_DeductLabels(*args)
  • Decreases the reference counters of the labels of <aLabelList> to <aLabelMap>, and removes labels with null counter. At the end of the process, <aLabelList> contains only the SUPPRESSED labels.
Parameters:
  • aLabelList (TDF_LabelList &) –
  • aLabelMap (TDF_LabelIntegerMap &) –
Return type:

void

TDF_Tool_DeepDump(*args)
  • Dumps <aDF> and its labels and their attributes.
Parameters:
  • anOS (Standard_OStream &) –
  • aDF (Handle_TDF_Data &) –
Return type:

void

  • Dumps <aLabel>, its chilren and their attributes.
Parameters:
  • anOS (Standard_OStream &) –
  • aLabel (TDF_Label &) –
Return type:

void

TDF_Tool_Entry(*args)
  • Returns the entry for the label aLabel in the form of the ASCII character string anEntry containing the tag list for aLabel.
Parameters:
  • aLabel (TDF_Label &) –
  • anEntry (TCollection_AsciiString &) –
Return type:

void

TDF_Tool_ExtendedDeepDump(*args)
  • Dumps <aDF> and its labels and their attributes, if their IDs are kept by <aFilter>. Dumps also the attributes content.
Parameters:
  • anOS (Standard_OStream &) –
  • aDF (Handle_TDF_Data &) –
  • aFilter (TDF_IDFilter &) –
Return type:

void

  • Dumps <aLabel>, its chilren and their attributes, if their IDs are kept by <aFilter>. Dumps also the attributes content.
Parameters:
  • anOS (Standard_OStream &) –
  • aLabel (TDF_Label &) –
  • aFilter (TDF_IDFilter &) –
Return type:

void

TDF_Tool_IsSelfContained(*args)
  • Returns true if <aLabel> and its descendants reference only attributes or labels attached to themselves.
Parameters:aLabel (TDF_Label &) –
Return type:bool
  • Returns true if <aLabel> and its descendants reference only attributes or labels attached to themselves and kept by <aFilter>.
Parameters:
  • aLabel (TDF_Label &) –
  • aFilter (TDF_IDFilter &) –
Return type:

bool

TDF_Tool_Label(*args)
  • Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.
Parameters:
  • aDF (Handle_TDF_Data &) –
  • anEntry (TCollection_AsciiString &) –
  • aLabel (TDF_Label &) –
  • create (bool) – default value is Standard_False
Return type:

void

  • Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.
Parameters:
  • aDF (Handle_TDF_Data &) –
  • anEntry (char *) –
  • aLabel (TDF_Label &) –
  • create (bool) – default value is Standard_False
Return type:

void

  • Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.
Parameters:
  • aDF (Handle_TDF_Data &) –
  • aTagList (TColStd_ListOfInteger &) –
  • aLabel (TDF_Label &) –
  • create (bool) – default value is Standard_False
Return type:

void

TDF_Tool_NbAttributes(*args)
  • Returns the total number of attributes attached to the labels dependent on the label aLabel. The attributes of aLabel are also included in this figure. This information is useful in setting the size of an array.
Parameters:aLabel (TDF_Label &) –
Return type:int
  • Returns the number of attributes of the tree, selected by a<Filter>, including those of <aLabel>.
Parameters:
  • aLabel (TDF_Label &) –
  • aFilter (TDF_IDFilter &) –
Return type:

int

TDF_Tool_NbLabels(*args)
  • Returns the number of labels of the tree, including <aLabel>. aLabel is also included in this figure. This information is useful in setting the size of an array.
Parameters:aLabel (TDF_Label &) –
Return type:int
TDF_Tool_OutReferences(*args)
  • Returns in <atts> the referenced attributes. Caution: <atts> is not cleared before use!
Parameters:
  • aLabel (TDF_Label &) –
  • atts (TDF_AttributeMap &) –
Return type:

void

  • Returns in <atts> the referenced attributes and kept by <aFilterForReferences>. It considers only the referers kept by <aFilterForReferers>. Caution: <atts> is not cleared before use!
Parameters:
  • aLabel (TDF_Label &) –
  • aFilterForReferers (TDF_IDFilter &) –
  • aFilterForReferences (TDF_IDFilter &) –
  • atts (TDF_AttributeMap &) –
Return type:

void

TDF_Tool_OutReferers(*args)
  • Returns in <theAtts> the attributes having out references. //! Caution: <theAtts> is not cleared before use!
Parameters:
  • theLabel (TDF_Label &) –
  • theAtts (TDF_AttributeMap &) –
Return type:

void

  • Returns in <atts> the attributes having out references and kept by <aFilterForReferers>. It considers only the references kept by <aFilterForReferences>. Caution: <atts> is not cleared before use!
Parameters:
  • aLabel (TDF_Label &) –
  • aFilterForReferers (TDF_IDFilter &) –
  • aFilterForReferences (TDF_IDFilter &) –
  • atts (TDF_AttributeMap &) –
Return type:

void

TDF_Tool_RelocateLabel(*args)
  • Returns the label having the same sub-entry as <aLabel> but located as descendant as <toRoot> instead of <fromRoot>. //! Exemple : //! aLabel = 0:3:24:7:2:7 fromRoot = 0:3:24 toRoot = 0:5 returned label = 0:5:7:2:7
Parameters:
  • aSourceLabel (TDF_Label &) –
  • fromRoot (TDF_Label &) –
  • toRoot (TDF_Label &) –
  • aTargetLabel (TDF_Label &) –
  • create (bool) – default value is Standard_False
Return type:

void

TDF_Tool_TagList(*args)
  • Returns the entry of <aLabel> as list of integers in <aTagList>.
Parameters:
  • aLabel (TDF_Label &) –
  • aTagList (TColStd_ListOfInteger &) –
Return type:

void

  • Returns the entry expressed by <anEntry> as list of integers in <aTagList>.
Parameters:
  • anEntry (TCollection_AsciiString &) –
  • aTagList (TColStd_ListOfInteger &) –
Return type:

void

class TDF_Transaction(*args)

Bases: object

  • Creates an empty transaction context, unable to be opened.
Parameters:aName (TCollection_AsciiString &) – default value is
Return type:None
  • Creates a transaction context on <aDF>, ready to be opened.
Parameters:
  • aDF (Handle_TDF_Data &) –
  • aName (TCollection_AsciiString &) – default value is
Return type:

None

Abort()
  • Aborts the transactions until AND including the current opened one.
Return type:None
Commit()
  • Commits the transactions until AND including the current opened one.
Parameters:withDelta (bool) – default value is Standard_False
Return type:Handle_TDF_Delta
Data()
  • Returns the Data from TDF.
Return type:Handle_TDF_Data
Initialize()
  • Aborts all the transactions on <myDF> and sets <aDF> to build a transaction context on <aDF>, ready to be opened.
Parameters:aDF (Handle_TDF_Data &) –
Return type:None
IsOpen()
  • Returns true if the transaction is open.
Return type:bool
Name()
  • Returns the transaction name.
Return type:TCollection_AsciiString
Open()
  • If not yet done, opens a new transaction on <myDF>. Returns the index of the just opened transaction. //! It raises DomainError if the transaction is already open, and NullObject if there is no current Data framework.
Return type:int
Transaction()
  • Returns the number of the transaction opened by <self>.
Return type:int
thisown

The membership flag

register_handle(handle, base_object)

Inserts the handle into the base object to prevent memory corruption in certain cases

class tdf

Bases: object

static AddLinkGUIDToProgID(*args)
  • Sets link between GUID and ProgID in hidden DataMap
Parameters:
  • ID (Standard_GUID &) –
  • ProgID (TCollection_ExtendedString &) –
Return type:

void

static GUIDFromProgID(*args)
  • Returns True if there is GUID for given <ProgID> then GUID is returned in <ID>
Parameters:
  • ProgID (TCollection_ExtendedString &) –
  • ID (Standard_GUID &) –
Return type:

bool

static LowestID(*args)
  • Returns ID ‘00000000-0000-0000-0000-000000000000’, sometimes used as null ID.
Return type:Standard_GUID
static ProgIDFromGUID(*args)
  • Returns True if there is ProgID for given <ID> then ProgID is returned in <ProgID>
Parameters:
  • ID (Standard_GUID &) –
  • ProgID (TCollection_ExtendedString &) –
Return type:

bool

static UppestID(*args)
  • Returns ID ‘ffffffff-ffff-ffff-ffff-ffffffffffff’.
Return type:Standard_GUID
thisown

The membership flag

tdf_AddLinkGUIDToProgID(*args)
  • Sets link between GUID and ProgID in hidden DataMap
Parameters:
  • ID (Standard_GUID &) –
  • ProgID (TCollection_ExtendedString &) –
Return type:

void

tdf_GUIDFromProgID(*args)
  • Returns True if there is GUID for given <ProgID> then GUID is returned in <ID>
Parameters:
  • ProgID (TCollection_ExtendedString &) –
  • ID (Standard_GUID &) –
Return type:

bool

tdf_LowestID(*args)
  • Returns ID ‘00000000-0000-0000-0000-000000000000’, sometimes used as null ID.
Return type:Standard_GUID
tdf_ProgIDFromGUID(*args)
  • Returns True if there is ProgID for given <ID> then ProgID is returned in <ProgID>
Parameters:
  • ID (Standard_GUID &) –
  • ProgID (TCollection_ExtendedString &) –
Return type:

bool

tdf_UppestID(*args)
  • Returns ID ‘ffffffff-ffff-ffff-ffff-ffffffffffff’.
Return type:Standard_GUID