Open CASCADE Technology  7.5.0
Public Member Functions

TDF_ChildIDIterator Class Reference

Iterates on the children of a label, to find attributes having ID as Attribute ID. More...

#include <TDF_ChildIDIterator.hxx>

Public Member Functions

 TDF_ChildIDIterator ()
 Creates an empty iterator. More...
 
 TDF_ChildIDIterator (const TDF_Label &aLabel, const Standard_GUID &anID, const Standard_Boolean allLevels=Standard_False)
 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. More...
 
void Initialize (const TDF_Label &aLabel, const Standard_GUID &anID, const Standard_Boolean allLevels=Standard_False)
 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. More...
 
Standard_Boolean More () const
 Returns True if there is a current Item in the iteration. More...
 
void Next ()
 Move to the next Item. More...
 
void 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. More...
 
Handle< TDF_AttributeValue () const
 Returns the current item; a null handle if there is none. More...
 

Detailed Description

Iterates on the children of a label, to find attributes having ID as Attribute ID.

Level option works as TDF_ChildIterator.

Constructor & Destructor Documentation

◆ TDF_ChildIDIterator() [1/2]

TDF_ChildIDIterator::TDF_ChildIDIterator ( )

Creates an empty iterator.

◆ TDF_ChildIDIterator() [2/2]

TDF_ChildIDIterator::TDF_ChildIDIterator ( const TDF_Label aLabel,
const Standard_GUID anID,
const Standard_Boolean  allLevels = Standard_False 
)

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.

Member Function Documentation

◆ Initialize()

void TDF_ChildIDIterator::Initialize ( const TDF_Label aLabel,
const Standard_GUID anID,
const Standard_Boolean  allLevels = Standard_False 
)

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.

◆ More()

Standard_Boolean TDF_ChildIDIterator::More ( ) const

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

◆ Next()

void TDF_ChildIDIterator::Next ( )

Move to the next Item.

◆ NextBrother()

void TDF_ChildIDIterator::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.

◆ Value()

Handle< TDF_Attribute > TDF_ChildIDIterator::Value ( ) const

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


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