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

#include "dwfcore/Iterator.h"

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

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

An const iterator implementation for an STL vector.

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

Definition at line 369 of file Iterator.h.

Public Member Functions

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


Constructor & Destructor Documentation

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

Constructor

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

Definition at line 381 of file Iterator.h.

template<class T, class A = std::allocator<T>>
DWFCore::DWFVectorConstIterator< T, A >::DWFVectorConstIterator const DWFVectorConstIterator< 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 395 of file Iterator.h.

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

Destructor

Exceptions:
None 

Definition at line 423 of file Iterator.h.


Member Function Documentation

template<class T, class A = std::allocator<T>>
const T& DWFCore::DWFVectorConstIterator< T, A >::get  )  const throw ( DWFException ) [inline, virtual]
 

Returns the element at the current position.

Returns:
The current element.
Exceptions:
DWFException 

Implements DWFCore::DWFConstIterator< T >.

Definition at line 465 of file Iterator.h.

template<class T, class A = std::allocator<T>>
bool DWFCore::DWFVectorConstIterator< 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::DWFConstIterator< T >.

Definition at line 448 of file Iterator.h.

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

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

Reset the iterator back to its initial position

Exceptions:
None 

Implements DWFCore::DWFConstIterator< T >.

Definition at line 430 of file Iterator.h.

template<class T, class A = std::allocator<T>>
bool DWFCore::DWFVectorConstIterator< T, A >::valid  )  const 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::DWFConstIterator< T >.

Definition at line 439 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