KFbxMap< K, T, Compare > Class Template Reference

Search for all occurrences

---

Detailed Description

template<class K, class T, class Compare>
class KFbxMap< K, T, Compare >

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

Definition at line 30 of file kfbxpropertymap.h.

#include <kfbxpropertymap.h>

Inheritance diagram for KFbxMap< K, T, Compare >:

List of all members.

Public Types
typedef KMapDef::RecordType *	kIterator
Public Member Functions
	KFbxMap ()
	Constructor.
void	Add (K const &pKey, T const &pValue)
	Add a key-value pair as an element.
kIterator	Find (K const &pKey) const
	Find an element with a given key.
kIterator	Find (T const &pValue) const
	Find an element with a given value.
void	Remove (kIterator pIterator)
	Remove an element from the map.
kIterator	GetFirst () const
	Get the first element.
kIterator	GetNext (kIterator pIterator) const
	Get the next element of a given element.
void	Clear ()
	Remove all of the elements.
void	Reserve (int pSize)
	Reserve the space for given number elements.
int	GetCount () const
	Query the count of elements in the map.

---

Member Typedef Documentation

typedef KMapDef::RecordType* kIterator

Search for all occurrences

Definition at line 47 of file kfbxpropertymap.h.

---

Constructor & Destructor Documentation

KFbxMap

(

)

[inline]

Constructor.

Definition at line 50 of file kfbxpropertymap.h.

    {
    }

---

Member Function Documentation

void Add	(	K const &	pKey,
		T const &	pValue
	)		[inline]

Search for all occurrences

Add a key-value pair as an element.

Parameters:

pKey	The new key.
pValue	The new value.

Definition at line 58 of file kfbxpropertymap.h.

    {
        mMap.Insert(pKey, pValue);
    }

kIterator Find

(

K const &

pKey

)

const [inline]

Search for all occurrences

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 67 of file kfbxpropertymap.h.

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

kIterator Find

(

T const &

pValue

)

const [inline]

Search for all occurrences

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 76 of file kfbxpropertymap.h.

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

void Remove

(

kIterator

pIterator

)

[inline]

Search for all occurrences

Remove an element from the map.

Parameters:

pIterator

The given element.

Definition at line 93 of file kfbxpropertymap.h.

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

kIterator GetFirst

(

)

const [inline]

Search for all occurrences

Get the first element.

Returns:

The the heading element.

Definition at line 101 of file kfbxpropertymap.h.

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

kIterator GetNext

(

kIterator

pIterator

)

const [inline]

Search for all occurrences

Get the next element of a given element.

Parameters:

The	given element.

Returns:

The next element.

Definition at line 110 of file kfbxpropertymap.h.

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

void Clear

(

)

[inline]

Search for all occurrences

Remove all of the elements.

Definition at line 117 of file kfbxpropertymap.h.

    {
        mMap.Clear();
    }

void Reserve

(

int

pSize

)

[inline]

Search for all occurrences

Reserve the space for given number elements.

Parameters:

pSize

The given number.

Definition at line 125 of file kfbxpropertymap.h.

    {
        mMap.Reserve( pSize );
    }

int GetCount

(

)

const [inline]

Search for all occurrences

Query the count of elements in the map.

Returns:

The count of elements.

Definition at line 133 of file kfbxpropertymap.h.

    {
        return mMap.GetSize();
    }

---

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

• fbxfilesdk/fbxcore/fbxcollection/kfbxpropertymap.h