DWFCore::DWFVectorIterator< T, A > Class Template Reference

#include "dwfcore/Iterator.h"

Inheritance diagram for DWFCore::DWFVectorIterator< T, A >:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFVectorIterator< T, A >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class T, class A = std::allocator<T>>
class DWFCore::DWFVectorIterator< T, A >

An iterator implementation for an STL vector.

Since:
1.2.0
This iterator is used to bind a DWFIterator interface to an STL vector collection.

Definition at line 241 of file Iterator.h.

Public Member Functions

 DWFVectorIterator (std::vector< T, A > &rVector) throw ()
 DWFVectorIterator (const DWFVectorIterator &i) throw ()
DWFVectorIteratoroperator= (const DWFVectorIterator &i) throw ()
virtual ~DWFVectorIterator () throw ()
void reset () throw ()
bool valid () throw ()
bool next () throw ()
T & get () throw ( DWFException )


Constructor & Destructor Documentation

template<class T, class A = std::allocator<T>>
DWFCore::DWFVectorIterator< T, A >::DWFVectorIterator std::vector< T, A > &  rVector  )  throw () [inline]
 

Constructor

Parameters:
rVector The vector over which to iterate.
Exceptions:
None 

Definition at line 253 of file Iterator.h.

template<class T, class A = std::allocator<T>>
DWFCore::DWFVectorIterator< T, A >::DWFVectorIterator const DWFVectorIterator< T, A > &  i  )  throw () [inline]
 

Copy Constructor This constructor will result in a new iterator pointing to the same position in the underlying vector as the source iterator.

Parameters:
i The iterator to clone.
Exceptions:
None 

Definition at line 267 of file Iterator.h.

template<class T, class A = std::allocator<T>>
virtual DWFCore::DWFVectorIterator< T, A >::~DWFVectorIterator  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 298 of file Iterator.h.


Member Function Documentation

template<class T, class A = std::allocator<T>>
T& DWFCore::DWFVectorIterator< T, A >::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 340 of file Iterator.h.

template<class T, class A = std::allocator<T>>
bool DWFCore::DWFVectorIterator< T, A >::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 323 of file Iterator.h.

template<class T, class A = std::allocator<T>>
DWFVectorIterator& DWFCore::DWFVectorIterator< T, A >::operator= const DWFVectorIterator< T, A > &  i  )  throw () [inline]
 

Assignment Operator This operator will assign this iterator to the same position in the underlying vector as the source iterator.

Parameters:
i The iterator to clone.
Exceptions:
None 

Definition at line 281 of file Iterator.h.

template<class T, class A = std::allocator<T>>
void DWFCore::DWFVectorIterator< T, A >::reset  )  throw () [inline, virtual]
 

Reset the iterator back to its initial position

Exceptions:
None 

Implements DWFCore::DWFIterator< T >.

Definition at line 305 of file Iterator.h.

template<class T, class A = std::allocator<T>>
bool DWFCore::DWFVectorIterator< T, A >::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 314 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