TBTK
Public Member Functions | Friends | List of all members
TBTK::IndexTree::Iterator Class Reference

#include <IndexTree.h>

Public Member Functions

void reset ()
 
void searchNext ()
 
const Index getIndex () const
 
bool getHasReachedEnd () const
 

Friends

class IndexTree
 

Detailed Description

Iterator for iterating through Indices stored in the tree structure.

Member Function Documentation

bool TBTK::IndexTree::Iterator::getHasReachedEnd ( ) const
inline

Returns true if the iterator has reached the end.

const Index TBTK::IndexTree::Iterator::getIndex ( ) const

Get Index currently pointed at.

void TBTK::IndexTree::Iterator::reset ( )

Reset iterator.

void TBTK::IndexTree::Iterator::searchNext ( )

Advance the iterator by one.

Friends And Related Function Documentation

friend class IndexTree
friend

Allow IndexTree to construct Iterator.

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