FbxSimpleMap< Key, Type, Compare > Class Template Reference

#include <fbxmap.h>

Class Description

template<class Key, class Type, class Compare>
class FbxSimpleMap< Key, Type, Compare >

A simple map class representing a dictionary-like data structure.

Definition at line 255 of file fbxmap.h.

Public Types
typedef FbxMap< Key, Type, Compare >::RecordType *	Iterator

Public Member Functions
void	Add (const Key &pKey, const Type &pValue)
	Add a key-value pair as an element. More...
Iterator	Find (const Key &pKey) const
	Find an element with a given key. More...
Iterator	Find (const Type &pValue) const
	Find an element with a given value. More...
void	Remove (Iterator pIterator)
	Remove an element from the map. More...
Iterator	GetFirst () const
	Get the first element. More...
Iterator	GetNext (Iterator pIterator) const
	Get the next element of a given element. More...
void	Clear ()
	Remove all of the elements. More...
void	Reserve (int pSize)
	Reserve the space for given number elements. More...
int	GetCount () const
	Query the count of elements in the map. More...

Member Typedef Documentation

Iterator

typedef FbxMap<Key, Type, Compare>::RecordType* Iterator

Definition at line 258 of file fbxmap.h.

Member Function Documentation

Add()

void Add ( const Key &  pKey, const Type &  pValue  )

inline

Add a key-value pair as an element.

Parameters

pKey	The new key.
pValue	The new value.

Definition at line 263 of file fbxmap.h.

    {
        mMap.Insert(pKey, pValue);
    }

Find() [1/2]

Iterator Find ( const Key &  pKey ) const

inline

Find an element with a given key.

Parameters

pKey	The given key.

Returns

The iterator pointing to the found element or NULL if fails.

Definition at line 271 of file fbxmap.h.

    {
        return (Iterator)mMap.Find(pKey);
    }

Find() [2/2]

Iterator Find ( const Type &  pValue ) const

inline

Find an element with a given value.

Parameters

pValue

The given value.

Returns

The iterator pointing to the found element or NULL if fails.

Definition at line 279 of file fbxmap.h.

    {
        Iterator lIterator = GetFirst();
        while( lIterator )
        {
            if( lIterator->GetValue() == pValue )
            {
                return lIterator;
            }
            lIterator = GetNext(lIterator);
        }
        return 0;
    }

Remove()

void Remove ( Iterator  pIterator )

inline

Remove an element from the map.

Parameters

pIterator

The given element.

Definition at line 295 of file fbxmap.h.

    {
        if( pIterator ) mMap.Remove(pIterator->GetKey());
    }

GetFirst()

Iterator GetFirst ( ) const

inline

Get the first element.

Returns

The the heading element.

Definition at line 302 of file fbxmap.h.

    {
        return (Iterator)mMap.Minimum();
    }

GetNext()

Iterator GetNext ( Iterator  pIterator ) const

inline

Get the next element of a given element.

Parameters

pIterator

The given element.

Returns

The next element.

Definition at line 310 of file fbxmap.h.

    {
        return (Iterator)pIterator ? pIterator->Successor() : 0;
    }

Clear()

void Clear ( )

inline

Remove all of the elements.

Definition at line 316 of file fbxmap.h.

    {
        mMap.Clear();
    }

Reserve()

void Reserve ( int  pSize )

inline

Reserve the space for given number elements.

Parameters

pSize

The given number.

Definition at line 323 of file fbxmap.h.

    {
        mMap.Reserve(pSize);
    }

GetCount()

int GetCount ( ) const

inline

Query the count of elements in the map.

Returns

The count of elements.

Definition at line 330 of file fbxmap.h.

    {
        return mMap.GetSize();
    }

---

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

• fbxsdk/core/base/fbxmap.h