NAME
corelinux::AssociativeIterator - The AssociativeIterator that extends Iterator to include the interface for describing an associative collection type without exposing its underlying representation.
SYNOPSIS
#include <AssociativeIterator.hpp>
Inherits corelinux::Iterator< ElementType >< ElementType >.
Inherited by corelinux::CoreLinuxAssociativeIterator< TraverseType, KeyType, ElementType >.
Public Member Functions
AssociativeIterator (void)
Default constructor. AssociativeIterator (const AssociativeIterator &aRef)
Copy constructor. virtual ~AssociativeIterator (void)
Destructor. AssociativeIterator & operator= (const AssociativeIterator &)
Assignment operator. bool operator== (const AssociativeIterator &aRef) const
Equality operator. virtual KeyType getKey (void) const =0 throw (IteratorBoundsException)
getKey returns the KeyType instance that is currently pointed to by the AssociativeIterator
Detailed Description
template<class KeyType, class ElementType> class corelinux::AssociativeIterator< KeyType, ElementType >
The AssociativeIterator that extends Iterator to include the interface for describing an associative collection type without exposing its underlying representation.
The implementation requires a template arguments that describes the KeyType and ElementType being iterated over.
Constructor & Destructor Documentation
template<class KeyType, class ElementType> corelinux::AssociativeIterator< KeyType, ElementType >::AssociativeIterator (const AssociativeIterator< KeyType, ElementType > & aRef) [inline]
Copy constructor. Parameters:
AssociativeIterator const reference
Member Function Documentation
template<class KeyType, class ElementType> virtual KeyType corelinux::AssociativeIterator< KeyType, ElementType >::getKey (void) const throw (IteratorBoundsException) [pure virtual]
getKey returns the KeyType instance that is currently pointed to by the AssociativeIterator Returns:
KeyType
Exceptions:
IteratorBoundsException if the AssociativeIterator is not positioned correctly.
Implemented in corelinux::CoreLinuxAssociativeIterator< TraverseType, KeyType, ElementType >.
template<class KeyType, class ElementType> AssociativeIterator& corelinux::AssociativeIterator< KeyType, ElementType >::operator= (const AssociativeIterator< KeyType, ElementType > &) [inline]
Assignment operator. Parameters:
AssociativeIterator const reference
Returns:
AssociativeIterator reference
template<class KeyType, class ElementType> bool corelinux::AssociativeIterator< KeyType, ElementType >::operator== (const AssociativeIterator< KeyType, ElementType > & aRef) const [inline]
Equality operator. Parameters:
AssociativeIterator const reference
Returns:
bool - true if instances are equal
Author
Generated automatically by Doxygen for CoreLinux++ from the source code.