ES3D::Map< KEY, VALUE > Class Template Reference

#include <Map.h>

List of all members.

Public Member Functions
	Map ()
virtual	~Map ()
GLvoid	clear (GLvoid)
GLboolean	containsKey (KEY key)
GLboolean	containsValue (VALUE value)
VALUE &	get (KEY key)
List< KEY > &	getKeys (GLvoid)
List< VALUE > &	getValues (GLvoid)
GLvoid	put (KEY key, VALUE value)
GLvoid	remove (KEY key)
GLuint	size (GLvoid)
GLvoid	trimToSize (GLvoid)

---

Detailed Description

template<class KEY, class VALUE>
class ES3D::Map< KEY, VALUE >

Simple Map. Similar to the Java or STL implementation.

---

Constructor & Destructor Documentation

template<class KEY, class VALUE>

ES3D::Map< KEY, VALUE >::Map

(

)

[inline]

Constructor of the Map.

template<class KEY, class VALUE>

virtual ES3D::Map< KEY, VALUE >::~Map

(

)

[inline, virtual]

Destructor of the Map. Elements are removed.

---

Member Function Documentation

template<class KEY, class VALUE>

GLvoid ES3D::Map< KEY, VALUE >::clear

(

GLvoid

)

[inline]

Removes all elements from the map.

template<class KEY, class VALUE>

GLboolean ES3D::Map< KEY, VALUE >::containsKey

(

KEY

key

)

[inline]

Returns true, if the key is in the Map.

Parameters:

key

the key

Returns:

true, if key is available

template<class KEY, class VALUE>

GLboolean ES3D::Map< KEY, VALUE >::containsValue

(

VALUE

value

)

[inline]

Returns true, if the value is in the Map.

Parameters:

value

the value

Returns:

true, if value is available

template<class KEY, class VALUE>

VALUE& ES3D::Map< KEY, VALUE >::get

(

KEY

key

)

[inline]

Returns the value by key.

Parameters:

key

the key of the element

Returns:

a reference to the element

template<class KEY, class VALUE>

List<KEY>& ES3D::Map< KEY, VALUE >::getKeys

(

GLvoid

)

[inline]

Returns the keys of the map.

Returns:

the list of keys

template<class KEY, class VALUE>

List<VALUE>& ES3D::Map< KEY, VALUE >::getValues

(

GLvoid

)

[inline]

Returns the values of the map.

Returns:

the list of values

template<class KEY, class VALUE>

GLvoid ES3D::Map< KEY, VALUE >::put	(	KEY	key,
		VALUE	value
	)			[inline]

Puts a element with key in the map. If it already exists, the element is overwritten.

Parameters:

	key	the key of the element
	value	the value

template<class KEY, class VALUE>

GLvoid ES3D::Map< KEY, VALUE >::remove

(

KEY

key

)

[inline]

Removes key and its associated value from the map.

Parameters:

key

the key

template<class KEY, class VALUE>

GLuint ES3D::Map< KEY, VALUE >::size

(

GLvoid

)

[inline]

Returns the size of the map.

Returns:

the size

template<class KEY, class VALUE>

GLvoid ES3D::Map< KEY, VALUE >::trimToSize

(

GLvoid

)

[inline]

Trims the map with capacity equals size.

---

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

• C:/Projects/win32/ES3D/ES3D/Map.h

---