Open CASCADE Technology 6.6.0
Public Member Functions
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>

Inheritance diagram for TDF_RelocationTable:
Inheritance graph
[legend]

Public Member Functions

 TDF_RelocationTable (const Standard_Boolean selfRelocate=Standard_False)
 Creates an relocation table. <selfRelocate> says
if a value without explicit relocation is its own
relocation.

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_Boolean SelfRelocate () const
 Returns <mySelfRelocate>.

void AfterRelocate (const Standard_Boolean afterRelocate)
Standard_Boolean AfterRelocate () const
 Returns <myAfterRelocate>.

void SetRelocation (const TDF_Label &aSourceLabel, const TDF_Label &aTargetLabel)
 Sets the relocation value of <aSourceLabel> to
<aTargetLabel>.

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)

void SetRelocation (const Handle< TDF_Attribute > &aSourceAttribute, const Handle< TDF_Attribute > &aTargetAttribute)
 Sets the relocation value of <aSourceAttribute> to
<aTargetAttribute>.

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)

void SetTransientRelocation (const Handle< Standard_Transient > &aSourceTransient, const Handle< Standard_Transient > &aTargetTransient)
 Sets the relocation value of <aSourceTransient> to
<aTargetTransient>.

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)

void Clear ()
 Clears the relocation dictionnary, but lets the
self relocation flag to its current value.

void TargetLabelMap (TDF_LabelMap &aLabelMap) const
 Fills <aLabelMap> with target relocation
labels. <aLabelMap> is not cleared before use.

void TargetAttributeMap (TDF_AttributeMap &anAttributeMap) const
 Fills <anAttributeMap> with target relocation
attributes. <anAttributeMap> is not cleared before
use.

TDF_LabelDataMapLabelTable ()
 Returns <myLabelTable> to be used or updated.


TDF_AttributeDataMapAttributeTable ()
 Returns <myAttributeTable> to be used or updated.


TColStd_IndexedDataMapOfTransientTransientTransientTable ()
 Returns <myTransientTable> to be used or updated.


Standard_OStreamDump (const Standard_Boolean dumpLabels, const Standard_Boolean dumpAttributes, const Standard_Boolean dumpTransients, Standard_OStream &anOS) const
 Dumps the relocation table.



Constructor & Destructor Documentation

TDF_RelocationTable::TDF_RelocationTable ( const Standard_Boolean  selfRelocate = Standard_False)

Member Function Documentation

void TDF_RelocationTable::AfterRelocate ( const Standard_Boolean  afterRelocate)
Standard_Boolean TDF_RelocationTable::AfterRelocate ( ) const
TDF_AttributeDataMap& TDF_RelocationTable::AttributeTable ( )
void TDF_RelocationTable::Clear ( )
Standard_OStream& TDF_RelocationTable::Dump ( const Standard_Boolean  dumpLabels,
const Standard_Boolean  dumpAttributes,
const Standard_Boolean  dumpTransients,
Standard_OStream anOS 
) const
Standard_Boolean TDF_RelocationTable::HasRelocation ( const Handle< TDF_Attribute > &  aSourceAttribute,
Handle< TDF_Attribute > &  aTargetAttribute 
) const
Standard_Boolean TDF_RelocationTable::HasRelocation ( const TDF_Label aSourceLabel,
TDF_Label aTargetLabel 
) const
Standard_Boolean TDF_RelocationTable::HasTransientRelocation ( const Handle< Standard_Transient > &  aSourceTransient,
Handle< Standard_Transient > &  aTargetTransient 
) const
TDF_LabelDataMap& TDF_RelocationTable::LabelTable ( )
Standard_Boolean TDF_RelocationTable::SelfRelocate ( ) const
void TDF_RelocationTable::SelfRelocate ( const Standard_Boolean  selfRelocate)
void TDF_RelocationTable::SetRelocation ( const Handle< TDF_Attribute > &  aSourceAttribute,
const Handle< TDF_Attribute > &  aTargetAttribute 
)
void TDF_RelocationTable::SetRelocation ( const TDF_Label aSourceLabel,
const TDF_Label aTargetLabel 
)
void TDF_RelocationTable::SetTransientRelocation ( const Handle< Standard_Transient > &  aSourceTransient,
const Handle< Standard_Transient > &  aTargetTransient 
)
void TDF_RelocationTable::TargetAttributeMap ( TDF_AttributeMap anAttributeMap) const
void TDF_RelocationTable::TargetLabelMap ( TDF_LabelMap aLabelMap) const
TColStd_IndexedDataMapOfTransientTransient& TDF_RelocationTable::TransientTable ( )

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines