OCC.Core.TDF module

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

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class TDF_Attribute(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

AddAttribute()

• Adds an Attribute <other> to the label of <self>.Raises if there is already one of the same GUID fhan <other>.

  param other

  type other

  TDF_Attribute

  rtype

  None

AfterAddition()

• Something to do after adding an Attribute to a label.

  rtype

  void

AfterResume()

• Something to do after resuming an Attribute from a label.

  rtype

  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.

  param forceIt

  default value is Standard_False

  type forceIt

  bool

  rtype

  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.

  param anAttDelta

  type anAttDelta

  TDF_AttributeDelta

  param forceIt

  default value is Standard_False

  type forceIt

  bool

  rtype

  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.

  rtype

  None

BackupCopy()

• Copies the attribute contents into a new other attribute. It is used by Backup().

  rtype

  opencascade::handle<TDF_Attribute>

BeforeCommitTransaction()

• A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.

  rtype

  void

BeforeForget()

• Something to do before forgetting an Attribute to a label.

  rtype

  void

BeforeRemoval()

• Something to do before removing an Attribute from a label.

  rtype

  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.

  param anAttDelta

  type anAttDelta

  TDF_AttributeDelta

  param forceIt

  default value is Standard_False

  type forceIt

  bool

  rtype

  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).

  rtype

  opencascade::handle<TDF_DeltaOnAddition>

DeltaOnForget()

• Makes an AttributeDelta because <self> has been forgotten.

  rtype

  opencascade::handle<TDF_DeltaOnForget>

DeltaOnModification()

• Makes a DeltaOnModification between <self> and <anOldAttribute.

  param anOldAttribute

  type anOldAttribute

  TDF_Attribute

  rtype

  opencascade::handle<TDF_DeltaOnModification>* Applies a DeltaOnModification to <self>.

  param aDelta

  type aDelta

  TDF_DeltaOnModification

  rtype

  void

DeltaOnRemoval()

• Makes a DeltaOnRemoval on <self> because <self> has disappeared from the DS.

  rtype

  opencascade::handle<TDF_DeltaOnRemoval>

DeltaOnResume()

• Makes an AttributeDelta because <self> has been resumed.

  rtype

  opencascade::handle<TDF_DeltaOnResume>

static DownCast(t)

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.

  param anOS

  type anOS

  Standard_OStream

  param aFilter

  type aFilter

  TDF_IDFilter

  param aMap

  type aMap

  TDF_AttributeIndexedMap

  rtype

  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.

  param anID

  type anID

  Standard_GUID

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  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.

  param aTransaction

  type aTransaction

  int

  rtype

  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

  param clearChildren

  default value is Standard_True

  type clearChildren

  bool

  rtype

  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.

  param aguid

  type aguid

  Standard_GUID

  rtype

  bool

ID()

• Returns the ID of the attribute.

  rtype

  Standard_GUID

IsAttribute()

• Returns true if it exists an associated attribute of <self> with <anID> as ID.

  param anID

  type anID

  Standard_GUID

  rtype

  bool

IsBackuped()

• Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.

  rtype

  bool

IsForgotten()

• Returns true if the attribute forgotten status is set. //! ShortCut Methods concerning associated attributes =================================================

  rtype

  bool

IsNew()

• Returns true if the attribute has no backup

  rtype

  bool

IsValid()

• Returns true if the attribute is valid; i.e. not a backuped or removed one.

  rtype

  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.

  rtype

  TDF_Label

NewEmpty()

• Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  rtype

  opencascade::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.

  param intoAttribute

  type intoAttribute

  TDF_Attribute

  param aRelocationTable

  type aRelocationTable

  TDF_RelocationTable

  rtype

  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.

  param aDataSet

  type aDataSet

  TDF_DataSet

  rtype

  void

Restore()

• Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  void

SetID()

• Sets specific ID of the attribute (supports several attributes of one type at the same label feature).

  param &

  type &

  Standard_GUID

  rtype

  None* Sets default ID defined in nested class (to be used for attributes having User ID feature).

  rtype

  None

Transaction()

• Returns the transaction index in which the attribute has been created or modified.

  rtype

  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.

  rtype

  int

property thisown

The membership flag

class TDF_AttributeArray1(*args)

Bases: object

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

First()

Init()

IsAllocated()

IsDeletable()

IsEmpty()

Last()

Length()

Lower()

Move()

Resize()

Set()

SetValue()

Size()

Upper()

Value()

begin()

cbegin()

cend()

end()

next()

property thisown

The membership flag

class TDF_AttributeDataMap(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TDF_AttributeDelta(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Apply()

• Applies the delta to the attribute.

  rtype

  void

Attribute()

• Returns the reference attribute.

  rtype

  opencascade::handle<TDF_Attribute>

static DownCast(t)

DumpToString(TDF_AttributeDelta self) → std::string

ID()

• Returns the ID of the attribute concerned by <self>.

  rtype

  Standard_GUID

Label()

• Returns the label concerned by <self>.

  rtype

  TDF_Label

property thisown

The membership flag

class TDF_AttributeDeltaList(*args)

Bases: object

Append()

Assign()

Clear()

First()

InsertAfter()

InsertBefore()

Last()

Prepend()

Remove()

RemoveFirst()

Reverse()

Set()

Size()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TDF_AttributeDoubleMap(*args)

Bases: object

AreBound()

Assign()

Bind()

Clear()

Exchange()

Find1()

Find2()

IsBound1()

IsBound2()

ReSize()

Seek1()

Seek2()

Set()

Size()

UnBind1()

UnBind2()

property thisown

The membership flag

class TDF_AttributeIndexedMap(*args)

Bases: object

Add()

Assign()

Clear()

Contains()

Exchange()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Set()

Size()

Substitute()

Swap()

cbegin()

cend()

property thisown

The membership flag

class TDF_AttributeIterator(*args)

Bases: object

Return type

None:param aLabel: :type aLabel: TDF_Label :param withoutForgotten: default value is Standard_True :type withoutForgotten: bool :rtype: None:param aLabelNode: :type aLabelNode: TDF_LabelNodePtr :param withoutForgotten: default value is Standard_True :type withoutForgotten: bool :rtype: None

Initialize()

Parameters

aLabel –

type aLabel

TDF_Label

param withoutForgotten

default value is Standard_True

type withoutForgotten

bool

rtype

None

More()

Return type

inline bool

Next()

Return type

None

PtrValue()

• Provides an access to the internal pointer of the current attribute. The method has better performance as not-creating handle.

  rtype

  inline TDF_Attribute *

Value()

Return type

inline opencascade::handle<TDF_Attribute>

property thisown

The membership flag

class TDF_AttributeList(*args)

Bases: object

Append()

Assign()

Clear()

First()

InsertAfter()

InsertBefore()

Last()

Prepend()

Remove()

RemoveFirst()

Reverse()

Set()

Size()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TDF_AttributeMap(*args)

Bases: object

Add()

Added()

Assign()

Clear()

Contains()

Differ()

Difference()

Exchange()

HasIntersection()

Intersect()

Intersection()

IsEqual()

ReSize()

Remove()

Set()

Size()

Subtract()

Subtraction()

Union()

Unite()

cbegin()

cend()

property thisown

The membership flag

class TDF_AttributeSequence(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class TDF_ChildIDIterator(*args)

Bases: object

• Creates an empty iterator.

  rtype

  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.

  param aLabel

  type aLabel

  TDF_Label

  param anID

  type anID

  Standard_GUID

  param allLevels

  default value is Standard_False

  type allLevels

  bool

  rtype

  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.

  param aLabel

  type aLabel

  TDF_Label

  param anID

  type anID

  Standard_GUID

  param allLevels

  default value is Standard_False

  type allLevels

  bool

  rtype

  None

More()

• Returns True if there is a current Item in the iteration.

  rtype

  bool

Next()

• Move to the next Item

  rtype

  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.

  rtype

  None

Value()

• Returns the current item; a null handle if there is none.

  rtype

  opencascade::handle<TDF_Attribute>

property thisown

The membership flag

class TDF_ChildIterator(*args)

Bases: object

• Creates an empty iterator object to explore the children of a label.

  rtype

  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.

  param aLabel

  type aLabel

  TDF_Label

  param allLevels

  default value is Standard_False

  type allLevels

  bool

  rtype

  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); std::cout << as.ToCString() << std::endl; } }

  param aLabel

  type aLabel

  TDF_Label

  param allLevels

  default value is Standard_False

  type allLevels

  bool

  rtype

  None

More()

• Returns true if a current label is found in the iteration process.

  rtype

  bool

Next()

• Move the current iteration to the next Item.

  rtype

  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.

  rtype

  None

Value()

• Returns the current label; or, if there is none, a null label.

  rtype

  TDF_Label

property thisown

The membership flag

class TDF_ClosureMode(*args)

Bases: object

• Creates an objet with all modes set to <aMode>.

  param aMode

  default value is Standard_True

  type aMode

  bool

  rtype

  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.

  param aStatus

  type aStatus

  bool

  rtype

  None* Returns true if the mode ‘Descendants’ is set.

  rtype

  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().

  param aStatus

  type aStatus

  bool

  rtype

  None* Returns true if the mode ‘References’ is set.

  rtype

  bool

property thisown

The membership flag

class TDF_ClosureTool

Bases: object

static Closure()

• Builds the transitive closure of label and attribute sets into <aDataSet>.

  param aDataSet

  type aDataSet

  TDF_DataSet

  rtype

  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.

  param aDataSet

  type aDataSet

  TDF_DataSet

  param aFilter

  type aFilter

  TDF_IDFilter

  param aMode

  type aMode

  TDF_ClosureMode

  rtype

  void* Builds the transitive closure of <aLabel>.

  param aLabel

  type aLabel

  TDF_Label

  param aLabMap

  type aLabMap

  TDF_LabelMap

  param anAttMap

  type anAttMap

  TDF_AttributeMap

  param aFilter

  type aFilter

  TDF_IDFilter

  param aMode

  type aMode

  TDF_ClosureMode

  rtype

  void

property thisown

The membership flag

class TDF_ComparisonTool

Bases: object

static Compare()

• Compares <aSourceDataSet> with <aTargetDataSet>, updating <aRelocationTable> with labels and attributes found in both sets.

  param aSourceDataSet

  type aSourceDataSet

  TDF_DataSet

  param aTargetDataSet

  type aTargetDataSet

  TDF_DataSet

  param aFilter

  type aFilter

  TDF_IDFilter

  param aRelocationTable

  type aRelocationTable

  TDF_RelocationTable

  rtype

  void

static Cut()

• Removes attributes from <aDataSet>.

  param aDataSet

  type aDataSet

  TDF_DataSet

  rtype

  void

static IsSelfContained()

• Returns true if all the labels of <aDataSet> are descendant of <aLabel>.

  param aLabel

  type aLabel

  TDF_Label

  param aDataSet

  type aDataSet

  TDF_DataSet

  rtype

  bool

static SourceUnbound()

• 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: 1labels treatment only; 2attributes treatment only (default value); 3both labels & attributes treatment.

  param aRefDataSet

  type aRefDataSet

  TDF_DataSet

  param aRelocationTable

  type aRelocationTable

  TDF_RelocationTable

  param aFilter

  type aFilter

  TDF_IDFilter

  param aDiffDataSet

  type aDiffDataSet

  TDF_DataSet

  param anOption

  default value is 2

  type anOption

  int

  rtype

  bool

static TargetUnbound()

• 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: 1labels treatment only; 2attributes treatment only(default value); 3both labels & attributes treatment.

  param aRefDataSet

  type aRefDataSet

  TDF_DataSet

  param aRelocationTable

  type aRelocationTable

  TDF_RelocationTable

  param aFilter

  type aFilter

  TDF_IDFilter

  param aDiffDataSet

  type aDiffDataSet

  TDF_DataSet

  param anOption

  default value is 2

  type anOption

  int

  rtype

  bool

property thisown

The membership flag

class TDF_CopyLabel(*args)

Bases: object

• Empty constructor

  rtype

  None* CopyTool

  param aSource

  type aSource

  TDF_Label

  param aTarget

  type aTarget

  TDF_Label

  rtype

  None

static ExternalReferences()

• Check external references and if exist fills the aExternals Map

  param Lab

  type Lab

  TDF_Label

  param aExternals

  type aExternals

  TDF_AttributeMap

  param aFilter

  type aFilter

  TDF_IDFilter

  rtype

  bool* Check external references and if exist fills the aExternals Map

  param aRefLab

  type aRefLab

  TDF_Label

  param Lab

  type Lab

  TDF_Label

  param aExternals

  type aExternals

  TDF_AttributeMap

  param aFilter

  type aFilter

  TDF_IDFilter

  param aDataSet

  type aDataSet

  TDF_DataSet

  rtype

  void

IsDone()

Return type

bool

Load()

• Loads src and tgt labels

  param aSource

  type aSource

  TDF_Label

  param aTarget

  type aTarget

  TDF_Label

  rtype

  None

Perform()

• performs algorithm of selfcontained copy

  rtype

  None

RelocationTable()

• returns relocation table

  rtype

  opencascade::handle<TDF_RelocationTable>

UseFilter()

• Sets filter

  param aFilter

  type aFilter

  TDF_IDFilter

  rtype

  None

property thisown

The membership flag

class TDF_CopyTool

Bases: object

static Copy()

• Copy <aSourceDataSet> with using and updating <aRelocationTable>. This method ignores target attributes privilege over source ones.

  param aSourceDataSet

  type aSourceDataSet

  TDF_DataSet

  param aRelocationTable

  type aRelocationTable

  TDF_RelocationTable

  rtype

  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.

  param aSourceDataSet

  type aSourceDataSet

  TDF_DataSet

  param aRelocationTable

  type aRelocationTable

  TDF_RelocationTable

  param aPrivilegeFilter

  type aPrivilegeFilter

  TDF_IDFilter

  rtype

  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.

  param aSourceDataSet

  type aSourceDataSet

  TDF_DataSet

  param aRelocationTable

  type aRelocationTable

  TDF_RelocationTable

  param aPrivilegeFilter

  type aPrivilegeFilter

  TDF_IDFilter

  param aRefFilter

  type aRefFilter

  TDF_IDFilter

  param setSelfContained

  type setSelfContained

  bool

  rtype

  void

property thisown

The membership flag

class TDF_Data(*args)

Bases: OCC.Core.Standard.Standard_Transient

• A new and empty Data structure.

  rtype

  None

AllowModification()

• Sets modification mode.

  param isAllowed

  type isAllowed

  bool

  rtype

  None

Destroy()

Return type

None

static DownCast(t)

DumpToString(TDF_Data self) → std::string

IsApplicable()

• Returns true if <aDelta> is applicable HERE and NOW.

  param aDelta

  type aDelta

  TDF_Delta

  rtype

  bool

IsModificationAllowed()

• returns modification mode.

  rtype

  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.

  rtype

  TDF_HAllocator

NotUndoMode()

• Returns the undo mode status.

  rtype

  bool

Root()

• Returns the root label of the Data structure.

  rtype

  TDF_Label

Time()

• Returns the current tick. It is incremented each Commit.

  rtype

  int

Transaction()

• Returns the current transaction number.

  rtype

  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)

  param aDelta

  type aDelta

  TDF_Delta

  param withDelta

  default value is Standard_False

  type withDelta

  bool

  rtype

  opencascade::handle<TDF_Delta>

property thisown

The membership flag

class TDF_DataSet(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty DataSet object.

  rtype

  None

AddAttribute()

• Adds <anAttribute> into the current data set.

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  None

AddLabel()

• Adds <aLabel> in the current data set.

  param aLabel

  type aLabel

  TDF_Label

  rtype

  None

AddRoot()

• Adds a root label to <myRootLabels>.

  param aLabel

  type aLabel

  TDF_Label

  rtype

  None

Attributes()

• Returns the map of attributes in the current data set. This map can be used directly, or updated.

  rtype

  TDF_AttributeMap

Clear()

• Clears all information.

  rtype

  None

ContainsAttribute()

• Returns true if <anAttribute> is in the data set.

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  bool

ContainsLabel()

• Returns true if the label <alabel> is in the data set.

  param aLabel

  type aLabel

  TDF_Label

  rtype

  bool

static DownCast(t)

DumpToString(TDF_DataSet self) → std::string

IsEmpty()

• Returns true if there is at least one label or one attribute.

  rtype

  bool

Labels()

• Returns the map of labels in this data set. This map can be used directly, or updated.

  rtype

  TDF_LabelMap

Roots()

• Returns <myRootLabels> to be used or updated.

  rtype

  TDF_LabelList

property thisown

The membership flag

class TDF_DefaultDeltaOnModification(*args)

Bases: OCC.Core.TDF.TDF_DeltaOnModification

• Creates a TDF_DefaultDeltaOnModification. <anAttribute> must be the backup copy.

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class TDF_DefaultDeltaOnRemoval(*args)

Bases: OCC.Core.TDF.TDF_DeltaOnRemoval

• Creates a TDF_DefaultDeltaOnRemoval.

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class TDF_Delta(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a delta.

  rtype

  None

AttributeDeltas()

• Returns the field <myAttDeltaList>.

  rtype

  TDF_AttributeDeltaList

BeginTime()

• Returns the field <myBeginTime>.

  rtype

  int

static DownCast(t)

DumpToString(TDF_Delta self) → std::string

EndTime()

• Returns the field <myEndTime>.

  rtype

  int

IsApplicable()

• Returns true if the Undo action of <self> is applicable at <aCurrentTime>.

  param aCurrentTime

  type aCurrentTime

  int

  rtype

  bool

IsEmpty()

• Returns true if there is nothing to undo.

  rtype

  bool

Labels()

• Adds in <aLabelList> the labels of the attribute deltas. Caution: <aLabelList> is not cleared before use.

  param aLabelList

  type aLabelList

  TDF_LabelList

  rtype

  None

Name()

• Returns a name associated with this delta.

  rtype

  TCollection_ExtendedString

SetName()

• Associates a name <theName> with this delta

  param theName

  type theName

  TCollection_ExtendedString

  rtype

  None

property thisown

The membership flag

class TDF_DeltaList(*args)

Bases: object

Append()

Assign()

Clear()

First()

InsertAfter()

InsertBefore()

Last()

Prepend()

Remove()

RemoveFirst()

Reverse()

Set()

Size()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TDF_DeltaOnAddition(*args)

Bases: OCC.Core.TDF.TDF_AttributeDelta

• Creates a TDF_DeltaOnAddition.

  param anAtt

  type anAtt

  TDF_Attribute

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class TDF_DeltaOnForget(*args)

Bases: OCC.Core.TDF.TDF_AttributeDelta

• Creates a TDF_DeltaOnForget.

  param anAtt

  type anAtt

  TDF_Attribute

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class TDF_DeltaOnModification(*args, **kwargs)

Bases: OCC.Core.TDF.TDF_AttributeDelta

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

property thisown

The membership flag

class TDF_DeltaOnRemoval(*args, **kwargs)

Bases: OCC.Core.TDF.TDF_AttributeDelta

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

property thisown

The membership flag

class TDF_DeltaOnResume(*args)

Bases: OCC.Core.TDF.TDF_AttributeDelta

• Creates a TDF_DeltaOnResume.

  param anAtt

  type anAtt

  TDF_Attribute

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class TDF_GUIDProgIDMap(*args)

Bases: object

AreBound()

Assign()

Bind()

Clear()

Exchange()

Find1()

Find2()

IsBound1()

IsBound2()

ReSize()

Seek1()

Seek2()

Set()

Size()

UnBind1()

UnBind2()

property thisown

The membership flag

class TDF_HAllocator

Bases: object

property thisown

The membership flag

class TDF_HAttributeArray1(*args)

Bases: OCC.Core.TDF.TDF_AttributeArray1, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Array1()

ChangeArray1()

static DownCast(t)

property 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().

  param ignoreMode

  default value is Standard_True

  type ignoreMode

  bool

  rtype

  None

Copy()

• Copies into <self> the contents of <fromFilter>. <self> is cleared before copy.

  param fromFilter

  type fromFilter

  TDF_IDFilter

  rtype

  None

DumpToString(TDF_IDFilter self) → std::string

IDList()

• Copies the list of ID to be kept or ignored in <anIDList>. <anIDList> is cleared before use.

  param anIDList

  type anIDList

  TDF_IDList

  rtype

  None

Ignore()

• An attribute with <anID> as ID is to be ignored and the filter will answer false to the question IsKept(<anID>).

  param anID

  type anID

  Standard_GUID

  rtype

  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>.

  param anIDList

  type anIDList

  TDF_IDList

  rtype

  None

IgnoreAll()

• The list of ID is cleared and the filter mode is set to ignore mode if <keep> is true; false otherwise.

  param ignore

  type ignore

  bool

  rtype

  None* Returns true is the mode is set to ‘ignore all but…’.

  rtype

  bool

IsIgnored()

• Returns true if the ID is to be ignored.

  param anID

  type anID

  Standard_GUID

  rtype

  bool* Returns true if the attribute is to be ignored.

  param anAtt

  type anAtt

  TDF_Attribute

  rtype

  bool

IsKept()

• Returns true if the ID is to be kept.

  param anID

  type anID

  Standard_GUID

  rtype

  bool* Returns true if the attribute is to be kept.

  param anAtt

  type anAtt

  TDF_Attribute

  rtype

  bool

Keep()

• An attribute with <anID> as ID is to be kept and the filter will answer true to the question IsKept(<anID>).

  param anID

  type anID

  Standard_GUID

  rtype

  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>.

  param anIDList

  type anIDList

  TDF_IDList

  rtype

  None

property thisown

The membership flag

class TDF_IDList(*args)

Bases: object

Append()

Assign()

Clear()

First()

InsertAfter()

InsertBefore()

Last()

Prepend()

Remove()

RemoveFirst()

Reverse()

Set()

Size()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TDF_IDMap(*args)

Bases: object

Add()

Added()

Assign()

Clear()

Contains()

Differ()

Difference()

Exchange()

HasIntersection()

Intersect()

Intersection()

IsEqual()

ReSize()

Remove()

Set()

Size()

Subtract()

Subtraction()

Union()

Unite()

cbegin()

cend()

property thisown

The membership flag

class TDF_Label(*args)

Bases: object

• Constructs an empty label object.

  rtype

  None

AddAttribute()

• Adds an Attribute to the current label. Raises if there is already one.

  param anAttribute

  type anAttribute

  TDF_Attribute

  param append

  default value is Standard_True

  type append

  bool

  rtype

  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.

  rtype

  bool

Data()

• Returns the Data owning <self>.

  rtype

  opencascade::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.

  rtype

  int

DumpToString(TDF_Label self) → std::string

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>.

  param anOS

  type anOS

  Standard_OStream

  param aFilter

  type aFilter

  TDF_IDFilter

  param aMap

  type aMap

  TDF_AttributeIndexedMap

  rtype

  None

Father()

• Returns the label father. This label may be null if the label is root.

  rtype

  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.

  param anID

  type anID

  Standard_GUID

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  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.

  param anID

  type anID

  Standard_GUID

  param aTransaction

  type aTransaction

  int

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  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);

  param aTag

  type aTag

  int

  param create

  default value is Standard_True

  type create

  bool

  rtype

  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.

  param clearChildren

  default value is Standard_True

  type clearChildren

  bool

  rtype

  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.

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  None* Forgets the Attribute of GUID <aguid> from the current label . If the attribute doesn’t exist returns False. Otherwise returns True.

  param aguid

  type aguid

  Standard_GUID

  rtype

  bool

GetLabelName()

Returns the label name

HasAttribute()

• Returns true if this label has at least one attribute.

  rtype

  bool

HasChild()

• Returns true if this label has at least one child.

  rtype

  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

  param otherLabel

  type otherLabel

  TDF_Label

  rtype

  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

  param otherLabel

  type otherLabel

  TDF_Label

  rtype

  bool

Imported()

• Sets or unsets <self> and all its descendants as imported label, according to <aStatus>.

  param aStatus

  type aStatus

  bool

  rtype

  None

IsAttribute()

• Returns true if <self> owns an attribute with <anID> as ID.

  param anID

  type anID

  Standard_GUID

  rtype

  bool

IsDescendant()

• Returns True if <self> is a descendant of <aLabel>. Attention: every label is its own descendant.

  param aLabel

  type aLabel

  TDF_Label

  rtype

  bool

IsDifferent()

Parameters

aLabel –

type aLabel

TDF_Label

rtype

bool

IsEqual()

• Returns True if the <aLabel> is equal to me (same LabelNode*).

  param aLabel

  type aLabel

  TDF_Label

  rtype

  bool

IsImported()

• Returns True if the <aLabel> is imported.

  rtype

  bool

IsNull()

• Returns True if the <aLabel> is null, i.e. it has not been included in the data framework.

  rtype

  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.

  rtype

  bool

NbAttributes()

• Returns the number of attributes.

  rtype

  int

NbChildren()

• Returns the number of children.

  rtype

  int

NewChild()

• Create a new child label of me using autoamtic delivery tags provided by TagSource.

  rtype

  TDF_Label

Nullify()

• Nullifies the label.

  rtype

  None

ResumeAttribute()

• Undo Forget action, setting its forgotten status false and its valid status true. Raises if the attribute is not in the structure.

  param anAttribute

  type anAttribute

  TDF_Attribute

  rtype

  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.

  rtype

  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.

  rtype

  int

Transaction()

• Returns the current transaction index.

  rtype

  int

property thisown

The membership flag

class TDF_LabelDataMap(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TDF_LabelDoubleMap(*args)

Bases: object

AreBound()

Assign()

Bind()

Clear()

Exchange()

Find1()

Find2()

IsBound1()

IsBound2()

ReSize()

Seek1()

Seek2()

Set()

Size()

UnBind1()

UnBind2()

property thisown

The membership flag

class TDF_LabelIndexedMap(*args)

Bases: object

Add()

Assign()

Clear()

Contains()

Exchange()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Set()

Size()

Substitute()

Swap()

cbegin()

cend()

property thisown

The membership flag

class TDF_LabelIntegerMap(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TDF_LabelList(*args)

Bases: object

Append()

Assign()

Clear()

First()

InsertAfter()

InsertBefore()

Last()

Prepend()

Remove()

RemoveFirst()

Reverse()

Set()

Size()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TDF_LabelMap(*args)

Bases: object

Add()

Added()

Assign()

Clear()

Contains()

Differ()

Difference()

Exchange()

HasIntersection()

Intersect()

Intersection()

IsEqual()

ReSize()

Remove()

Set()

Size()

Subtract()

Subtraction()

Union()

Unite()

cbegin()

cend()

property thisown

The membership flag

class TDF_LabelMapHasher

Bases: object

static HashCode()

• Computes a hash code for the given label, in the range [1, theUpperBound] @param theLabel the label which hash code is to be computed @param theUpperBound the upper bound of the range a computing hash code must be within returns a computed hash code, in the range [1, theUpperBound]

  param theLabel

  type theLabel

  TDF_Label

  param theUpperBound

  type theUpperBound

  int

  rtype

  int

static IsEqual()

• Returns True when the two keys are the same. Two same keys must have the same hashcode, the contrary is not necessary.

  param aLab1

  type aLab1

  TDF_Label

  param aLab2

  type aLab2

  TDF_Label

  rtype

  bool

property thisown

The membership flag

class TDF_LabelSequence(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class TDF_ListIteratorOfAttributeDeltaList(*args)

Bases: object

ChangeValue()

More()

Next()

Value()

property thisown

The membership flag

class TDF_ListIteratorOfAttributeList(*args)

Bases: object

ChangeValue()

More()

Next()

Value()

property thisown

The membership flag

class TDF_ListIteratorOfDeltaList(*args)

Bases: object

ChangeValue()

More()

Next()

Value()

property thisown

The membership flag

class TDF_ListIteratorOfIDList(*args)

Bases: object

ChangeValue()

More()

Next()

Value()

property thisown

The membership flag

class TDF_ListIteratorOfLabelList(*args)

Bases: object

ChangeValue()

More()

Next()

Value()

property thisown

The membership flag

class TDF_Reference(*args)

Bases: OCC.Core.TDF.TDF_Attribute

Return type

None

static DownCast(t)

DumpToString(TDF_Reference self) → std::string

Get()

Return type

TDF_Label

static GetID()

Return type

Standard_GUID

Set()

Parameters

I –

type I

TDF_Label

param Origin

type Origin

TDF_Label

rtype

opencascade::handle<TDF_Reference>:param Origin:

type Origin

TDF_Label

rtype

None

property thisown

The membership flag

class TDF_RelocationTable(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an relocation table. <selfRelocate> says if a value without explicit relocation is its own relocation.

  param selfRelocate

  default value is Standard_False

  type selfRelocate

  bool

  rtype

  None

AfterRelocate()

Parameters

afterRelocate –

type afterRelocate

bool

rtype

None* Returns <myAfterRelocate>.

rtype

bool

AttributeTable()

• Returns <myAttributeTable> to be used or updated.

  rtype

  TDF_AttributeDataMap

Clear()

• Clears the relocation dictionnary, but lets the self relocation flag to its current value.

  rtype

  None

static DownCast(t)

Dump()

• Dumps the relocation table.

  param dumpLabels

  type dumpLabels

  bool

  param dumpAttributes

  type dumpAttributes

  bool

  param dumpTransients

  type dumpTransients

  bool

  param anOS

  type anOS

  Standard_OStream

  rtype

  Standard_OStream

HasRelocation()

• Finds the relocation value of <aSourceLabel> and returns it into <aTargetLabel>. //! (See above SelfRelocate method for more explanation about the method behavior)

  param aSourceLabel

  type aSourceLabel

  TDF_Label

  param aTargetLabel

  type aTargetLabel

  TDF_Label

  rtype

  bool* Finds the relocation value of <aSourceAttribute> and returns it into <aTargetAttribute>. //! (See above SelfRelocate method for more explanation about the method behavior)

  param aSourceAttribute

  type aSourceAttribute

  TDF_Attribute

  param aTargetAttribute

  type aTargetAttribute

  TDF_Attribute

  rtype

  bool

HasTransientRelocation()

• Finds the relocation value of <aSourceTransient> and returns it into <aTargetTransient>. //! (See above SelfRelocate method for more explanation about the method behavior)

  param aSourceTransient

  type aSourceTransient

  Standard_Transient

  param aTargetTransient

  type aTargetTransient

  Standard_Transient

  rtype

  bool

LabelTable()

• Returns <myLabelTable> to be used or updated.

  rtype

  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.

  param selfRelocate

  type selfRelocate

  bool

  rtype

  None* Returns <mySelfRelocate>.

  rtype

  bool

SetRelocation()

• Sets the relocation value of <aSourceLabel> to <aTargetLabel>.

  param aSourceLabel

  type aSourceLabel

  TDF_Label

  param aTargetLabel

  type aTargetLabel

  TDF_Label

  rtype

  None* Sets the relocation value of <aSourceAttribute> to <aTargetAttribute>.

  param aSourceAttribute

  type aSourceAttribute

  TDF_Attribute

  param aTargetAttribute

  type aTargetAttribute

  TDF_Attribute

  rtype

  None

SetTransientRelocation()

• Sets the relocation value of <aSourceTransient> to <aTargetTransient>.

  param aSourceTransient

  type aSourceTransient

  Standard_Transient

  param aTargetTransient

  type aTargetTransient

  Standard_Transient

  rtype

  None

TargetAttributeMap()

• Fills <anAttributeMap> with target relocation attributes. <anAttributeMap> is not cleared before use.

  param anAttributeMap

  type anAttributeMap

  TDF_AttributeMap

  rtype

  None

TargetLabelMap()

• Fills <aLabelMap> with target relocation labels. <aLabelMap> is not cleared before use.

  param aLabelMap

  type aLabelMap

  TDF_LabelMap

  rtype

  None

TransientTable()

• Returns <myTransientTable> to be used or updated.

  rtype

  TColStd_IndexedDataMapOfTransientTransient

property thisown

The membership flag

class TDF_TagSource(*args)

Bases: OCC.Core.TDF.TDF_Attribute

Return type

None

static DownCast(t)

Get()

Return type

int

static GetID()

• class methods =============

  rtype

  Standard_GUID

NewChild()

• Find (or create) a tagSource attribute located at <L> and make a new child label. TagSource methods =================

  param L

  type L

  TDF_Label

  rtype

  TDF_Label:rtype: TDF_Label

NewTag()

Return type

int

Set()

• Find, or create, a TagSource attribute. the TagSource attribute is returned.

  param label

  type label

  TDF_Label

  rtype

  opencascade::handle<TDF_TagSource>* TDF_Attribute methods =====================

  param T

  type T

  int

  rtype

  None

property thisown

The membership flag

class TDF_Tool

Bases: object

static CountLabels()

• 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.

  param aLabelList

  type aLabelList

  TDF_LabelList

  param aLabelMap

  type aLabelMap

  TDF_LabelIntegerMap

  rtype

  void

static DeductLabels()

• 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.

  param aLabelList

  type aLabelList

  TDF_LabelList

  param aLabelMap

  type aLabelMap

  TDF_LabelIntegerMap

  rtype

  void

static DeepDump()

• Dumps <aDF> and its labels and their attributes.

  param anOS

  type anOS

  Standard_OStream

  param aDF

  type aDF

  TDF_Data

  rtype

  void* Dumps <aLabel>, its chilren and their attributes.

  param anOS

  type anOS

  Standard_OStream

  param aLabel

  type aLabel

  TDF_Label

  rtype

  void

static Entry()

• Returns the entry for the label aLabel in the form of the ASCII character string anEntry containing the tag list for aLabel.

  param aLabel

  type aLabel

  TDF_Label

  param anEntry

  type anEntry

  TCollection_AsciiString

  rtype

  void

static ExtendedDeepDump()

• Dumps <aDF> and its labels and their attributes, if their IDs are kept by <aFilter>. Dumps also the attributes content.

  param anOS

  type anOS

  Standard_OStream

  param aDF

  type aDF

  TDF_Data

  param aFilter

  type aFilter

  TDF_IDFilter

  rtype

  void* Dumps <aLabel>, its chilren and their attributes, if their IDs are kept by <aFilter>. Dumps also the attributes content.

  param anOS

  type anOS

  Standard_OStream

  param aLabel

  type aLabel

  TDF_Label

  param aFilter

  type aFilter

  TDF_IDFilter

  rtype

  void

static IsSelfContained()

• Returns true if <aLabel> and its descendants reference only attributes or labels attached to themselves.

  param aLabel

  type aLabel

  TDF_Label

  rtype

  bool* Returns true if <aLabel> and its descendants reference only attributes or labels attached to themselves and kept by <aFilter>.

  param aLabel

  type aLabel

  TDF_Label

  param aFilter

  type aFilter

  TDF_IDFilter

  rtype

  bool

static Label()

• Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.

  param aDF

  type aDF

  TDF_Data

  param anEntry

  type anEntry

  TCollection_AsciiString

  param aLabel

  type aLabel

  TDF_Label

  param create

  default value is Standard_False

  type create

  bool

  rtype

  void* Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.

  param aDF

  type aDF

  TDF_Data

  param anEntry

  type anEntry

  char *

  param aLabel

  type aLabel

  TDF_Label

  param create

  default value is Standard_False

  type create

  bool

  rtype

  void* Returns the label expressed by <anEntry>; creates the label if it does not exist and if <create> is true.

  param aDF

  type aDF

  TDF_Data

  param aTagList

  type aTagList

  TColStd_ListOfInteger

  param aLabel

  type aLabel

  TDF_Label

  param create

  default value is Standard_False

  type create

  bool

  rtype

  void

static NbAttributes()

• 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.

  param aLabel

  type aLabel

  TDF_Label

  rtype

  int* Returns the number of attributes of the tree, selected by a<Filter>, including those of <aLabel>.

  param aLabel

  type aLabel

  TDF_Label

  param aFilter

  type aFilter

  TDF_IDFilter

  rtype

  int

static NbLabels()

• 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.

  param aLabel

  type aLabel

  TDF_Label

  rtype

  int

static OutReferences()

• Returns in <atts> the referenced attributes. Caution: <atts> is not cleared before use!

  param aLabel

  type aLabel

  TDF_Label

  param atts

  type atts

  TDF_AttributeMap

  rtype

  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!

  param aLabel

  type aLabel

  TDF_Label

  param aFilterForReferers

  type aFilterForReferers

  TDF_IDFilter

  param aFilterForReferences

  type aFilterForReferences

  TDF_IDFilter

  param atts

  type atts

  TDF_AttributeMap

  rtype

  void

static OutReferers()

• Returns in <theAtts> the attributes having out references. //! Caution: <theAtts> is not cleared before use!

  param theLabel

  type theLabel

  TDF_Label

  param theAtts

  type theAtts

  TDF_AttributeMap

  rtype

  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!

  param aLabel

  type aLabel

  TDF_Label

  param aFilterForReferers

  type aFilterForReferers

  TDF_IDFilter

  param aFilterForReferences

  type aFilterForReferences

  TDF_IDFilter

  param atts

  type atts

  TDF_AttributeMap

  rtype

  void

static RelocateLabel()

• 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

  param aSourceLabel

  type aSourceLabel

  TDF_Label

  param fromRoot

  type fromRoot

  TDF_Label

  param toRoot

  type toRoot

  TDF_Label

  param aTargetLabel

  type aTargetLabel

  TDF_Label

  param create

  default value is Standard_False

  type create

  bool

  rtype

  void

static TagList()

• Returns the entry of <aLabel> as list of integers in <aTagList>.

  param aLabel

  type aLabel

  TDF_Label

  param aTagList

  type aTagList

  TColStd_ListOfInteger

  rtype

  void* Returns the entry expressed by <anEntry> as list of integers in <aTagList>.

  param anEntry

  type anEntry

  TCollection_AsciiString

  param aTagList

  type aTagList

  TColStd_ListOfInteger

  rtype

  void

property thisown

The membership flag

class TDF_Transaction(*args)

Bases: object

• Creates an empty transaction context, unable to be opened.

  param aName

  default value is

  type aName

  TCollection_AsciiString

  rtype

  None* Creates a transaction context on <aDF>, ready to be opened.

  param aDF

  type aDF

  TDF_Data

  param aName

  default value is

  type aName

  TCollection_AsciiString

  rtype

  None

Abort()

• Aborts the transactions until AND including the current opened one.

  rtype

  None

Commit()

• Commits the transactions until AND including the current opened one.

  param withDelta

  default value is Standard_False

  type withDelta

  bool

  rtype

  opencascade::handle<TDF_Delta>

Data()

• Returns the Data from TDF.

  rtype

  opencascade::handle<TDF_Data>

Initialize()

• Aborts all the transactions on <myDF> and sets <aDF> to build a transaction context on <aDF>, ready to be opened.

  param aDF

  type aDF

  TDF_Data

  rtype

  None

IsOpen()

• Returns true if the transaction is open.

  rtype

  bool

Name()

• Returns the transaction name.

  rtype

  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.

  rtype

  int

Transaction()

• Returns the number of the transaction opened by <self>.

  rtype

  int

property thisown

The membership flag

class tdf

Bases: object

static AddLinkGUIDToProgID()

• Sets link between GUID and ProgID in hidden DataMap

  param ID

  type ID

  Standard_GUID

  param ProgID

  type ProgID

  TCollection_ExtendedString

  rtype

  void

static GUIDFromProgID()

• Returns True if there is GUID for given <ProgID> then GUID is returned in <ID>

  param ProgID

  type ProgID

  TCollection_ExtendedString

  param ID

  type ID

  Standard_GUID

  rtype

  bool

static LowestID()

• Returns ID ‘00000000-0000-0000-0000-000000000000’, sometimes used as null ID.

  rtype

  Standard_GUID

static ProgIDFromGUID()

• Returns True if there is ProgID for given <ID> then ProgID is returned in <ProgID>

  param ID

  type ID

  Standard_GUID

  param ProgID

  type ProgID

  TCollection_ExtendedString

  rtype

  bool

static UppestID()

• Returns ID ‘ffffffff-ffff-ffff-ffff-ffffffffffff’.

  rtype

  Standard_GUID

property thisown

The membership flag