HashTable::iterator Class Reference

An STL-conforming iterator. More...

Inheritance diagram for HashTable::iterator:

Collaboration diagram for HashTable::iterator:

Public Member Functions
	iterator ()
	Construct null (end iterator) More...
	iterator (const iteratorEnd &unused)
	Construct end iterator. More...
T &	operator* ()
	Return referenced hash value. More...
T &	operator() ()
const T &	operator* () const
	Return referenced hash value. More...
const T &	operator() () const
iterator &	operator++ ()
iterator	operator++ (int)
Public Member Functions inherited from HashTable::iteratorBase
const Key &	key () const
	Return the Key corresponding to the iterator. More...
bool	operator== (const iteratorBase &) const
	Compare hashedEntry element pointers. More...
bool	operator!= (const iteratorBase &) const
bool	operator== (const iteratorEnd &unused) const
	Compare hashedEntry to iteratorEnd pointers. More...
bool	operator!= (const iteratorEnd &unused) const

Private Member Functions
	iterator (HashTable< T, Key, Hash > *curHashTable)
	Construct from hash table, moving to its 'begin' position. More...
	iterator (HashTable< T, Key, Hash > *curHashTable, hashedEntry *elmt, const label hashIndex)
	Construct from hash table, element and hash index. More...

Friends
class	HashTable

Additional Inherited Members
Protected Member Functions inherited from HashTable::iteratorBase
	iteratorBase ()
	Construct null - equivalent to an 'end' position. More...
	iteratorBase (const HashTable< T, Key, Hash > *curHashTable)
	Construct from hash table, moving to its 'begin' position. More...
	iteratorBase (const HashTable< T, Key, Hash > *curHashTable, const hashedEntry *elmt, const label hashIndex)
	Construct from hash table, element and hash index. More...
void	increment ()
	Increment to the next position. More...
bool	erase ()
	Erase the HashTable element at the current position. More...
T &	object ()
	Return non-const access to referenced object. More...
const T &	cobject () const
	Return const access to referenced object. More...

Detailed Description

An STL-conforming iterator.

Definition at line 415 of file HashTable.H.

Constructor & Destructor Documentation

iterator() [1/4]

iterator ( HashTable< T, Key, Hash > *  curHashTable )

inlineexplicitprivate

Construct from hash table, moving to its 'begin' position.

iterator() [2/4]

iterator ( HashTable< T, Key, Hash > *  curHashTable, hashedEntry *  elmt, const label  hashIndex  )

inlineprivate

Construct from hash table, element and hash index.

iterator() [3/4]

iterator ( )

inline

Construct null (end iterator)

Definition at line 325 of file HashTableI.H.

iterator() [4/4]

iterator ( const iteratorEnd &  unused )

inline

Construct end iterator.

Member Function Documentation

operator*() [1/2]

T & operator* ( )

inline

Return referenced hash value.

Definition at line 365 of file HashTableI.H.

operator()() [1/2]

T & operator() ( )

inline

Definition at line 373 of file HashTableI.H.

operator*() [2/2]

const T & operator* ( ) const

inline

Return referenced hash value.

Definition at line 381 of file HashTableI.H.

operator()() [2/2]

const T & operator() ( ) const

inline

Definition at line 389 of file HashTableI.H.

operator++() [1/2]

Foam::HashTable< T, Key, Hash >::iterator & operator++ ( )

inline

Definition at line 398 of file HashTableI.H.

operator++() [2/2]

Foam::HashTable< T, Key, Hash >::iterator operator++ ( int  )

inline

Definition at line 407 of file HashTableI.H.

Friends And Related Function Documentation

HashTable

friend class HashTable

friend

Definition at line 419 of file HashTable.H.

---

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

• src/OpenFOAM/containers/HashTables/HashTable/HashTable.H
• src/OpenFOAM/containers/HashTables/HashTable/HashTableI.H