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

An STL-conforming const_iterator. More...

Inheritance diagram for HashTable< T, Key, Hash >::const_iterator:
Collaboration diagram for HashTable< T, Key, Hash >::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 Toperator* () const
 Return referenced hash value. More...
 
const Toperator() () const
 
const_iteratoroperator++ ()
 
const_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...
 
Tobject ()
 Return non-const access to referenced object. More...
 
const Tcobject () 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 >::const_iterator

An STL-conforming const_iterator.

Definition at line 481 of file HashTable.H.

Constructor & Destructor Documentation

◆ const_iterator() [1/3]

const_iterator ( )
inline

Construct null (end iterator)

Definition at line 420 of file HashTableI.H.

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ const_iterator() [2/3]

const_iterator ( const iterator )
inline

Construct from iterator.

◆ const_iterator() [3/3]

const_iterator ( const iteratorEnd unused)
inline

Construct end iterator.

Definition at line 438 of file HashTableI.H.

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

Here is the call graph for this function:

Member Function Documentation

◆ operator*()

const T & operator* ( ) const
inline

Return referenced hash value.

Definition at line 470 of file HashTableI.H.

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

Here is the call graph for this function:

◆ operator()()

const T & operator() ( ) const
inline

Definition at line 478 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 >::const_iterator & operator++ ( )
inline

Definition at line 487 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 >::const_iterator operator++ ( int  )
inline

Definition at line 496 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 485 of file HashTable.H.


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