DWFCore::DWFKVIterator< K, V > Interface Template Reference

#include "dwfcore/Iterator.h"

Inheritance diagram for DWFCore::DWFKVIterator< K, V >:

Inheritance graph
[legend]
List of all members.

Detailed Description

template<class K, class V>
interface DWFCore::DWFKVIterator< K, V >

An interface template for key-value iterators.

Since:
1.0.1
This iterator interface is used to return objects that are stored in a keyed collection (a map, for example).
Parameters:
T The type of content returned by the iterator.

Definition at line 925 of file Iterator.h.

Public Member Functions

virtual ~DWFKVIterator () throw ()
virtual void reset ()=0 throw ()
virtual bool valid ()=0 throw ()
virtual bool next ()=0 throw ()
virtual K & key ()=0 throw ( DWFException )
virtual V & value ()=0 throw ( DWFException )

Protected Member Functions

 DWFKVIterator () throw ()


Constructor & Destructor Documentation

template<class K, class V>
virtual DWFCore::DWFKVIterator< K, V >::~DWFKVIterator  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 935 of file Iterator.h.

template<class K, class V>
DWFCore::DWFKVIterator< K, V >::DWFKVIterator  )  throw () [inline, protected]
 

Constructor

Exceptions:
None 

Definition at line 982 of file Iterator.h.


Member Function Documentation

template<class K, class V>
virtual K& DWFCore::DWFKVIterator< K, V >::key  )  throw ( DWFException ) [pure virtual]
 

Returns the key of the element at the current position.

Returns:
The current key.
Exceptions:
DWFException 

Implemented in DWFCore::DWFSkipList< K, V, E, L, Z >::Iterator, and DWFCore::DWFChainedSkipList< PK, SK, V, PE, SE, PL, SL, PZ, SZ >::Iterator.

template<class K, class V>
virtual bool DWFCore::DWFKVIterator< K, V >::next  )  throw () [pure virtual]
 

Move the iterator forward one element.

Returns:
true if the iterator points to a valid element, false if the end of the iterator has been reached.
Exceptions:
None 

Implemented in DWFCore::DWFSkipList< K, V, E, L, Z >::Iterator, and DWFCore::DWFChainedSkipList< PK, SK, V, PE, SE, PL, SL, PZ, SZ >::Iterator.

template<class K, class V>
virtual void DWFCore::DWFKVIterator< K, V >::reset  )  throw () [pure virtual]
 

Reset the iterator back to its initial position

Exceptions:
None 

Implemented in DWFCore::DWFSkipList< K, V, E, L, Z >::Iterator, and DWFCore::DWFChainedSkipList< PK, SK, V, PE, SE, PL, SL, PZ, SZ >::Iterator.

template<class K, class V>
virtual bool DWFCore::DWFKVIterator< K, V >::valid  )  throw () [pure virtual]
 

Determines if the iterator points to a valid element.

Returns:
true if get() will return a valid element, false if the end of the iterator has been reached.
Exceptions:
None 

Implemented in DWFCore::DWFSkipList< K, V, E, L, Z >::Iterator, and DWFCore::DWFChainedSkipList< PK, SK, V, PE, SE, PL, SL, PZ, SZ >::Iterator.

template<class K, class V>
virtual V& DWFCore::DWFKVIterator< K, V >::value  )  throw ( DWFException ) [pure virtual]
 

Returns the value of the element at the current position.

Returns:
The current value.
Exceptions:
DWFException 

Implemented in DWFCore::DWFSkipList< K, V, E, L, Z >::Iterator, and DWFCore::DWFChainedSkipList< PK, SK, V, PE, SE, PL, SL, PZ, SZ >::Iterator.


The documentation for this interface was generated from the following file:
Generated on Tue Jan 6 22:39:38 2009 for Autodesk DWF Core Library by  doxygen 1.4.5