FbxHashMap< KEY, VALUE, HASH, Destruct, Comparator >::Iterator Class Reference

#include <fbxhashmap.h>

Class Description

template<typename KEY, typename VALUE, typename HASH, class Destruct = FbxNoOpDestruct<VALUE>, class Comparator = FbxDefaultComparator<KEY>>
class FbxHashMap< KEY, VALUE, HASH, Destruct, Comparator >::Iterator

Iterate through every element in a hash map.

Definition at line 77 of file fbxhashmap.h.

Public Types
typedef ListItem	ListItemType
typedef FbxPair< KeyType, ValueType >	KeyValuePair

Public Member Functions
	Iterator (const Iterator &pOther)
	Copy constructor. More...
	~Iterator ()
	Destructor. More...
KeyValuePair	operator* () const
	Used to dereference an iterator and give it a behavior more similar to a pointer. More...
void	Next ()
	Advances the iterator to the next keyvaluepair in the hashmap. More...
bool	operator== (const Iterator &pOther) const
	Check equivalence between two iterators. More...
bool	operator!= (const Iterator &pOther) const
	Check inequivalence between 2 iterators. More...
Iterator &	operator= (const Iterator &pOther)
	Assign the current iterator to the one on the right hand side of the operator. More...

Friends
class	FbxHashMap

Member Typedef Documentation

ListItemType

typedef ListItem ListItemType

Definition at line 81 of file fbxhashmap.h.

KeyValuePair

typedef FbxPair< KeyType, ValueType > KeyValuePair

Definition at line 82 of file fbxhashmap.h.

Constructor & Destructor Documentation

Iterator()

Iterator ( const Iterator &  pOther )

inline

Copy constructor.

Definition at line 87 of file fbxhashmap.h.

            :
            mMap( pOther.mMap ),
            mBucketIndex( pOther.mBucketIndex ),
            mCurrentItem( pOther.mCurrentItem )
        {

        }

~Iterator()

~Iterator ( )

inline

Destructor.

Definition at line 99 of file fbxhashmap.h.

{};

Member Function Documentation

operator*()

KeyValuePair operator* ( ) const

inline

Used to dereference an iterator and give it a behavior more similar to a pointer.

Returns

The KeyValuePair currently referenced by the iterator

Definition at line 105 of file fbxhashmap.h.

        {
            KeyValuePair lItem;

            if( mCurrentItem )
            {
                lItem.mFirst = mCurrentItem->mKey;
                lItem.mSecond = mCurrentItem->mValue;
                return lItem;
            }

            FBX_ASSERT_NOW("Accessing out of bounds iterator");

            return lItem;
        }

Next()

void Next ( )

inline

Advances the iterator to the next keyvaluepair in the hashmap.

It does not wrap around so advancing after reaching the last element will not point back to the first one.

Definition at line 125 of file fbxhashmap.h.

        {
            if( !mCurrentItem )
                return;

            if( mCurrentItem->mNext )
            {
                mCurrentItem = mCurrentItem->mNext;
                return;
            }
            else
            {
                mBucketIndex++;
                for( ; mBucketIndex < mMap->mBuckets.GetCount(); ++mBucketIndex )
                {
                    if( mMap->mBuckets[ mBucketIndex ] )
                    {
                        mCurrentItem = mMap->mBuckets[ mBucketIndex ];
                        return;
                    }
                }
                
                if( mBucketIndex >= mMap->mBuckets.GetCount() )
                {
                    *this = mMap->End();
                    return;
                }
            }
        }

operator==()

bool operator== ( const Iterator &  pOther ) const

inline

Check equivalence between two iterators.

There are 3 conditions for equivalence between 2 iterators: 1) Item being referenced by the iterator must be equivalent 2) They must point at the same index 3) They must point on the same map

Returns

true if both iterators are equal, false otherwise

Definition at line 162 of file fbxhashmap.h.

        {
            return  mCurrentItem == pOther.mCurrentItem && 
                    mBucketIndex == pOther.mBucketIndex &&
                    mMap == pOther.mMap;
        }

operator!=()

bool operator!= ( const Iterator &  pOther ) const

inline

Check inequivalence between 2 iterators.

Please see operator== for more information.

Returns

true if both iterators are NOT equal, false if they are

Definition at line 173 of file fbxhashmap.h.

        {
            return !(*this == pOther);
        }

operator=()

Iterator& operator= ( const Iterator &  pOther )

inline

Assign the current iterator to the one on the right hand side of the operator.

After assignment they will reference the same object, at the same index, in the same map.

Returns

The new iterator

Definition at line 183 of file fbxhashmap.h.

        {
            this->mBucketIndex = pOther.mBucketIndex;
            this->mMap = pOther.mMap;
            this->mCurrentItem = pOther.mCurrentItem;
            return *this;
        }

Friends And Related Function Documentation

FbxHashMap

friend class FbxHashMap

friend

Definition at line 206 of file fbxhashmap.h.

---

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

• fbxsdk/core/base/fbxhashmap.h