Open CASCADE Technology  6.9.0
Public Member Functions

TDataStd_ChildNodeIterator Class Reference

Iterates on the ChildStepren step of a step, at the first level only. It is possible to ask the iterator to explore all the sub step levels of the given one, with the option "allLevels". More...

#include <TDataStd_ChildNodeIterator.hxx>

Public Member Functions

 TDataStd_ChildNodeIterator ()
 Creates an empty iterator. More...
 
 TDataStd_ChildNodeIterator (const Handle< TDataStd_TreeNode > &aTreeNode, const Standard_Boolean allLevels=Standard_False)
 Iterates on the ChildStepren of the given Step. If <allLevels> option is set to true, it explores not only the first, but all the sub Step levels. More...
 
void Initialize (const Handle< TDataStd_TreeNode > &aTreeNode, const Standard_Boolean allLevels=Standard_False)
 Initializes the iteration on the Children Step of the given Step. If <allLevels> option is set to true, it explores not only the first, but all the sub Step 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 Step ChildStepren. More...
 
const Handle< TDataStd_TreeNode > & Value () const
 Returns the current item; a null Step if there is no one. More...
 

Detailed Description

Iterates on the ChildStepren step of a step, at the first level only. It is possible to ask the iterator to explore all the sub step levels of the given one, with the option "allLevels".

Constructor & Destructor Documentation

TDataStd_ChildNodeIterator::TDataStd_ChildNodeIterator ( )

Creates an empty iterator.

TDataStd_ChildNodeIterator::TDataStd_ChildNodeIterator ( const Handle< TDataStd_TreeNode > &  aTreeNode,
const Standard_Boolean  allLevels = Standard_False 
)

Iterates on the ChildStepren of the given Step. If <allLevels> option is set to true, it explores not only the first, but all the sub Step levels.

Member Function Documentation

void TDataStd_ChildNodeIterator::Initialize ( const Handle< TDataStd_TreeNode > &  aTreeNode,
const Standard_Boolean  allLevels = Standard_False 
)

Initializes the iteration on the Children Step of the given Step. If <allLevels> option is set to true, it explores not only the first, but all the sub Step levels.

Standard_Boolean TDataStd_ChildNodeIterator::More ( ) const

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

void TDataStd_ChildNodeIterator::Next ( )

Move to the next Item.

void TDataStd_ChildNodeIterator::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 Step ChildStepren.

const Handle< TDataStd_TreeNode >& TDataStd_ChildNodeIterator::Value ( ) const

Returns the current item; a null Step if there is no one.


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