HashTable::const_iterator Class Reference

An STL-conforming const_iterator. More...

Inheritance diagram for HashTable::const_iterator:

Collaboration diagram for HashTable::const_iterator:

Public Member Functions
	const_iterator ()
	Construct null (end iterator) More...
	const_iterator (const iterator &)
	Construct from iterator. More...
	const_iterator (const iteratorEnd &unused)
	Construct end iterator. More...
const T &	operator* () const
	Return referenced hash value. More...
const T &	operator() () const
const_iterator &	operator++ ()
const_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
	const_iterator (const HashTable< T, Key, Hash > *curHashTable)
	Construct from hash table, moving to its 'begin' position. More...
	const_iterator (const HashTable< T, Key, Hash > *curHashTable, const 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 const_iterator.

Definition at line 470 of file HashTable.H.

Constructor & Destructor Documentation

const_iterator() [1/5]

const_iterator ( const HashTable< T, Key, Hash > *  curHashTable )

inlineexplicitprivate

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

const_iterator() [2/5]

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

inlineprivate

Construct from hash table, element and hash index.

const_iterator() [3/5]

const_iterator ( )

inline

Construct null (end iterator)

Definition at line 426 of file HashTableI.H.

const_iterator() [4/5]

const_iterator ( const iterator &  )

inline

Construct from iterator.

const_iterator() [5/5]

const_iterator ( const iteratorEnd &  unused )

inline

Construct end iterator.

Member Function Documentation

operator*()

const T & operator* ( ) const

inline

Return referenced hash value.

Definition at line 476 of file HashTableI.H.

operator()()

const T & operator() ( ) const

inline

Definition at line 484 of file HashTableI.H.

operator++() [1/2]

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

inline

Definition at line 493 of file HashTableI.H.

operator++() [2/2]

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

inline

Definition at line 502 of file HashTableI.H.

Friends And Related Function Documentation

HashTable

friend class HashTable

friend

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