Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Friends | List of all members
CoreOrderedHashTable< T, U >::Iterator Class Reference

Provides a way to run through items as a vector. More...

Public Member Functions

 Iterator (const Iterator &it)
 Copy constructor.
 
 operator bool () const
 Tests the iterator is still in dictionary bounds.
 
bool is_valid () const
 Tests the iterator is still in dictionary bounds.
 
U * operator-> ()
 Access the data as a pointer.
 
const U * operator-> () const
 Const access the data as a pointer.
 
U & operator* ()
 Access the data as a reference.
 
const U & operator* () const
 Const access the data as a reference.
 
Iteratoroperator++ ()
 pre-increment operator
 
Iterator operator++ (int) const
 post-increment operator
 

Friends

class CoreOrderedHashTable
 

Detailed Description

template<class T, class U>
class CoreOrderedHashTable< T, U >::Iterator

Provides a way to run through items as a vector.

Constructor & Destructor Documentation

template<class T, class U>
CoreOrderedHashTable< T, U >::Iterator::Iterator ( const Iterator it)
inline

Copy constructor.

Parameters
theiterator to copy

Member Function Documentation

template<class T, class U>
bool CoreOrderedHashTable< T, U >::Iterator::is_valid ( void  ) const
inline

Tests the iterator is still in dictionary bounds.

Returns
True if the iterator is valid, false otherwise
template<class T, class U>
CoreOrderedHashTable< T, U >::Iterator::operator bool ( ) const
inline

Tests the iterator is still in dictionary bounds.

Returns
True if the iterator is valid, false otherwise
template<class T, class U>
U& CoreOrderedHashTable< T, U >::Iterator::operator* ( void  )
inline

Access the data as a reference.

Returns
the data reference where the iterator is located on
template<class T, class U>
const U& CoreOrderedHashTable< T, U >::Iterator::operator* ( void  ) const
inline

Const access the data as a reference.

Returns
the const data reference where the iterator is located on
template<class T, class U>
Iterator& CoreOrderedHashTable< T, U >::Iterator::operator++ ( void  )
inline

pre-increment operator

Returns
this iterator after incrementation
template<class T, class U>
Iterator CoreOrderedHashTable< T, U >::Iterator::operator++ ( int  ) const
inline

post-increment operator

Parameters
unused
Returns
an incremented copy of this iterator
template<class T, class U>
U* CoreOrderedHashTable< T, U >::Iterator::operator-> ( void  )
inline

Access the data as a pointer.

Returns
the data pointer where the iterator is located on
template<class T, class U>
const U* CoreOrderedHashTable< T, U >::Iterator::operator-> ( void  ) const
inline

Const access the data as a pointer.

Returns
the const data pointer where the iterator is located on