Edinburgh Speech Tools  2.1-release
EST_TRwIterator< Container, IPointer, Entry > Class Template Reference

#include <include/EST_TIterator.h>

Inheritance diagram for EST_TRwIterator< Container, IPointer, Entry >:
Collaboration diagram for EST_TRwIterator< Container, IPointer, Entry >:

Public Types

typedef EST_TRwIterator< Container, IPointer, Entry > Iter
 Can't access constant containers this way. More...
 
- Public Types inherited from EST_TIterator< Container, IPointer, Entry >
typedef EST_TIterator< Container, IPointer, Entry > Iter
 Name for an iterator like this. More...
 

Public Member Functions

 EST_TRwIterator ()
 Create an iterator not associated with any specific container. More...
 
Iteroperator= (const Iter &orig)
 Copy an iterator by assignment. More...
 
 EST_TRwIterator (Container &over)
 Create an iterator ready to run over the given container. More...
 
void begin (Container &over)
 Set the iterator ready to run over this container. More...
 
Access
Entry & current () const
 Return the element currently pointed to. More...
 
Entry & operator* () const
 The * operator returns the current element. More...
 
Entry & next_element ()
 Return the current element and move the pointer forwards. More...
 
- Public Member Functions inherited from EST_TIterator< Container, IPointer, Entry >
 EST_TIterator ()
 Create an iterator not associated with any specific container. More...
 
 EST_TIterator (const Container &over)
 Create an iterator ready to run over the given container. More...
 
Iteroperator= (const Iter &orig)
 Copy an iterator by assignment. More...
 
Iteroperator= (const Container &over)
 Assigning a container to an iterator sets it ready to start. More...
 
void begin (const Container &over)
 Set the iterator ready to run over this container. More...
 
void beginning ()
 Reset to the start of the container. More...
 
bool has_more_elements () const
 True if there are more elements to look at. More...
 
bool at_end () const
 True when there are no more. More...
 
 operator int () const
 
void next ()
 Next moves to the next entry. More...
 
Iteroperator++ ()
 The increment operator does the same as next. More...
 
Iter operator++ (int dummy)
 
const Entry & current () const
 Return the element currently pointed to. More...
 
const Entry & operator* () const
 The * operator returns the current element. More...
 
const Entry & next_element ()
 Return the current element and move the pointer forwards. More...
 
unsigned int n () const
 Return the current position. More...
 

Additional Inherited Members

- Protected Attributes inherited from EST_TIterator< Container, IPointer, Entry >
Container * cont
 The container we are looking at. More...
 
unsigned int pos
 Position in the structure. May or may not be useful. More...
 
IPointer pointer
 

Detailed Description

template<class Container, class IPointer, class Entry>
class EST_TRwIterator< Container, IPointer, Entry >

Definition at line 80 of file EST_TIterator.h.

Member Typedef Documentation

template<class Container, class IPointer, class Entry>
typedef EST_TRwIterator<Container, IPointer, Entry> EST_TRwIterator< Container, IPointer, Entry >::Iter

Can't access constant containers this way.

Can't access constant containers this way.

Definition at line 238 of file EST_TIterator.h.

Constructor & Destructor Documentation

template<class Container, class IPointer, class Entry>
EST_TRwIterator< Container, IPointer, Entry >::EST_TRwIterator ( )
inline

Create an iterator not associated with any specific container.

Definition at line 241 of file EST_TIterator.h.

template<class Container, class IPointer, class Entry>
EST_TRwIterator< Container, IPointer, Entry >::EST_TRwIterator ( Container &  over)
inline

Create an iterator ready to run over the given container.

Definition at line 248 of file EST_TIterator.h.

Member Function Documentation

template<class Container, class IPointer, class Entry>
Iter& EST_TRwIterator< Container, IPointer, Entry >::operator= ( const Iter orig)
inline

Copy an iterator by assignment.

Definition at line 244 of file EST_TIterator.h.

template<class Container, class IPointer, class Entry>
void EST_TRwIterator< Container, IPointer, Entry >::begin ( Container &  over)
inline

Set the iterator ready to run over this container.

Definition at line 252 of file EST_TIterator.h.

template<class Container, class IPointer, class Entry>
Entry& EST_TRwIterator< Container, IPointer, Entry >::current ( ) const
inline

Return the element currently pointed to.

Definition at line 259 of file EST_TIterator.h.

template<class Container, class IPointer, class Entry>
Entry& EST_TRwIterator< Container, IPointer, Entry >::operator* ( ) const
inline

The * operator returns the current element.

Definition at line 263 of file EST_TIterator.h.

template<class Container, class IPointer, class Entry>
Entry& EST_TRwIterator< Container, IPointer, Entry >::next_element ( )
inline

Return the current element and move the pointer forwards.

Definition at line 272 of file EST_TIterator.h.


The documentation for this class was generated from the following file: