seal::Map< IndexType, DataType >::Iterator Class Reference

#include <map.h>

Inheritance diagram for seal::Map< IndexType, DataType >::Iterator:

seal::AbstractIterator< DataType >

List of all members.

Public Member Functions

 Iterator (void)
virtual ~Iterator ()
virtual bool hasNext (void)
virtual DataType next (void) throw (OutOfBoundsException)
virtual void reset (void)
IndexType getCurrentIndex (void) throw (OutOfBoundsException)


Detailed Description

template<typename IndexType, typename DataType>
class seal::Map< IndexType, DataType >::Iterator

This class encapsulates the iterator of the class seal::Map.

Constructor & Destructor Documentation

template<typename IndexType, typename DataType>
seal::Map< IndexType, DataType >::Iterator::Iterator ( void   )  [inline]

Default constructor.

template<typename IndexType, typename DataType>
virtual seal::Map< IndexType, DataType >::Iterator::~Iterator (  )  [inline, virtual]

Destructor.


Member Function Documentation

template<typename IndexType, typename DataType>
bool seal::Map< IndexType, DataType >::Iterator::hasNext ( void   )  [inline, virtual]

Returns true if there is a next element to which the iterator can iterate to; False otherwise.

Implements seal::AbstractIterator< DataType >.

template<typename IndexType, typename DataType>
DataType seal::Map< IndexType, DataType >::Iterator::next ( void   )  throw (OutOfBoundsException) [inline, virtual]

A call to this function will make the iterator iterate to the next element and return its value.

Implements seal::AbstractIterator< DataType >.

template<typename IndexType, typename DataType>
virtual void seal::Map< IndexType, DataType >::Iterator::reset ( void   )  [inline, virtual]

Resets the iterator to the begining of the map.

Implements seal::AbstractIterator< DataType >.

template<typename IndexType, typename DataType>
IndexType seal::Map< IndexType, DataType >::Iterator::getCurrentIndex ( void   )  throw (OutOfBoundsException) [inline]

Returns the index of the value returned by the function next. Throws OutOfBoundsException when called before calling next.


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

Generated on Sat May 16 21:35:20 2009 for SEAL by  doxygen 1.5.5