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

#include <IMap.hpp>

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

zeus::IValueType zeus::IStringMap< zeus::TXMemberVariable * > zeus::TMap< TKeyType, zeus::TAutoPtr< T > > zeus::IStringMap< T > zeus::TStringMap< zeus::TXMemberVariable * > zeus::TStringMap< T > zeus::TXMemberCollection

List of all members.

Public Member Functions

virtual void MQUALIFIER copyToMap (IMap< TKeyType, TValueType > &rMap) const =0
virtual TValueType &MQUALIFIER getItem (const TKeyType &rKey)=0
virtual const TValueType
&MQUALIFIER 		getItemConst (const TKeyType &rKey) const =0
virtual void MQUALIFIER setItem (const TKeyType &rKey, const TValueType &rData)=0
virtual bool MQUALIFIER isEmpty () const =0
virtual Int MQUALIFIER getCount () const =0
virtual bool MQUALIFIER deleteItem (const TKeyType &rKey)=0
virtual bool MQUALIFIER hasItem (const TKeyType &rKey) const =0
virtual void MQUALIFIER clear ()=0
virtual IMapIterator< TKeyType,
TValueType > *MQUALIFIER 		getIterator ()=0
virtual void MQUALIFIER releaseIterator (const IListIterator< TValueType > *pIterator) const =0
virtual const IMapIterator
< TKeyType, TValueType >
*MQUALIFIER 		getConstIterator () const =0
virtual bool MQUALIFIER equals (const IMap< TKeyType, TValueType > &rMap) const =0

Detailed Description

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

This interface defines a map

Member Function Documentation

template<class TKeyType, class TValueType>
virtual void MQUALIFIER zeus::IMap< TKeyType, TValueType >::copyToMap ( IMap< TKeyType, TValueType > &  rMap  )  const [pure virtual]

This copies the content of this map into an other map instance

Parameters:
rMap : destrination map to copy the content to

Implemented in zeus::TAtomicMap< TKeyType, T >, and zeus::TMap< TKeyType, T >.

template<class TKeyType, class TValueType>
virtual TValueType& MQUALIFIER zeus::IMap< TKeyType, TValueType >::getItem ( const TKeyType &  rKey  )  [pure virtual]

Gets an item out of the map

Parameters:
rKey : Key of the item
Returns:
item

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, and zeus::TMap< TKeyType, zeus::TAutoPtr< T > >.

template<class TKeyType, class TValueType>
virtual const TValueType& MQUALIFIER zeus::IMap< TKeyType, TValueType >::getItemConst ( const TKeyType &  rKey  )  const [pure virtual]

Gets a copy of an item out of the map

Parameters:
rKey : Key of the item
Returns:
const item

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, and zeus::TMap< TKeyType, zeus::TAutoPtr< T > >.

template<class TKeyType, class TValueType>
virtual void MQUALIFIER zeus::IMap< TKeyType, TValueType >::setItem ( const TKeyType &  rKey,
const TValueType &  rData 
) [pure virtual]

adds a new item to the map

Parameters:
rKey : Key of the value
rData : Data value

Implemented in zeus::TAtomicMap< TKeyType, T >, and zeus::TMap< TKeyType, T >.

template<class TKeyType, class TValueType>
virtual bool MQUALIFIER zeus::IMap< TKeyType, TValueType >::isEmpty (  )  const [pure virtual]

Checks if the map is empty

Return values:
true : Map is empty
false : Map is not empty

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, zeus::TStringMap< T >, zeus::TMap< Int, zeus::TCommPipe::TPipeContainer * >, zeus::TMap< Uint, zeus::IThreadMessageQueue * >, zeus::TMap< Uint, bool >, zeus::TMap< EVariableType, zeus::TString >, zeus::TMap< TKeyType, zeus::TAutoPtr< T > >, zeus::TStringMap< EVariableType >, zeus::TStringMap< zeus::TLogger >, zeus::TStringMap< zeus::TLibLoader * >, zeus::TStringMap< Int >, zeus::TStringMap< zeus::TXObjectFactory::RClassRegistry >, zeus::TStringMap< zeus::ISecurityPlugin * >, zeus::TStringMap< zeus::TProperty * >, zeus::TStringMap< zeus::TFileSystemWatcher::REntry * >, zeus::TStringMap< zeus::TXMemberVariable * >, zeus::TStringMap< zeus::IZUnknown * >, zeus::TStringMap< zeus::TString >, zeus::TStringMap< zeus::TFingerPrint * >, and zeus::TStringMap< Retval MQUALIFIER(* >.

template<class TKeyType, class TValueType>
virtual Int MQUALIFIER zeus::IMap< TKeyType, TValueType >::getCount (  )  const [pure virtual]

Gets the number of elements

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, zeus::TStringMap< T >, zeus::TMap< Int, zeus::TCommPipe::TPipeContainer * >, zeus::TMap< Uint, zeus::IThreadMessageQueue * >, zeus::TMap< Uint, bool >, zeus::TMap< EVariableType, zeus::TString >, zeus::TMap< TKeyType, zeus::TAutoPtr< T > >, zeus::TStringMap< EVariableType >, zeus::TStringMap< zeus::TLogger >, zeus::TStringMap< zeus::TLibLoader * >, zeus::TStringMap< Int >, zeus::TStringMap< zeus::TXObjectFactory::RClassRegistry >, zeus::TStringMap< zeus::ISecurityPlugin * >, zeus::TStringMap< zeus::TProperty * >, zeus::TStringMap< zeus::TFileSystemWatcher::REntry * >, zeus::TStringMap< zeus::TXMemberVariable * >, zeus::TStringMap< zeus::IZUnknown * >, zeus::TStringMap< zeus::TString >, zeus::TStringMap< zeus::TFingerPrint * >, and zeus::TStringMap< Retval MQUALIFIER(* >.

template<class TKeyType, class TValueType>
virtual bool MQUALIFIER zeus::IMap< TKeyType, TValueType >::deleteItem ( const TKeyType &  rKey  )  [pure virtual]

Deletes an item out of the map

Parameters:
rKey : Key value
Return values:
true : Item deleted
false,: Could not delete item

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, and zeus::TMap< TKeyType, zeus::TAutoPtr< T > >.

template<class TKeyType, class TValueType>
virtual bool MQUALIFIER zeus::IMap< TKeyType, TValueType >::hasItem ( const TKeyType &  rKey  )  const [pure virtual]

Checks if an item is inside the map

Parameters:
rKey : Key to check
Return values:
true : Item is included
false,: No such item found

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, and zeus::TMap< TKeyType, zeus::TAutoPtr< T > >.

template<class TKeyType, class TValueType>
virtual void MQUALIFIER zeus::IMap< TKeyType, TValueType >::clear (  )  [pure virtual]

Clears the map

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, zeus::TStringMap< T >, zeus::TXMemberCollection, zeus::TMap< Int, zeus::TCommPipe::TPipeContainer * >, zeus::TMap< Uint, zeus::IThreadMessageQueue * >, zeus::TMap< Uint, bool >, zeus::TMap< EVariableType, zeus::TString >, zeus::TMap< TKeyType, zeus::TAutoPtr< T > >, zeus::TStringMap< EVariableType >, zeus::TStringMap< zeus::TLogger >, zeus::TStringMap< zeus::TLibLoader * >, zeus::TStringMap< Int >, zeus::TStringMap< zeus::TXObjectFactory::RClassRegistry >, zeus::TStringMap< zeus::ISecurityPlugin * >, zeus::TStringMap< zeus::TProperty * >, zeus::TStringMap< zeus::TFileSystemWatcher::REntry * >, zeus::TStringMap< zeus::TXMemberVariable * >, zeus::TStringMap< zeus::IZUnknown * >, zeus::TStringMap< zeus::TString >, zeus::TStringMap< zeus::TFingerPrint * >, and zeus::TStringMap< Retval MQUALIFIER(* >.

template<class TKeyType, class TValueType>
virtual IMapIterator<TKeyType, TValueType>* MQUALIFIER zeus::IMap< TKeyType, TValueType >::getIterator (  )  [pure virtual]

gets a map iterator

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, zeus::TStringMap< T >, zeus::TMap< Int, zeus::TCommPipe::TPipeContainer * >, zeus::TMap< Uint, zeus::IThreadMessageQueue * >, zeus::TMap< Uint, bool >, zeus::TMap< EVariableType, zeus::TString >, zeus::TMap< TKeyType, zeus::TAutoPtr< T > >, zeus::TStringMap< EVariableType >, zeus::TStringMap< zeus::TLogger >, zeus::TStringMap< zeus::TLibLoader * >, zeus::TStringMap< Int >, zeus::TStringMap< zeus::TXObjectFactory::RClassRegistry >, zeus::TStringMap< zeus::ISecurityPlugin * >, zeus::TStringMap< zeus::TProperty * >, zeus::TStringMap< zeus::TFileSystemWatcher::REntry * >, zeus::TStringMap< zeus::TXMemberVariable * >, zeus::TStringMap< zeus::IZUnknown * >, zeus::TStringMap< zeus::TString >, zeus::TStringMap< zeus::TFingerPrint * >, and zeus::TStringMap< Retval MQUALIFIER(* >.

template<class TKeyType, class TValueType>
virtual void MQUALIFIER zeus::IMap< TKeyType, TValueType >::releaseIterator ( const IListIterator< TValueType > *  pIterator  )  const [pure virtual]

releases a map iterator

Implemented in zeus::TAtomicMap< TKeyType, T >, and zeus::TMap< TKeyType, T >.

template<class TKeyType, class TValueType>
virtual const IMapIterator<TKeyType, TValueType>* MQUALIFIER zeus::IMap< TKeyType, TValueType >::getConstIterator (  )  const [pure virtual]

gets a const map iterator

Implemented in zeus::TAtomicMap< TKeyType, T >, zeus::TMap< TKeyType, T >, zeus::TStringMap< T >, zeus::TMap< Int, zeus::TCommPipe::TPipeContainer * >, zeus::TMap< Uint, zeus::IThreadMessageQueue * >, zeus::TMap< Uint, bool >, zeus::TMap< EVariableType, zeus::TString >, zeus::TMap< TKeyType, zeus::TAutoPtr< T > >, zeus::TStringMap< EVariableType >, zeus::TStringMap< zeus::TLogger >, zeus::TStringMap< zeus::TLibLoader * >, zeus::TStringMap< Int >, zeus::TStringMap< zeus::TXObjectFactory::RClassRegistry >, zeus::TStringMap< zeus::ISecurityPlugin * >, zeus::TStringMap< zeus::TProperty * >, zeus::TStringMap< zeus::TFileSystemWatcher::REntry * >, zeus::TStringMap< zeus::TXMemberVariable * >, zeus::TStringMap< zeus::IZUnknown * >, zeus::TStringMap< zeus::TString >, zeus::TStringMap< zeus::TFingerPrint * >, and zeus::TStringMap< Retval MQUALIFIER(* >.

template<class TKeyType, class TValueType>
virtual bool MQUALIFIER zeus::IMap< TKeyType, TValueType >::equals ( const IMap< TKeyType, TValueType > &  rMap  )  const [pure virtual]

Checks if two maps are equal

Implemented in zeus::TAtomicMap< TKeyType, T >, and zeus::TMap< TKeyType, T >.

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

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:34 2009