Open CASCADE Technology  7.7.0
Data Structures | Public Member Functions
XCAFDoc_AssemblyIterator Class Reference

Iterator in depth along the assembly tree. More...

#include <XCAFDoc_AssemblyIterator.hxx>

Public Member Functions

 XCAFDoc_AssemblyIterator (const Handle< TDocStd_Document > &theDoc, const Standard_Integer theLevel=INT_MAX)
 Constructs iterator starting from assembly roots. More...
 
 XCAFDoc_AssemblyIterator (const Handle< TDocStd_Document > &theDoc, const XCAFDoc_AssemblyItemId &theRoot, const Standard_Integer theLevel=INT_MAX)
 Constructs iterator starting from the specified position in the assembly tree. More...
 
Standard_Boolean More () const
 
void Next ()
 Moves depth-first iterator to the next position. More...
 
XCAFDoc_AssemblyItemId Current () const
 

Detailed Description

Iterator in depth along the assembly tree.

Constructor & Destructor Documentation

◆ XCAFDoc_AssemblyIterator() [1/2]

XCAFDoc_AssemblyIterator::XCAFDoc_AssemblyIterator ( const Handle< TDocStd_Document > &  theDoc,
const Standard_Integer  theLevel = INT_MAX 
)

Constructs iterator starting from assembly roots.

Parameters
[in]theDoc- document to iterate.
[in,opt]theLevel - max level of hierarchy to reach (INT_MAX is for no limit).

◆ XCAFDoc_AssemblyIterator() [2/2]

XCAFDoc_AssemblyIterator::XCAFDoc_AssemblyIterator ( const Handle< TDocStd_Document > &  theDoc,
const XCAFDoc_AssemblyItemId theRoot,
const Standard_Integer  theLevel = INT_MAX 
)

Constructs iterator starting from the specified position in the assembly tree.

Parameters
[in]theDoc- document to iterate.
[in]theRoot- assembly item to start iterating from.
[in,opt]theLevel - max level of hierarchy to reach (INT_MAX is for no limit).

Member Function Documentation

◆ Current()

XCAFDoc_AssemblyItemId XCAFDoc_AssemblyIterator::Current ( ) const
Returns
current item.

◆ More()

Standard_Boolean XCAFDoc_AssemblyIterator::More ( ) const
Returns
true if there is still something to iterate, false – otherwise.

◆ Next()

void XCAFDoc_AssemblyIterator::Next ( )

Moves depth-first iterator to the next position.


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