# ApplicationFramework
TKLCAF
TDF

# TDF_Tool Class Reference

This class provides general services for a data framework.
.

`#include <TDF_Tool.hxx>`

## Public Member Functions

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)

## Static Public Member Functions

static Standard_EXPORT Standard_Integer | NbLabels (const TDF_Label &aLabel)
| 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. .
static Standard_EXPORT Standard_Integer | NbAttributes (const TDF_Label &aLabel)
| 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. .
static Standard_EXPORT Standard_Integer | NbAttributes (const TDF_Label &aLabel, const TDF_IDFilter &aFilter)
| Returns the number of attributes of the tree, selected by a<Filter>, including those of <alabel>. .
static Standard_EXPORT Standard_Boolean | IsSelfContained (const TDF_Label &aLabel)
| Returns true if <alabel> and its descendants reference only attributes or labels attached to themselves. .
static Standard_EXPORT Standard_Boolean | IsSelfContained (const TDF_Label &aLabel, const TDF_IDFilter &aFilter)
| Returns true if <alabel> and its descendants reference only attributes or labels attached to themselves and kept by <afilter>. .
static Standard_EXPORT void | OutReferers (const TDF_Label &theLabel, TDF_AttributeMap &theAtts)
| Returns in <theatts> the attributes having out references. Caution: <theatts> is not cleared before use! .
static Standard_EXPORT void | OutReferers (const TDF_Label &aLabel, const TDF_IDFilter &aFilterForReferers, const TDF_IDFilter &aFilterForReferences, TDF_AttributeMap &atts)
| 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! .
static Standard_EXPORT void | OutReferences (const TDF_Label &aLabel, TDF_AttributeMap &atts)
| Returns in <atts> the referenced attributes. Caution: <atts> is not cleared before use! .
static Standard_EXPORT void | OutReferences (const TDF_Label &aLabel, const TDF_IDFilter &aFilterForReferers, const TDF_IDFilter &aFilterForReferences, TDF_AttributeMap &atts)
| 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! .
static Standard_EXPORT void | RelocateLabel (const TDF_Label &aSourceLabel, const TDF_Label &fromRoot, const TDF_Label &toRoot, TDF_Label &aTargetLabel, const Standard_Boolean create=Standard_False)
| 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 .
static Standard_EXPORT void | Entry (const TDF_Label &aLabel, TCollection_AsciiString &anEntry)
| Returns the entry for the label aLabel in the form of the ASCII character string anEntry containing the tag list for aLabel. .
static Standard_EXPORT void | TagList (const TDF_Label &aLabel, TColStd_ListOfInteger &aTagList)
| Returns the entry of <alabel> as list of integers in <ataglist>. .
static Standard_EXPORT void | TagList (const TCollection_AsciiString &anEntry, TColStd_ListOfInteger &aTagList)
| Returns the entry expressed by <anentry> as list of integers in <ataglist>. .
static Standard_EXPORT void | Label (const Handle(TDF_Data)&aDF, const TCollection_AsciiString &anEntry, TDF_Label &aLabel, const Standard_Boolean create=Standard_False)
| Returns the label expressed by <anentry>; creates the label if it does not exist and if <create> is true. .
static Standard_EXPORT void | Label (const Handle(TDF_Data)&aDF, const Standard_CString anEntry, TDF_Label &aLabel, const Standard_Boolean create=Standard_False)
| Returns the label expressed by <anentry>; creates the label if it does not exist and if <create> is true. .
static Standard_EXPORT void | Label (const Handle(TDF_Data)&aDF, const TColStd_ListOfInteger &aTagList, TDF_Label &aLabel, const Standard_Boolean create=Standard_False)
| Returns the label expressed by <anentry>; creates the label if it does not exist and if <create> is true. .
static Standard_EXPORT void | CountLabels (TDF_LabelList &aLabelList, TDF_LabelIntegerMap &aLabelMap)
| 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. .
static Standard_EXPORT void | DeductLabels (TDF_LabelList &aLabelList, TDF_LabelIntegerMap &aLabelMap)
| 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. .
static Standard_EXPORT void | DeepDump (Standard_OStream &anOS, const Handle(TDF_Data)&aDF)
| Dumps <adf> and its labels and their attributes. .
static Standard_EXPORT void | ExtendedDeepDump (Standard_OStream &anOS, const Handle(TDF_Data)&aDF, const TDF_IDFilter &aFilter)
| Dumps <adf> and its labels and their attributes, if their IDs are kept by <afilter>. Dumps also the attributes content. .
static Standard_EXPORT void | DeepDump (Standard_OStream &anOS, const TDF_Label &aLabel)
| Dumps <alabel>, its chilren and their attributes. .
static Standard_EXPORT void | ExtendedDeepDump (Standard_OStream &anOS, const TDF_Label &aLabel, const TDF_IDFilter &aFilter)
| Dumps <alabel>, its chilren and their attributes, if their IDs are kept by <afilter>. Dumps also the attributes content. .

## Member Function Documentation

static Standard_EXPORT void TDF_Tool::CountLabels | ( | TDF_LabelList & | aLabelList,
|  | TDF_LabelIntegerMap & | aLabelMap
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::DeductLabels | ( | TDF_LabelList & | aLabelList,
|  | TDF_LabelIntegerMap & | aLabelMap
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::DeepDump | ( | Standard_OStream & | anOS,
|  | const TDF_Label & | aLabel
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::DeepDump | ( | Standard_OStream & | anOS,
|  | const Handle(TDF_Data)& | aDF
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::Entry | ( | const TDF_Label & | aLabel,
|  | TCollection_AsciiString & | anEntry
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::ExtendedDeepDump | ( | Standard_OStream & | anOS,
|  | const TDF_Label & | aLabel,
|  | const TDF_IDFilter & | aFilter
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::ExtendedDeepDump | ( | Standard_OStream & | anOS,
|  | const Handle(TDF_Data)& | aDF,
|  | const TDF_IDFilter & | aFilter
| ) | `[static]`

static Standard_EXPORT Standard_Boolean TDF_Tool::IsSelfContained | ( | const TDF_Label & | aLabel,
|  | const TDF_IDFilter & | aFilter
| ) | `[static]`

static Standard_EXPORT Standard_Boolean TDF_Tool::IsSelfContained | ( | const TDF_Label & | aLabel | ) | `[static]`

static Standard_EXPORT void TDF_Tool::Label | ( | const Handle(TDF_Data)& | aDF,
|  | const TColStd_ListOfInteger & | aTagList,
|  | TDF_Label & | aLabel,
|  | const Standard_Boolean | create = `Standard_False`
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::Label | ( | const Handle(TDF_Data)& | aDF,
|  | const Standard_CString | anEntry,
|  | TDF_Label & | aLabel,
|  | const Standard_Boolean | create = `Standard_False`
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::Label | ( | const Handle(TDF_Data)& | aDF,
|  | const TCollection_AsciiString & | anEntry,
|  | TDF_Label & | aLabel,
|  | const Standard_Boolean | create = `Standard_False`
| ) | `[static]`

static Standard_EXPORT Standard_Integer TDF_Tool::NbAttributes | ( | const TDF_Label & | aLabel,
|  | const TDF_IDFilter & | aFilter
| ) | `[static]`

static Standard_EXPORT Standard_Integer TDF_Tool::NbAttributes | ( | const TDF_Label & | aLabel | ) | `[static]`

static Standard_EXPORT Standard_Integer TDF_Tool::NbLabels | ( | const TDF_Label & | aLabel | ) | `[static]`

void TDF_Tool::operator delete | ( | void * | anAddress | ) | `[inline]`

void* TDF_Tool::operator new | ( | size_t | size | ) | `[inline]`

void* TDF_Tool::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

static Standard_EXPORT void TDF_Tool::OutReferences | ( | const TDF_Label & | aLabel,
|  | const TDF_IDFilter & | aFilterForReferers,
|  | const TDF_IDFilter & | aFilterForReferences,
|  | TDF_AttributeMap & | atts
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::OutReferences | ( | const TDF_Label & | aLabel,
|  | TDF_AttributeMap & | atts
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::OutReferers | ( | const TDF_Label & | aLabel,
|  | const TDF_IDFilter & | aFilterForReferers,
|  | const TDF_IDFilter & | aFilterForReferences,
|  | TDF_AttributeMap & | atts
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::OutReferers | ( | const TDF_Label & | theLabel,
|  | TDF_AttributeMap & | theAtts
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::RelocateLabel | ( | const TDF_Label & | aSourceLabel,
|  | const TDF_Label & | fromRoot,
|  | const TDF_Label & | toRoot,
|  | TDF_Label & | aTargetLabel,
|  | const Standard_Boolean | create = `Standard_False`
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::TagList | ( | const TCollection_AsciiString & | anEntry,
|  | TColStd_ListOfInteger & | aTagList
| ) | `[static]`

static Standard_EXPORT void TDF_Tool::TagList | ( | const TDF_Label & | aLabel,
|  | TColStd_ListOfInteger & | aTagList
| ) | `[static]`

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

- TDF_Tool.hxx