StaticHashTable< T, Key, Hash >::Iterator< TRef, TableRef > Class Template Reference

An STL iterator. More...

#include <src/OpenFOAM/containers/HashTables/StaticHashTable/StaticHashTable.H>

---

Detailed Description

template<class T, class Key = word, class Hash = string::hash>
template<class TRef, class TableRef>
class Foam::StaticHashTable< T, Key, Hash >::Iterator< TRef, TableRef >

An STL iterator.

Definition at line 273 of file StaticHashTable.H.

Inheritance diagram for StaticHashTable< T, Key, Hash >::Iterator< TRef, TableRef >:

Collaboration diagram for StaticHashTable< T, Key, Hash >::Iterator< TRef, TableRef >:

List of all members.

Public Member Functions
	Iterator (TableRef, label hashIndex_, label elemIndex_)
	Construct from hash table, hash index and element index.
	Iterator (const iterator &)
	Construct from the non-const iterator.
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
Friends
class	StaticHashTable
class	Iterator

---

Constructor & Destructor Documentation

Iterator	(	TableRef	hashTbl,
		label	hashIndex_,
		label	elemIndex_
	)		[inline]

Construct from hash table, hash index and element index.

Definition at line 151 of file StaticHashTableI.H.

Iterator

(

const iterator &

iter  )

[inline]

Construct from the non-const iterator.

Definition at line 166 of file StaticHashTableI.H.

---

Member Function Documentation

void operator=

(

const iterator &

iter  )

[inline]

Definition at line 180 of file StaticHashTableI.H.

bool operator==

(

const iterator &

iter  )

const [inline]

Definition at line 193 of file StaticHashTableI.H.

bool operator==

(

const const_iterator &

iter  )

const [inline]

Definition at line 205 of file StaticHashTableI.H.

bool operator!=

(

const iterator &

iter  )

const [inline]

Definition at line 217 of file StaticHashTableI.H.

References Foam::operator==().

bool operator!=

(

const const_iterator &

iter  )

const [inline]

Definition at line 229 of file StaticHashTableI.H.

References Foam::operator==().

TRef operator*

(

)

[inline]

Definition at line 240 of file StaticHashTableI.H.

TRef operator()

(

)

[inline]

Definition at line 249 of file StaticHashTableI.H.

References Foam::operator*().

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

(

)

[inline]

Definition at line 267 of file StaticHashTableI.H.

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

(

int

)

[inline]

Definition at line 315 of file StaticHashTableI.H.

const Key & key

(

)

const [inline]

Definition at line 328 of file StaticHashTableI.H.

---

Friends And Related Function Documentation

friend class StaticHashTable [friend]

Definition at line 275 of file StaticHashTable.H.

friend class Iterator [friend]

Definition at line 279 of file StaticHashTable.H.

---

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