StaticHashTable::Iterator< TRef, TableRef > Class Template Reference

An STL iterator. More...

Inheritance diagram for StaticHashTable::Iterator< TRef, TableRef >:

Public Member Functions
	Iterator (TableRef, label hashIndex_, label elemIndex_)
	Construct from hash table, hash index and element index. More...
	Iterator (const iterator &)
	Construct from the non-const iterator. More...
void	operator= (const iterator &)
bool	operator== (const iterator &) const
bool	operator== (const const_iterator &) const
bool	operator!= (const iterator &) const
bool	operator!= (const const_iterator &) const
TRef	operator* ()
TRef	operator() ()
Iterator &	operator++ ()
Iterator	operator++ (int)
const Key &	key () const

Private Attributes
TableRef	hashTable_
	Reference to the StaticHashTable this is an iterator for. More...
label	hashIndex_
	Current hash index. More...
label	elemIndex_
	Index of current element at hashIndex. More...

Friends
class	StaticHashTable
template<class TRef2 , class TableRef2 >
class	Iterator

Detailed Description

template<class TRef, class TableRef>
class Foam::StaticHashTable::Iterator< TRef, TableRef >

An STL iterator.

Definition at line 138 of file StaticHashTable.H.

Constructor & Destructor Documentation

Iterator() [1/2]

Iterator ( TableRef  hashTbl, label  hashIndex_, label  elemIndex_  )

inline

Construct from hash table, hash index and element index.

Definition at line 147 of file StaticHashTableI.H.

Iterator() [2/2]

Iterator ( const iterator &  iter )

inline

Construct from the non-const iterator.

Definition at line 162 of file StaticHashTableI.H.

Member Function Documentation

operator=()

void operator= ( const iterator &  iter )

inline

Definition at line 176 of file StaticHashTableI.H.

operator==() [1/2]

bool operator== ( const iterator &  iter ) const

inline

Definition at line 189 of file StaticHashTableI.H.

operator==() [2/2]

bool operator== ( const const_iterator &  iter ) const

inline

Definition at line 201 of file StaticHashTableI.H.

operator!=() [1/2]

bool operator!= ( const iterator &  iter ) const

inline

Definition at line 213 of file StaticHashTableI.H.

operator!=() [2/2]

bool operator!= ( const const_iterator &  iter ) const

inline

Definition at line 225 of file StaticHashTableI.H.

operator*()

TRef operator*

inline

Definition at line 236 of file StaticHashTableI.H.

operator()()

TRef operator()

inline

Definition at line 245 of file StaticHashTableI.H.

operator++() [1/2]

Foam::StaticHashTable< T, Key, Hash >::template Iterator< TRef, TableRef > & operator++

inline

Definition at line 263 of file StaticHashTableI.H.

operator++() [2/2]

Foam::StaticHashTable< T, Key, Hash >::template Iterator< TRef, TableRef > operator++ ( int  )

inline

Definition at line 316 of file StaticHashTableI.H.

key()

const Key & key

inline

Definition at line 329 of file StaticHashTableI.H.

Friends And Related Function Documentation

StaticHashTable

friend class StaticHashTable

friend

Definition at line 297 of file StaticHashTable.H.

Iterator

friend class Iterator

friend

Definition at line 300 of file StaticHashTable.H.

Field Documentation

hashTable_

TableRef hashTable_

private

Reference to the StaticHashTable this is an iterator for.

Definition at line 305 of file StaticHashTable.H.

hashIndex_

label hashIndex_

private

Current hash index.

Definition at line 308 of file StaticHashTable.H.

Referenced by StaticHashTable::Iterator< T &, StaticHashTable< T, Key, Hash > & >::operator=(), and StaticHashTable::Iterator< T &, StaticHashTable< T, Key, Hash > & >::operator==().

elemIndex_

label elemIndex_

private

Index of current element at hashIndex.

Definition at line 311 of file StaticHashTable.H.

Referenced by StaticHashTable::Iterator< T &, StaticHashTable< T, Key, Hash > & >::operator=(), and StaticHashTable::Iterator< T &, StaticHashTable< T, Key, Hash > & >::operator==().

---

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

• src/OpenFOAM/containers/HashTables/StaticHashTable/StaticHashTable.H
• src/OpenFOAM/containers/HashTables/StaticHashTable/StaticHashTableI.H