HashTable< T, Key, Hash >::iterator Class Reference

An STL-conforming iterator. More...

Inheritance diagram for HashTable< T, Key, Hash >::iterator:

Collaboration diagram for HashTable< T, Key, Hash >::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< T, Key, Hash >::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

Friends
class	HashTable

Additional Inherited Members
Protected Member Functions inherited from HashTable< T, Key, Hash >::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

template<class T, class Key = word, class Hash = string::hash>
class Foam::HashTable< T, Key, Hash >::iterator

An STL-conforming iterator.

Definition at line 426 of file HashTable.H.

Constructor & Destructor Documentation

iterator() [1/2]

iterator ( )

inline

Construct null (end iterator)

Definition at line 319 of file HashTableI.H.

Referenced by HashTable< Foam::phase *>::begin(), and HashTable< T, Key, Hash >::iterator::iterator().

Here is the caller graph for this function:

iterator() [2/2]

iterator ( const iteratorEnd &  unused )

inline

Construct end iterator.

Definition at line 327 of file HashTableI.H.

References HashTable< T, Key, Hash >::iterator::iterator(), HashTable< T, Key, Hash >::iteratorBase::iteratorBase(), and Foam::T().

Here is the call graph for this function:

Member Function Documentation

operator*() [1/2]

T & operator* ( )

inline

Return referenced hash value.

Definition at line 359 of file HashTableI.H.

References HashTable< T, Key, Hash >::iteratorBase::object(), and Foam::T().

Here is the call graph for this function:

operator()() [1/2]

T & operator() ( )

inline

Definition at line 367 of file HashTableI.H.

References HashTable< T, Key, Hash >::iteratorBase::object(), and Foam::T().

Here is the call graph for this function:

operator*() [2/2]

const T & operator* ( ) const

inline

Return referenced hash value.

Definition at line 375 of file HashTableI.H.

References HashTable< T, Key, Hash >::iteratorBase::cobject(), and Foam::T().

Here is the call graph for this function:

operator()() [2/2]

const T & operator() ( ) const

inline

Definition at line 383 of file HashTableI.H.

References HashTable< T, Key, Hash >::iteratorBase::cobject().

Here is the call graph for this function:

operator++() [1/2]

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

inline

Definition at line 392 of file HashTableI.H.

References HashTable< T, Key, Hash >::iteratorBase::increment().

Here is the call graph for this function:

operator++() [2/2]

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

inline

Definition at line 401 of file HashTableI.H.

References HashTable< T, Key, Hash >::iteratorBase::increment().

Here is the call graph for this function:

Friends And Related Function Documentation

HashTable

friend class HashTable

friend

Definition at line 430 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