A class that iterates over hash map elements without the ability to modify them.
More...
#include <omHashMap.h>
|
| ConstIterator (const HashMap &newHashMap) |
| Create a new hash map iterator for the specified hash map. More...
|
|
void | operator++ () |
| Increment the location of a hash map iterator by one element. More...
|
|
void | operator++ (int) |
| Increment the location of a hash map iterator by one element. More...
|
|
| operator Bool () const |
| Test whether or not the current element is valid. More...
|
|
const V & | operator* () const |
| Return the value of the key-value pair pointed to by the iterator. More...
|
|
const V * | operator-> () const |
| Access the current iterator element value. More...
|
|
const V & | getValue () const |
| Get the value of the key-value pair pointed to by the iterator. More...
|
|
const K & | getKey () const |
| Get the key of the key-value pair pointed to by the iterator. More...
|
|
HashType | getKeyHash () const |
| Get the key hash of the key-value pair pointed to by the iterator. More...
|
|
void | reset () |
| Reset the iterator to the beginning of the hash map. More...
|
|
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
class om::util::HashMap< K, V, HashType, SizeType >::ConstIterator
A class that iterates over hash map elements without the ability to modify them.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
Create a new hash map iterator for the specified hash map.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
Increment the location of a hash map iterator by one element.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
void om::util::HashMap< K, V, HashType, SizeType >::ConstIterator::operator++ |
( |
int |
| ) |
|
|
inline |
Increment the location of a hash map iterator by one element.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
Test whether or not the current element is valid.
This will return FALSE when the last element of the hash map has been iterated over.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
const V& om::util::HashMap< K, V, HashType, SizeType >::ConstIterator::operator* |
( |
| ) |
const |
|
inline |
Return the value of the key-value pair pointed to by the iterator.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
const V* om::util::HashMap< K, V, HashType, SizeType >::ConstIterator::operator-> |
( |
| ) |
const |
|
inline |
Access the current iterator element value.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
const V& om::util::HashMap< K, V, HashType, SizeType >::ConstIterator::getValue |
( |
| ) |
const |
|
inline |
Get the value of the key-value pair pointed to by the iterator.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
const K& om::util::HashMap< K, V, HashType, SizeType >::ConstIterator::getKey |
( |
| ) |
const |
|
inline |
Get the key of the key-value pair pointed to by the iterator.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
HashType om::util::HashMap< K, V, HashType, SizeType >::ConstIterator::getKeyHash |
( |
| ) |
const |
|
inline |
Get the key hash of the key-value pair pointed to by the iterator.
template<typename K, typename V, typename HashType = Hash, typename SizeType = Size>
Reset the iterator to the beginning of the hash map.
The documentation for this class was generated from the following file: