DWFCore::DWFCachingIterator< T > Class Template Reference

#include "dwfcore/Iterator.h"

Inheritance diagram for DWFCore::DWFCachingIterator< T >:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFCachingIterator< T >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class T>
class DWFCore::DWFCachingIterator< T >

An iterator that stores a collection of the added items.

Since:
1.2.0

Definition at line 779 of file Iterator.h.

Public Member Functions

 DWFCachingIterator (uint16_t nHint=16) throw ()
virtual ~DWFCachingIterator () throw ()
virtual void reset () throw ()
virtual bool valid () throw ()
virtual bool next () throw ()
virtual T & get () throw ( DWFException )
virtual void add (const T &rT) throw ( DWFException )


Constructor & Destructor Documentation

template<class T>
DWFCore::DWFCachingIterator< T >::DWFCachingIterator uint16_t  nHint = 16  )  throw () [inline]
 

Constructor

Parameters:
nHint Best guess at the number of elements in the collection. The more accurate this number is, the fewer memory allocations will occur over the lifetime of the collection.
Exceptions:
None 

Definition at line 793 of file Iterator.h.

template<class T>
virtual DWFCore::DWFCachingIterator< T >::~DWFCachingIterator  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 807 of file Iterator.h.


Member Function Documentation

template<class T>
virtual void DWFCore::DWFCachingIterator< T >::add const T &  rT  )  throw ( DWFException ) [inline, virtual]
 

Add an element to the collection. This operation does not alter the iterator position unless it was previously invalid due to the existence of no elements.

Parameters:
rT The element to add.
Exceptions:
DWFException 

Definition at line 878 of file Iterator.h.

template<class T>
virtual T& DWFCore::DWFCachingIterator< T >::get  )  throw ( DWFException ) [inline, virtual]
 

Returns the element at the current position.

Returns:
The current element.
Exceptions:
DWFException 

Implements DWFCore::DWFIterator< T >.

Definition at line 857 of file Iterator.h.

template<class T>
virtual bool DWFCore::DWFCachingIterator< T >::next  )  throw () [inline, 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 

Implements DWFCore::DWFIterator< T >.

Definition at line 837 of file Iterator.h.

template<class T>
virtual void DWFCore::DWFCachingIterator< T >::reset  )  throw () [inline, virtual]
 

Reset the iterator back to its initial position

Exceptions:
None 

Implements DWFCore::DWFIterator< T >.

Definition at line 819 of file Iterator.h.

template<class T>
virtual bool DWFCore::DWFCachingIterator< T >::valid  )  throw () [inline, 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 

Implements DWFCore::DWFIterator< T >.

Definition at line 828 of file Iterator.h.


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