zeus::IIndexedMap< TKeyType, TValueType > Class Template Reference

#include <IIndexedMap.hpp>

Inheritance diagram for zeus::IIndexedMap< TKeyType, TValueType >:

List of all members.

Public Member Functions
virtual bool MQUALIFIER	deleteItemByIndex (Int iIndex)=0
virtual bool MQUALIFIER	equals (const IIndexedMap< TKeyType, TValueType > &rIndexedMap) const =0
virtual Int MQUALIFIER	getIndexByKey (const TKeyType &rKey)=0
virtual const Int MQUALIFIER	getIndexByKeyConst (const TKeyType &rKey) const =0
virtual TValueType &MQUALIFIER	getOrCreateItem (const TKeyType &rKey)=0
virtual TValueType &MQUALIFIER	getValueByIndex (Int iIndex)=0
virtual const TValueType &MQUALIFIER	getValueByIndexConst (Int iIndex) const =0
virtual TKeyType MQUALIFIER	getKeyByIndex (Int iIndex)=0
virtual const TKeyType MQUALIFIER	getKeyByIndexConst (Int iIndex) const =0
virtual const IMap< TKeyType, TValueType > &MQUALIFIER	getMapConst () const =0
Protected Member Functions
virtual IMapIterator< TKeyType, TValueType > *MQUALIFIER	getIterator ()=0

---

Detailed Description

template<class TKeyType, class TValueType>
class zeus::IIndexedMap< TKeyType, TValueType >

This interface defines a IndexedMap

---

Member Function Documentation

template<class TKeyType, class TValueType>

virtual bool MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::deleteItemByIndex

(

Int

iIndex )

[pure virtual]

Deletes an item out of the map

Parameters:

iIndex,:

List index

Return values:

true,:	Item deleted
false,:	Could not delete item

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual bool MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::equals

(

const IIndexedMap< TKeyType, TValueType > &

rIndexedMap )

const [pure virtual]

Checks if two indexedMaps are equal

Parameters:

rIndexedMap,:

indexedMap to check

Return values:

true,:	are equal
false,:	are not equal

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual Int MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getIndexByKey

(

const TKeyType &

rKey )

[pure virtual]

Gets a copy of the list index by key

Parameters:

rKey,:

Key value

Return values:

Int,:

List index of item

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual const Int MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getIndexByKeyConst

(

const TKeyType &

rKey )

const [pure virtual]

Gets a copy of the list index by key

Parameters:

rKey,:

Key value

Return values:

Int,:

List index of item

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual IMapIterator<TKeyType, TValueType>* MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getIterator

(

)

[protected, pure virtual]

Hide the method to get a non const map iterator as protected.

Implements zeus::IMap< TKeyType, TValueType >.

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual TKeyType MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getKeyByIndex

(

Int

iIndex )

[pure virtual]

Gets a key by index

Parameters:

iIndex,:

list index

Returns:

TKeyType: map key

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual const TKeyType MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getKeyByIndexConst

(

Int

iIndex )

const [pure virtual]

Gets a copy of a key by index

Parameters:

iIndex,:

list index

Returns:

TKeyType: map key

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual const IMap<TKeyType, TValueType>& MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getMapConst

(

)

const [pure virtual]

Gets a copy of the internal map

Returns:

the internal map

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual TValueType& MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getOrCreateItem

(

const TKeyType &

rKey )

[pure virtual]

Gets or creates an item out of the map

Parameters:

rKey	: Key of the item

Returns:

value item

Implements zeus::IMap< TKeyType, TValueType >.

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual TValueType& MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getValueByIndex

(

Int

iIndex )

[pure virtual]

Gets a value by index

Parameters:

iIndex,:

list index

Returns:

value item

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

template<class TKeyType, class TValueType>

virtual const TValueType& MQUALIFIER zeus::IIndexedMap< TKeyType, TValueType >::getValueByIndexConst

(

Int

iIndex )

const [pure virtual]

Gets a copy of a value by index

Parameters:

iIndex,:

list index

Returns:

value item

Implemented in zeus::TIndexedMap< TKeyType, TValueType >.

---

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

• IIndexedMap.hpp