# ApplicationFramework
TKLCAF
TDF

# TDF_RelocationTable Class Reference

This is a relocation dictionnary between source
and target labels, attributes or any
transient. Note that one target value may be the
relocation value of more than one source object.
Common behaviour: it returns true and the found
relocation value as target object; false
otherwise.
Look at SelfRelocate method for more explanation
about self relocation behavior of this class.
.

`#include <TDF_RelocationTable.hxx>`

## Public Member Functions

Standard_EXPORT | TDF_RelocationTable (const Standard_Boolean selfRelocate=Standard_False)
| Creates an relocation table. <selfrelocate> says if a value without explicit relocation is its own relocation. .
Standard_EXPORT void | SelfRelocate (const Standard_Boolean 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. .
Standard_EXPORT Standard_Boolean | SelfRelocate () const
| Returns <myselfrelocate>. .
Standard_EXPORT void | AfterRelocate (const Standard_Boolean afterRelocate)
Standard_EXPORT Standard_Boolean | AfterRelocate () const
| Returns <myafterrelocate>. .
Standard_EXPORT void | SetRelocation (const TDF_Label &aSourceLabel, const TDF_Label &aTargetLabel)
| Sets the relocation value of <asourcelabel> to <atargetlabel>. .
Standard_EXPORT Standard_Boolean | HasRelocation (const TDF_Label &aSourceLabel, TDF_Label &aTargetLabel) const
| Finds the relocation value of <asourcelabel> and returns it into <atargetlabel>. (See above SelfRelocate method for more explanation about the method behavior) .
Standard_EXPORT void | SetRelocation (const Handle(TDF_Attribute)&aSourceAttribute, const Handle(TDF_Attribute)&aTargetAttribute)
| Sets the relocation value of <asourceattribute> to <atargetattribute>. .
Standard_EXPORT Standard_Boolean | HasRelocation (const Handle(TDF_Attribute)&aSourceAttribute, Handle(TDF_Attribute)&aTargetAttribute) const
| Finds the relocation value of <asourceattribute> and returns it into <atargetattribute>. (See above SelfRelocate method for more explanation about the method behavior) .
Standard_EXPORT void | SetTransientRelocation (const Handle(Standard_Transient)&aSourceTransient, const Handle(Standard_Transient)&aTargetTransient)
| Sets the relocation value of <asourcetransient> to <atargettransient>. .
Standard_EXPORT Standard_Boolean | HasTransientRelocation (const Handle(Standard_Transient)&aSourceTransient, Handle(Standard_Transient)&aTargetTransient) const
| Finds the relocation value of <asourcetransient> and returns it into <atargettransient>. (See above SelfRelocate method for more explanation about the method behavior) .
Standard_EXPORT void | Clear ()
| Clears the relocation dictionnary, but lets the self relocation flag to its current value. .
Standard_EXPORT void | TargetLabelMap (TDF_LabelMap &aLabelMap) const
| Fills <alabelmap> with target relocation labels. <alabelmap> is not cleared before use. .
Standard_EXPORT void | TargetAttributeMap (TDF_AttributeMap &anAttributeMap) const
| Fills <anattributemap> with target relocation attributes. <anattributemap> is not cleared before use. .
Standard_EXPORT TDF_LabelDataMap & | LabelTable ()
| Returns <mylabeltable> to be used or updated. .
Standard_EXPORT TDF_AttributeDataMap & | AttributeTable ()
| Returns <myattributetable> to be used or updated. .
Standard_EXPORT TColStd_IndexedDataMapOfTransientTransient & | TransientTable ()
| Returns <mytransienttable> to be used or updated. .
Standard_EXPORT Standard_OStream & | Dump (const Standard_Boolean dumpLabels, const Standard_Boolean dumpAttributes, const Standard_Boolean dumpTransients, Standard_OStream &anOS) const
| Dumps the relocation table. .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Attributes

Standard_Boolean | mySelfRelocate
Standard_Boolean | myAfterRelocate
TDF_LabelDataMap | myLabelTable
TDF_AttributeDataMap | myAttributeTable
TColStd_IndexedDataMapOfTransientTransient | myTransientTable

## Constructor & Destructor Documentation

Standard_EXPORT TDF_RelocationTable::TDF_RelocationTable | ( | const Standard_Boolean | selfRelocate = `Standard_False` | ) |

## Member Function Documentation

Standard_EXPORT Standard_Boolean TDF_RelocationTable::AfterRelocate | ( |  | ) | const

Standard_EXPORT void TDF_RelocationTable::AfterRelocate | ( | const Standard_Boolean | afterRelocate | ) |

Standard_EXPORT TDF_AttributeDataMap& TDF_RelocationTable::AttributeTable | ( |  | ) |

Standard_EXPORT void TDF_RelocationTable::Clear | ( |  | ) |

Standard_EXPORT Standard_OStream& TDF_RelocationTable::Dump | ( | const Standard_Boolean | dumpLabels,
|  | const Standard_Boolean | dumpAttributes,
|  | const Standard_Boolean | dumpTransients,
|  | Standard_OStream & | anOS
| ) | const

Standard_EXPORT const TDF_RelocationTable::Handle | ( | Standard_Type |  | ) | const

Standard_EXPORT Standard_Boolean TDF_RelocationTable::HasRelocation | ( | const Handle(TDF_Attribute)& | aSourceAttribute,
|  | Handle(TDF_Attribute)& | aTargetAttribute
| ) | const

Standard_EXPORT Standard_Boolean TDF_RelocationTable::HasRelocation | ( | const TDF_Label & | aSourceLabel,
|  | TDF_Label & | aTargetLabel
| ) | const

Standard_EXPORT Standard_Boolean TDF_RelocationTable::HasTransientRelocation | ( | const Handle(Standard_Transient)& | aSourceTransient,
|  | Handle(Standard_Transient)& | aTargetTransient
| ) | const

Standard_EXPORT TDF_LabelDataMap& TDF_RelocationTable::LabelTable | ( |  | ) |

Standard_EXPORT Standard_Boolean TDF_RelocationTable::SelfRelocate | ( |  | ) | const

Standard_EXPORT void TDF_RelocationTable::SelfRelocate | ( | const Standard_Boolean | selfRelocate | ) |

Standard_EXPORT void TDF_RelocationTable::SetRelocation | ( | const Handle(TDF_Attribute)& | aSourceAttribute,
|  | const Handle(TDF_Attribute)& | aTargetAttribute
| ) |

Standard_EXPORT void TDF_RelocationTable::SetRelocation | ( | const TDF_Label & | aSourceLabel,
|  | const TDF_Label & | aTargetLabel
| ) |

Standard_EXPORT void TDF_RelocationTable::SetTransientRelocation | ( | const Handle(Standard_Transient)& | aSourceTransient,
|  | const Handle(Standard_Transient)& | aTargetTransient
| ) |

Standard_EXPORT void TDF_RelocationTable::TargetAttributeMap | ( | TDF_AttributeMap & | anAttributeMap | ) | const

Standard_EXPORT void TDF_RelocationTable::TargetLabelMap | ( | TDF_LabelMap & | aLabelMap | ) | const

Standard_EXPORT TColStd_IndexedDataMapOfTransientTransient& TDF_RelocationTable::TransientTable | ( |  | ) |

## Field Documentation

Standard_Boolean TDF_RelocationTable::myAfterRelocate`[private]`

TDF_AttributeDataMap TDF_RelocationTable::myAttributeTable`[private]`

TDF_LabelDataMap TDF_RelocationTable::myLabelTable`[private]`

Standard_Boolean TDF_RelocationTable::mySelfRelocate`[private]`

TColStd_IndexedDataMapOfTransientTransient TDF_RelocationTable::myTransientTable`[private]`

The documentation for this class was generated from the following file:

- TDF_RelocationTable.hxx