GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism > Class Template Reference

#include <GLIteratorStorageStl.h>

Inheritance diagram for GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >:

GLBidirectionalIterator< TOrganism > GLIterator< TOrganism >

List of all members.

Public Member Functions

 GLIteratorStorageStl (TStlContainer &container)
virtual ~GLIteratorStorageStl ()
GLBidirectionalIterator
< TOrganism > & 
operator++ ()
GLBidirectionalIterator
< TOrganism > & 
operator-- ()
virtual TOrganism & getElement ()
virtual const TOrganism & getElement () const
virtual bool isBegin () const
virtual bool isEnd () const
virtual bool isNull () const


Detailed Description

template<class TStlContainer, class TStlIterator, class TOrganism>
class GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >

Templated class for iterator over the stl container of organisms.

Definition at line 12 of file GLIteratorStorageStl.h.


Constructor & Destructor Documentation

template<class TStlContainer , class TStlIterator , class TOrganism >
GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::GLIteratorStorageStl ( TStlContainer &  container  )  [inline]

Constructor -- gets the pointer on the issuing class.

Parameters:
container stl container with organisms.
Constructor -- gets the pointer on the issuing class.
Parameters:
issuer pointer to the class which issued iterator.

Definition at line 9 of file GLIteratorStorageStl.cpp.

template<class TStlContainer , class TStlIterator , class TOrganism >
virtual GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::~GLIteratorStorageStl (  )  [inline, virtual]

Simple destructor.

Definition at line 23 of file GLIteratorStorageStl.h.


Member Function Documentation

template<class TStlContainer , class TStlIterator , class TOrganism >
const TOrganism & GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::getElement (  )  const [inline, virtual]

Constant method to return the pointer to the element.

Returns:
pointer to the element to which iterators points.
Method to return the pointer to the element.
Returns:
pointer to the element to which iterators points.

Implements GLIterator< TOrganism >.

Definition at line 85 of file GLIteratorStorageStl.cpp.

template<class TStlContainer , class TStlIterator , class TOrganism >
TOrganism & GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::getElement (  )  [inline, virtual]

Method to return the pointer to the element.

Returns:
pointer to the element to which iterators points.

Implements GLIterator< TOrganism >.

Definition at line 61 of file GLIteratorStorageStl.cpp.

template<class TStlContainer , class TStlIterator , class TOrganism >
virtual bool GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::isBegin (  )  const [inline, virtual]

Returns true if iterator points to the first element in sequence.

Returns:
true if iterator points to the first element in sequence.

Implements GLIterator< TOrganism >.

Definition at line 55 of file GLIteratorStorageStl.h.

template<class TStlContainer , class TStlIterator , class TOrganism >
virtual bool GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::isEnd (  )  const [inline, virtual]

Returns true if iterator points beyond the last element in sequence. Always true for empty sequences. If isEnd() == true the status of the pointer is undefined.

Returns:
true if iterator points beyond the last element in sequence.

Implements GLIterator< TOrganism >.

Definition at line 64 of file GLIteratorStorageStl.h.

template<class TStlContainer , class TStlIterator , class TOrganism >
virtual bool GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::isNull (  )  const [inline, virtual]

Returns true if iterator points to NULL pointer and false otherwise.

Returns:
true if iterator points to NULL pointer and false otherwise.

Implements GLIterator< TOrganism >.

Definition at line 71 of file GLIteratorStorageStl.h.

template<class TStlContainer , class TStlIterator , class TOrganism >
GLBidirectionalIterator< TOrganism > & GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::operator++ (  )  [inline, virtual]

Operator for moving forward along the sequence. Implementation will depend on container.

Returns:
the pointer to itself.
Operator for moving forward along the sequence.
Returns:
the pointer to itself.

Implements GLIterator< TOrganism >.

Definition at line 21 of file GLIteratorStorageStl.cpp.

template<class TStlContainer , class TStlIterator , class TOrganism >
GLBidirectionalIterator< TOrganism > & GLIteratorStorageStl< TStlContainer, TStlIterator, TOrganism >::operator-- (  )  [inline, virtual]

Operator for moving backward along the sequence. Implementation will depend on container.

Returns:
the pointer to itself.
Operator for moving backward along the sequence.
Returns:
the pointer to itself.

Implements GLBidirectionalIterator< TOrganism >.

Definition at line 41 of file GLIteratorStorageStl.cpp.


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

Generated on Sat Jun 13 13:58:10 2009 for GenLib by  doxygen 1.5.9