Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

DWFCore::DWFStringVectorIterator Class Reference

#include "dwfcore/Iterator.h"

Inheritance diagram for DWFCore::DWFStringVectorIterator:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFStringVectorIterator:

Collaboration graph
[legend]
List of all members.

Detailed Description

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 145 of file Iterator.h.

Public Member Functions

 DWFStringVectorIterator (vector< DWFString > &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

DWFCore::DWFStringVectorIterator::DWFStringVectorIterator vector< DWFString > &  rVector  )  throw () [inline]
 

Constructor

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

Definition at line 157 of file Iterator.h.

DWFCore::DWFStringVectorIterator::DWFStringVectorIterator const DWFStringVectorIterator 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 171 of file Iterator.h.

virtual DWFCore::DWFStringVectorIterator::~DWFStringVectorIterator  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 204 of file Iterator.h.


Member Function Documentation

DWFString& DWFCore::DWFStringVectorIterator::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 246 of file Iterator.h.

bool DWFCore::DWFStringVectorIterator::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 229 of file Iterator.h.

DWFStringVectorIterator& DWFCore::DWFStringVectorIterator::operator= const DWFStringVectorIterator 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 185 of file Iterator.h.

void DWFCore::DWFStringVectorIterator::reset  )  throw () [inline, virtual]
 

Reset the iterator back to its initial position

Exceptions:
None 

Implements DWFCore::DWFIterator< DWFString >.

Definition at line 211 of file Iterator.h.

bool DWFCore::DWFStringVectorIterator::valid  )  throw () [inline, virtual]
 

Determines if the iterator points to a valid element.

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

Implements DWFCore::DWFIterator< DWFString >.

Definition at line 220 of file Iterator.h.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:05:18 2005 for Autodesk DWF Core Library by  doxygen 1.4.1