ZeusBase-Library  2.0.4
zeus::TAbstractMapIterator< TKeyType, T > Class Template Referenceabstract

#include <Iterators.hpp>

Inheritance diagram for zeus::TAbstractMapIterator< TKeyType, T >:
zeus::TAutoPtrBase< IMapIterator< TKeyType, T > > zeus::IMapIterator< TKeyType, T > zeus::TConstMapIterator< TKeyType, T > zeus::TMapIterator< TKeyType, T >

Public Member Functions

virtual void MQUALIFIER reset () const
 
virtual const T &MQUALIFIER getNextItemConst () const
 
virtual bool MQUALIFIER hasNextItem () const
 
virtual Retval MQUALIFIER getNextKeyConst (TKeyType &rKey) const
 
virtual const T &MQUALIFIER getNextItemWithKeyConst (TKeyType &rKey) const
 
- Public Member Functions inherited from zeus::TAutoPtrBase< IMapIterator< TKeyType, T > >
 TAutoPtrBase ()
 
 TAutoPtrBase (const IMapIterator< TKeyType, T > *pIface, bool bAllocPointer=false)
 
 TAutoPtrBase (const IMapIterator< TKeyType, T > &rIface, bool bAllocPointer=false)
 
virtual ~TAutoPtrBase ()
 
void assign (const IMapIterator< TKeyType, T > *pInterface)
 
void assign (const IMapIterator< TKeyType, T > &rInterface)
 
void attach (const IMapIterator< TKeyType, T > *pInterface)
 
void attach (const IMapIterator< TKeyType, T > &rInterface)
 
bool equals (const IMapIterator< TKeyType, T > *pInterface) const
 
bool equals (const IMapIterator< TKeyType, T > &rInterface) const
 
IMapIterator< TKeyType, T > *& getPointerReference ()
 
const IMapIterator< TKeyType, T > *& getConstPointerReference () const
 
IZUnknown *& getInterfaceReference ()
 
const IZUnknown *& getInterfaceReferenceConst () const
 
IMapIterator< TKeyType, T > * getPointer ()
 
const IMapIterator< TKeyType, T > * getConstPointer () const
 
IMapIterator< TKeyType, T > * detach ()
 
void release ()
 

Protected Member Functions

 TAbstractMapIterator ()
 
 TAbstractMapIterator (const IMapIterator< TKeyType, T > *pIt, bool bAllocPointer=false)
 
 TAbstractMapIterator (IMapIterator< TKeyType, T > *pIt, bool bAllocPointer=false)
 
virtual T &MQUALIFIER getNextItem () const =0
 
virtual Retval MQUALIFIER getNextKey (TKeyType &rKey)=0
 
virtual T &MQUALIFIER getNextItemWithKey (TKeyType &rKey) const =0
 

Additional Inherited Members

- Protected Attributes inherited from zeus::TAutoPtrBase< IMapIterator< TKeyType, T > >
IMapIterator< TKeyType, T > * m_pInterface
 

Detailed Description

template<class TKeyType, class T>
class zeus::TAbstractMapIterator< TKeyType, T >

Abstract implementation of the map iterator wrapper.

Constructor & Destructor Documentation

§ TAbstractMapIterator() [1/3]

template<class TKeyType, class T>
zeus::TAbstractMapIterator< TKeyType, T >::TAbstractMapIterator ( )
inlineprotected

Standard constructor

§ TAbstractMapIterator() [2/3]

template<class TKeyType, class T>
zeus::TAbstractMapIterator< TKeyType, T >::TAbstractMapIterator ( const IMapIterator< TKeyType, T > *  pIt,
bool  bAllocPointer = false 
)
inlineprotected

Creates an Interface Smart pointer

Parameters
pIt: Iterator Interface
bAllocPointer: If this flag is true the pointer will be allocated with addRef()

§ TAbstractMapIterator() [3/3]

template<class TKeyType, class T>
zeus::TAbstractMapIterator< TKeyType, T >::TAbstractMapIterator ( IMapIterator< TKeyType, T > *  pIt,
bool  bAllocPointer = false 
)
inlineprotected

Creates an Interface Smart pointer

Parameters
pIt: Iterator Interface
bAllocPointer: If this flag is true the pointer will be allocated with addRef()

Member Function Documentation

§ getNextItem()

template<class TKeyType, class T>
virtual T& MQUALIFIER zeus::TAbstractMapIterator< TKeyType, T >::getNextItem ( ) const
protectedpure virtual

Gets the next Item

Implements zeus::IListIterator< T >.

Implemented in zeus::TMapIterator< TKeyType, T >.

§ getNextItemConst()

template<class TKeyType, class T>
virtual const T& MQUALIFIER zeus::TAbstractMapIterator< TKeyType, T >::getNextItemConst ( ) const
inlinevirtual

§ getNextItemWithKey()

template<class TKeyType, class T>
virtual T& MQUALIFIER zeus::TAbstractMapIterator< TKeyType, T >::getNextItemWithKey ( TKeyType &  rKey) const
protectedpure virtual

Gets the next Item and also returns the key value as a copy

Implements zeus::IMapIterator< TKeyType, T >.

Implemented in zeus::TMapIterator< TKeyType, T >.

§ getNextItemWithKeyConst()

template<class TKeyType, class T>
virtual const T& MQUALIFIER zeus::TAbstractMapIterator< TKeyType, T >::getNextItemWithKeyConst ( TKeyType &  rKey) const
inlinevirtual

§ getNextKey()

template<class TKeyType, class T>
virtual Retval MQUALIFIER zeus::TAbstractMapIterator< TKeyType, T >::getNextKey ( TKeyType &  rKey)
protectedpure virtual

This method returns the key of an item instead of the value

Implements zeus::IMapIterator< TKeyType, T >.

Implemented in zeus::TMapIterator< TKeyType, T >.

§ getNextKeyConst()

template<class TKeyType, class T>
virtual Retval MQUALIFIER zeus::TAbstractMapIterator< TKeyType, T >::getNextKeyConst ( TKeyType &  rKey) const
inlinevirtual

§ hasNextItem()

template<class TKeyType, class T>
virtual bool MQUALIFIER zeus::TAbstractMapIterator< TKeyType, T >::hasNextItem ( ) const
inlinevirtual

§ reset()

template<class TKeyType, class T>
virtual void MQUALIFIER zeus::TAbstractMapIterator< TKeyType, T >::reset ( ) const
inlinevirtual

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


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Tue Sep 13 2016 22:31:47