DWFCore::DWFStringVectorIterator< A > Class Template Reference

#include "dwfcore/Iterator.h"

Inheritance diagram for DWFCore::DWFStringVectorIterator< A >:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFStringVectorIterator< A >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class A = std::allocator<DWFString>>
class DWFCore::DWFStringVectorIterator< A >

An iterator implementation for an STL vector of DWFString.

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

Definition at line 494 of file Iterator.h.

Public Member Functions

 DWFStringVectorIterator (std::vector< DWFString, A > &rVector) throw ()
 DWFStringVectorIterator (const DWFStringVectorIterator &i) throw ()
DWFStringVectorIteratoroperator= (const DWFStringVectorIterator &i) throw ()
virtual ~DWFStringVectorIterator () throw ()
void reset () throw ()
bool valid () throw ()
bool next () throw ()
DWFStringget () throw ( DWFException )


Constructor & Destructor Documentation

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

Constructor

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

Definition at line 506 of file Iterator.h.

template<class A = std::allocator<DWFString>>
DWFCore::DWFStringVectorIterator< A >::DWFStringVectorIterator const DWFStringVectorIterator< 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 520 of file Iterator.h.

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

Destructor

Exceptions:
None 

Definition at line 553 of file Iterator.h.


Member Function Documentation

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

Returns the element at the current position.

Returns:
The current element.
Exceptions:
DWFException 

Implements DWFCore::DWFIterator< DWFString >.

Definition at line 595 of file Iterator.h.

template<class A = std::allocator<DWFString>>
bool DWFCore::DWFStringVectorIterator< 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< DWFString >.

Definition at line 578 of file Iterator.h.

template<class A = std::allocator<DWFString>>
DWFStringVectorIterator& DWFCore::DWFStringVectorIterator< A >::operator= const DWFStringVectorIterator< 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 534 of file Iterator.h.

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

Reset the iterator back to its initial position

Exceptions:
None 

Implements DWFCore::DWFIterator< DWFString >.

Definition at line 560 of file Iterator.h.

template<class A = std::allocator<DWFString>>
bool DWFCore::DWFStringVectorIterator< 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< DWFString >.

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